Google Stackdriver Integration Technical Reference

Overview

Google Stackdriver integration enables you to retrieve all metrics and metadata available in your Stackdriver setup and display them as dataviews in Geneos.

The integration provides a Gateway configuration file that enables monitoring of Stackdriver through a set of pre-configured Toolkit samplers. You can query and list the available metrics for your Google Cloud environment and running instances.

This technical reference provides information on the metrics and dataviews for the samplers available through the Stackdriver integration. If you are setting up the integration for the first time, see the Google Stackdriver Integration User Guide.

Audience

This technical reference is intended for Geneos users who are monitoring data from Stackdriver. If you are setting up the integration for the first time, see the Google Stackdriver Integration User Guide.

Environment variables

The gpsMonitoring.xml script provides the variables that are set in the Environments section. They are configured to ensure that the integration monitors your Stackdriver environment.

Variable Type Description
GOOGLE_APPLICATION_CREDENTIALS String

Path of the JSON file with your Google Cloud Platform service key.

GOOGLE_MANUAL Integer

Frequency of sampling. If checks are executed manually, the value is shown as 0.

Note: The default configuration of this integration is to perform manual sampling. This is because Google charges for each request that you make,.

GOOGLE_PROJECT_ID String

ID of the Google project you are connecting to.

GOOGLE_DRILL_METRIC String Key path of a specific metric used for creating dataviews of a single Stackdriver metric.
GOOGLE_DRILL_VIEW String A sub-string used to match a set of metric key paths. Used for creating dataviews of multiple metrics.
PYTHON_PATH String Path of the Python library located on the machine where the Netprobeis running.

Metrics and dataviews

Stackdriver integration enables you to display all the metrics and running instances that are available in your Google Cloud Platform environment. The dataviews are divided into three categories:

  • Configuration mode — dataview that displays all the available services and metrics along with their respective key paths. These key paths are used to configure the aggregated mode and detail views. This integration provides a default configuration mode dataview named StackDriver-Monitoring.
  • Aggregated mode — dataviews that display service level views. In this mode, instances are always displayed as rows and all available metrics are displayed as columns. Example configuration to show all compute engine instances and available metrics:
    key path = compute.googleapis.com
  • Detail view — dataviews that display individual metrics such as CPU utilization or disk read bytes. The configuration uses key paths specific to the individual metric. Example configuration to only show a detailed view of CPU utilization for each instance of the compute engine.
    key path = compute.googleapis.com/instance/cpu/utilization

The sections below list metrics and example dataviews available with the Stackdriver integration.

StackDriver-Monitoring

This is a configuration mode sampler that displays all available metrics with their key paths and descriptions. These key paths are then used to create dataviews that display details of the selected metrics.

Headline field Description
execDuration

Elapsed time for the Toolkit plug-in to run the script.

Unit: seconds

 

Column Name Description
Display Name Name of the available metric.
Description Description of the metric.
Key Path

Key path of the specific metric. The key path is used to drill down to more details of the selected metric.

StackDriver-GoogleComputeEngine

This sampler displays an aggregated view of all metrics and their values for each instance. To see details of the metrics you can create more aggregated views or detail views. Sections below present examples of such views.

StackDriver-CPU

This sampler displays an aggregated view of all CPU instances. To see the detailed metrics of each instance, use the detail views.

StackDriver-CPU-UsageTime

This sampler displays a detail view of the CPU instances providing metrics of the usage time.

StackDriver-CPU-Utilization

This sampler displays a detail view of the CPU instances providing metrics of the CPU utilization.

StackDriver-Disk

This sampler displays an aggregated view of all metrics available to monitor disks. To see the detailed values for each metric, use the detail views.

StackDriver-Disk-Read-Bytes

This sampler displays a detail view of the read_bytes_count metric for each instance and disk.

StackDriver-Firewall

This sampler displays an aggregated view of all metrics available for firewall. To see the detailed values for each metric, use the detail views.

StackDriver-Firewall-Dropped-Bytes

This sampler displays a detail view of the dropped_bytes_count metric for each instance.

StackDriver-Firewall-Dropped-Packets

This sampler displays a detail view of the dropped_packets_count metric for each instance.

Further reading

To learn more about setting up the Stackdriver monitoring samplers on a Gateway, see the Google Stackdriver Integration User Guide.