<%NUMBERING1%>.<%NUMBERING2%>.<%NUMBERING3%> PRTG Manual: Google Analytics Sensor
The Google Analytics sensor queries and monitors several metrics from a Google Analytics account using the Google application programming interface (API) and Open Authorization 2 (OAuth2).
The sensor can show the following:
- Values for all available Google Analytics metrics in different channels
Google Analytics Sensor
Remarks
Add Sensor
The Add Sensor dialog appears when you manually add a new sensor to a device. It only shows the setting fields that are required for creating the sensor. Therefore, you do not see all setting fields in this dialog. You can change (nearly) all settings in the sensor's Settings tab later.
PRTG requires OAuth2 authorization before you can actually add this sensor. Provide the requested credentials in the appearing window.
The following settings in the Add Sensor dialog differ in comparison to the sensor's Settings tab.
|
This sensor uses OAuth2 authentication to get access to your Google account.
For details about this authentication approach, see section Authentication Using OAuth2.
|
OAuth URL
|
Click the Get Access Code button to connect this sensor to your Google Analytics account using OAuth2. This is necessary to allow the sensor to query data from Google Analytics. A new browser window appears.
Follow the steps in the window and confirm the permission for PRTG to connect to your Google Analytics account. Copy the OAuth code you get and paste it into the OAuth Code field below.
|
OAuth Code
|
Paste the access code that you receive after completing the authorization process for PRTG at your Google Analytics account. Click OK to define the sensor settings.
It is mandatory to connect this sensor to your Google Analytics account to create this sensor. Complete the OAuth approach first to get the OAuth code.
|
|
Profile
|
Select the Google Analytics profile that you want to monitor. Once you have created the sensor, you cannot change this value. It is shown for reference purposes only. If you need to change this value, add the sensor anew.
|
Sensor Channel #2 – #10
|
You can create up to 10 different channels for this sensor. You have to define at least one data channel, so you see all available settings for Sensor Channel #1 without manually enabling them. Additionally, you can define Sensor Channel #2 up to Sensor Channel #10. To do so, choose between:
- Disable: The sensor does not create this channel.
- Enable: Create an additional channel
Once you have created the sensor, you cannot change this value. It is shown for reference purposes only. If you need to change this value, add the sensor anew.
It is not possible to enable or disable channels after sensor creation.
|
Channel #x Mode
|
Define how to display the retrieved value in the channel:
- Absolute (recommended): Shows the value as the sensor retrieves it from Google Analytics.
- Difference: The sensor calculates and shows the difference between the last and the most recent value returned from Google Analytics. This mode is not compatible with the unit Value Lookup.
Once you have created the sensor, you cannot change this value. It is shown for reference purposes only. If you need to change this value, add the sensor anew.
|
Sensor Settings
Click the Settings tab of a sensor to change its settings.
Usually, a sensor connects to the IP Address or DNS Name of the parent device on which you created the sensor. See the device settings for details. For some sensors, you can explicitly define the monitoring target in the sensor settings. See below for details on available settings.
|
Sensor Name
|
Enter a meaningful name to identify the sensor. By default, PRTG shows this name in the device tree, as well as in alarms, logs, notifications, reports, maps, libraries, and tickets.
|
Parent Tags
|
Shows tags that this sensor inherits from its parent device, group, and probe. This setting is shown for your information only and cannot be changed here.
|
Tags
|
Enter one or more tags, separated by spaces or commas. You can use tags to group sensors and use tag–filtered views later on. Tags are not case sensitive. We recommend that you use the default value.
There are default tags that are automatically predefined in a sensor's settings when you add a sensor. See section Default Tags below.
You can add additional tags to the sensor if you like. Other tags are automatically inherited from objects further up in the device tree. These are visible above as Parent Tags.
It is not possible to enter tags with a leading plus (+) or minus (-) sign, nor tags with parentheses (()) or angle brackets (<>).
|
Priority
|
Select a priority for the sensor. This setting determines where the sensor is placed in sensor lists. A sensor with a top priority is at the top of a list. Choose from one star (low priority) to five stars (top priority).
|
Default Tags
googleanalytics
|
OAuth Code
|
Shows the authorization code that the sensor uses to get access to your Google Analytics account. Once you have created the sensor, you cannot change this value. It is shown for reference purposes only. If you need to change this value, add the sensor anew.
|
|
Profile
|
Shows the Google Analytics profile that this sensor monitors. Once you have created the sensor, you cannot change this value. It is shown for reference purposes only. If you need to change this value, add the sensor anew.
|
Time Span
|
Define the time that the queried monitoring covers:
- Last week (default)
- Yesterday
- Today
|
Sensor Channel #x Name
|
Enter a name for the channel in which the sensor shows the results for the metric you choose below. Enter a string.
|
Sensor Channel #x Metric
|
Select a metric that you want to monitor. You can choose between available Google Analytics metrics. If your desired metric is not listed, select Custom Metric and specify below.
|
Sensor Channel #x Custom Metric
|
This field is only visible if you select Custom Metric above. Enter the identifier of the metric that you want to monitor. Type it exactly as shown in Google Analytics. Metric identifiers always start with ga:. Enter a string.
|
Sensor Channel #x Mode
|
Shows how the sensor displays the retrieved value in the channel. Once you have created the sensor, you cannot change this value. It is shown for reference purposes only. If you need to change this value, add the sensor anew.
|
Sensor Channel #x Unit
|
Define the unit of the channel value:
- BytesBandwidth
- BytesMemory
- BytesDisk
- Temperature
- Percent
- TimeResponse
- TimeSeconds
- TimeHours
- Count
- CPU
- BytesFile
- SpeedDisk
- SpeedNet
- Custom
- Value Lookup
Once you have created the sensor, you cannot change this value. It is shown for reference purposes only. If you need to change this value, add the sensor anew.
For more information about the available units, see section Custom Sensors.
To use lookups with this channel, select Value Lookup and define the lookup file in Sensor Channel #x Value Lookup. Do not use the unit Custom for using lookups with this sensor and do not use the channel settings to define a lookup file.
Using the unit Value Lookup is not possible when you choose the Difference mode. You are not able to create the sensor in this case.
|
Sensor Channel #x Custom Unit
|
This setting is only visible if you select the Custom unit option above. Define a unit for the channel value. Enter a string.
|
Sensor Channel #x Value Lookup
|
This setting is only visible if you select the Value Lookup option above. Choose a lookup file that you want to use with this channel.
|
Sensor Channel #x
|
Shows if you enabled or disabled a channel. Once you have created the sensor, you cannot change this value. It is shown for reference purposes only. If you need to change this value, add the sensor anew.
You can define up to 10 different sensor channels per sensor.
|
|
Primary Channel
|
Select a channel from the list to define it as the primary channel. In the device tree, the last value of the primary channel is always displayed below the sensor's name. The available options depend on what channels are available for this sensor.
You can set a different primary channel later by clicking the pin symbol of a channel on the sensor's Overview tab.
|
Graph Type
|
Define how different channels are shown for this sensor:
- Show channels independently (default): Show a graph for each channel.
- Stack channels on top of each other: Stack channels on top of each other to create a multi-channel graph. This generates a graph that visualizes the different components of your total traffic.
This option cannot be used in combination with manual Vertical Axis Scaling (available in the channel settings).
|
Stack Unit
|
This field is only visible if you enable Stack channels on top of each other as Graph Type. Select a unit from the list. All channels with this unit are stacked on top of each other. By default, you cannot exclude single channels from stacking if they use the selected unit. However, there is an advanced procedure to do so.
|
Inherited Settings
By default, all of the following settings are inherited from objects that are higher in the hierarchy and should be changed there if necessary. Often, best practice is to change them centrally in the root group settings. For more information, see section Inheritance of Settings. To change a setting for this object only, disable inheritance by clicking the button next to inherit from under the corresponding setting name. You then see the options described below.
|
Click to interrupt the inheritance. See section Inheritance of Settings for more information.
|
Scanning Interval
|
Select a scanning interval (seconds, minutes, or hours). The scanning interval determines the amount of time that the sensor waits between two scans. You can change the available intervals in the system administration on PRTG on premises installations.
|
If a Sensor Query Fails
|
Define the number of scanning intervals that the sensor has time to reach and check a device again in case a sensor query fails. Depending on the option that you select, the sensor can try to reach and check a device again several times before the sensor shows a Down status. This can avoid false alarms if the monitored device only has temporary issues. For previous scanning intervals with failed requests, the sensor shows a Warning status. Choose from:
- Set sensor to down immediately: Set the sensor to a Down status immediately after the first failed request.
- Set sensor to warning for 1 interval, then set to down (recommended): Set the sensor to a Warning status after the first failed request. If the following request also fails, the sensor shows an error.
- Set sensor to warning for 2 intervals, then set to down: Set the sensor to a Down status only after three consecutively failed requests.
- Set sensor to warning for 3 intervals, then set to down: Set the sensor to a Down status only after four consecutively failed requests.
- Set sensor to warning for 4 intervals, then set to down: Set the sensor to a Down status only after five consecutively failed requests.
- Set sensor to warning for 5 intervals, then set to down: Set the sensor to a Down status only after six consecutively failed requests.
Sensors that monitor via Windows Management Instrumentation (WMI) always wait at least one scanning interval before they show a Down status. It is not possible to immediately set a WMI sensor to a Down status, so the first option does not apply to these sensors. All other options can apply.
If you define error limits for a sensor's channels, the sensor immediately shows a Down status. No "wait" option applies.
If a channel uses lookup values, the sensor immediately shows a Down status. No "wait" options apply.
|
This sensor has a fixed minimum scanning interval for performance reasons. You cannot run the sensor in shorter intervals than this minimum interval. Consequently, shorter scanning intervals as defined in System Administration—Monitoring are not available for this sensor.
|
You cannot interrupt the inheritance for schedules, dependencies, and maintenance windows. The corresponding settings from the parent objects are always active. However, you can define additional settings here. They are active at the same time as the parent objects' settings.
|
Schedule
|
Select a schedule from the list. Schedules can be used to monitor for a certain time span (days or hours) every week.
You can create schedules, edit schedules, or pause monitoring for a specific time span. For more information, see section Account Settings—Schedules.
Schedules are generally inherited. New schedules are added to schedules that you already set up, so all schedules are active at the same time.
|
Maintenance Window
|
Specify if you want to set up a one-time maintenance window. During a maintenance window, the selected object and all child objects are not monitored. They are in a Paused status instead. Choose between:
- Not set (monitor continuously): No maintenance window is set and monitoring is always active.
- Set up a one-time maintenance window: Pause monitoring within a maintenance window. You can define a time span for a monitoring pause below and change it even for an active maintenance window.
To terminate an active maintenance window before the defined end date, change the time entry in Maintenance Ends to a date in the past.
|
Maintenance Begins
|
This field is only visible if you enable Set up a one-time maintenance window above. Use the date time picker to enter the start date and time of the maintenance window.
|
Maintenance Ends
|
This field is only visible if you enable Set up a one-time maintenance window above. Use the date time picker to enter the end date and time of the maintenance window.
|
Dependency Type
|
Define a dependency type. You can use dependencies to pause monitoring for an object depending on the status of a different object. You can choose from:
- Use parent: Use the dependency type of the parent object.
- Select a sensor: Use the dependency type of the parent object. Additionally, pause the current object if a specific sensor is in a Down status or in a Paused status caused by another dependency.
- Master sensor for parent: Make this sensor the master object for its parent device. The sensor influences the behavior of its parent device: If the sensor is in a Down status, the device is paused. For example, it is a good idea to make a Ping sensor the master object for its parent device to pause monitoring for all other sensors on the device in case the device cannot even be pinged. Additionally, the sensor is paused if the parent group is paused by another dependency.
To test your dependencies, select Simulate Error Status from the context menu of an object that other objects depend on. A few seconds later, all dependent objects are paused. You can check all dependencies under Devices | Dependencies in the main menu bar.
|
Dependency
|
This field is only visible if you enable Select a sensor above. Click the Search button and use the object selector to select a sensor on which the current object will depend.
|
Dependency Delay (Sec.)
|
This field is only visible if you enable Select a sensor above. Define a time span in seconds for dependency delay.
After the master sensor for this dependency comes back to an Up status, monitoring of the dependent objects is additionally delayed by the defined time span. This can prevent false alarms, for example, after a server restart, by giving systems more time for all services to start up. Enter an integer value.
This setting is not available if you set this sensor to Use parent or to be the Master sensor for parent. In this case, define delays in the parent device settings or in its parent group settings.
|
|
Click to interrupt the inheritance. See section Inheritance of Settings for more information.
|
User Group Access
|
Define the user groups that have access to the sensor. You see a table with user groups and group access rights. The table contains all user groups in your setup. For each user group, you can choose from the following group access rights:
- Inherited: Inherit the access rights settings of the parent object.
- No access: Users in this user group cannot see or edit the sensor. The sensor neither shows up in lists nor in the device tree.
- Read access: Users in this group can see the sensor and view its monitoring results. They cannot edit any settings.
- Write access: Users in this group can see the sensor, view its monitoring results, and edit its settings. They cannot edit its access rights settings.
- Full access: Users in this group can see the sensor, view its monitoring results, edit its settings, and edit its access rights settings.
For more details on access rights, see section Access Rights Management.
|
|
Click to interrupt the inheritance. See section Inheritance of Settings for more information.
|
Channel Unit Types
|
For each type of channel, define the unit in which data is displayed. If defined on probe, group, or device level, these settings can be inherited to all sensors underneath. You can set units for the following channel types (if available):
- Bandwidth
- Memory
- Disk
- File
- Custom
Custom channel types can be set on sensor level only.
|
Authentication Using OAuth2
This sensor uses the OAuth2 security protocol to access the account from which you want to retrieve and monitor data. OAuth2 enables you to grant access to the target account without sharing your password with PRTG. The authorization approach of PRTG using OAuth2 works as follows.
- Authorization Request
First, you have to request authorization for this sensor to access service resources from your account. For this purpose, you are asked to get an access code for this sensor in the Add Sensor dialog. Click the Get Access Code button to start the authorization process using OAuth2. A new browser window opens on the authorization server of the target service.
- Verifying Identity
This new window contains a login form for your account that you want to monitor. Log in to your account using your credentials for this service to authenticate your identity. This is a common login to your account on the target server so PRTG does not see your password. The service forwards you to the authorization page and asks you to permit PRTG to access the data in your account.
If you are already logged in to the service with a user account,
you do not have to enter credentials in this step and get directly to the access permission page.
- Authorizing PRTG
Permit PRTG to access information on your account. Note that this permission holds only for this specific sensor, not for other sensors of this type or PRTG as a whole. For each sensor of this type you add, you have to confirm the access permission anew. You can change the account permissions at any time in your account at the target service.
- Getting Authorization Code
Permitting PRTG to access your account data forwards you to a page where the service provides an authorization code. Copy this code and switch back to the Add Sensor dialog in PRTG.
The code is only valid for a short period of time and expires after a few minutes.
You can use a particular code only once.
- Providing Authorization Code
Paste the authorization code into the OAuth Code field and complete the Add Sensor dialog. You do not have to go through further configuration steps manually. The sensor automatically accomplishes the following steps.
- Requesting Access Token
After receiving the authorization code, PRTG requests an access token from the API of the target service. For this purpose, PRTG transmits the authorization code together with several authentication details. The API checks if the authorization is valid and returns the access token to PRTG. Access tokens are specific for one account and one application (here: PRTG). The authorization process to read data from your account is now complete.
- Retrieving Data
The sensor transmits the access token with each sensor scan in the defined scanning interval to authenticate with your account. It is not necessary to use the original account credentials anew. The used tokens refresh automatically from time to time.
More
KNOWLEDGE BASE
Where do I find available Google Analytics metrics?
Edit Channels
To change display settings, spike filtering, and limits, switch to the sensor's Overview tab and click the gear icon of a specific channel. For detailed information, see section Sensor Channel Settings.
Notification Triggers
Click the Notification Triggers tab to change notification triggers. For detailed information, see section Sensor Notification Triggers Settings.
Others
For more general information about settings, see section Object Settings.
Sensor Settings Overview
For information about sensor settings, see the following sections: