Setup

Google Analytics

The Google Analytics adminstrator should complete the following steps to generate a private key for use by the add-on:

Follow Steps 1 and 2 from the API Quick Start
Provide the credentials.json file to the Splunk Admin
Also provide the Property ID of the site being monitored by Google Analytics - this is a 9 digit number, visible from the Admin section (gear icon bottom left) and then Property > Property Details

Note that instead of using the quick start method above you can manually create an OAuth client ID and then assign the permissions as per step 2 in the Quick Start. This provides more control but involves more steps.

Splunk Add-on Installation

To install the add-on, on the Splunk server that will host the add-on:
1. Create a directory $SPLUNK_HOME/etc/apps/idelta_addon_for_google_analytics
2. Copy (recursively) the contents of the package directory in this repository into that directory
3. Place the credentials.json file, supplied by the Google Analytics administrator, into the following location (note that name change on the file): $SPLUNK_HOME/etc/apps/idelta_addon_for_splunk/bin/google_analytics_credentials.json
4. Ensure the above file has appropriate ownership and permissions set (e.g. chown splunk.splunk, chmod 400)
5. Restart the Splunk server (or reload, requires testing)

Note that this add-on has been built using the ucc framework, and the repository contents are orientated towards development - that is the reason that the add-on currently sits under a "package" directory.

Splunk Add-on Configuration

To configure the add-on:
1. Optional: setup a new Splunk index for your data
2. In the add-on:
- Click on Configuration > Accounts then click Add
- Enter a name for the account (e.g. which website is it for)
- Enter the Google Analytics Property ID
3. Select the Inputs tab:
- Click Create New Input
- Enter a name for the input (e.g. activeUsers_myWebSite)
- Enter the Metric Names required (e.g. activeUsers)
- Enter the Dimension Names (e.g. city, country, browser)
- Enter a start date (e.g. yesterday)
- Enter an end date (e.g. today)
- Enter an interval in seconds (e.g. 86400)
- Select the Account to Use (as setup in step 2 above)

Note that metric name, dimensions, start date and end date should use the same terms as specified in the Google API documentation, see startDate and endDate definitions

iDelta Add-on for Google Analytics GA4

0