Monitoring Google Cloud Storage

Setup

The Instana Google Cloud integration uses Service Accounts to create an API connection between Google Cloud and Instana. Below are instructions for creating the service account and providing Instana the service account credentials to begin making API calls on your behalf.

  1. Navigate to Google Cloud credentials page for the Google Cloud project you would like to setup the Instana integration.
  2. Press Create credentials and then select Service account key
    SelectServiceAccount
  3. In the Service account dropdown, select New service account
  4. Give the service account a unique name
  5. Choose a role or create a custom one which contains at least the following permissions:

    • monitoring.timeSeries.list
    • storage.buckets.list
  6. Select JSON as the key type, and press create
  7. Take note where this file is saved, as it is needed to complete the integration
  8. Add a field to configuration.yml credentials_path with path to credentials file. (Example in configuration section.)

In order to monitor project(s) the following services need to be enabled:

Configuration

You can configure the Google Cloud Storage metrics poll rate in seconds by adding the following configuration to the configuration file of the GCP Agent:

com.instana.plugin.gcp.storage:
  enabled: true
  poll_rate: 60 # How often Google's monitoring API will be polled in seconds
  credentials_path: '/opt/instana/credentials/cred-gcp.json' # Path to Service Account credentials
  include_tags: ''
  exclude_tags: ''

Filtering

Multiple tags can be defined, separated by a comma. Tags should be provided as a key-value pair separated by the : character. In order to make configuration easier, it is possible to define which tags you want to include in discovery or exclude from discovery. In case of defining tag in both lists (include and exclude), exclude list has higher priority. If there is no need for services filtering, the configuration should not be defined. It’s not mandatory to define all values in order to enable filtering.

To include services by tags into discovery use following configuration:

com.instana.plugin.gcp.storage:
  include_tags: # Comma separated list of tags in key:value format (e.g. env:prod,env:staging)

To exclude services by tags from discovery use following configuration:

com.instana.plugin.gcp.storage:
  exclude_tags: # Comma separated list of tags in key:value format (e.g. env:dev,env:test)

Metrics collection

Configuration data

  • Name
  • ID
  • Project Number
  • Region
  • Location Type
  • Storage Class
  • Creation Time
  • Last Update

Performance metrics

Metric Description Granularity
Requests Delta count of API calls. 60 seconds
Object writes Delta count of API write calls. 60 seconds
Objects read Delta count of API read calls. 60 seconds
Objects count Total number of objects per bucket. 300 seconds / Sampled once per day.
Objects size Total size of all objects in the bucket. 300 seconds / Sampled once per day.
Received bytes Delta count of bytes received over the network. 300 seconds
Sent bytes Delta count of bytes sent over the network.. 300 seconds

Health signatures

For each sensor, there is a curated knowledgebase of health signatures that are evaluated continuously against the incoming metrics and are used to raise issues or incidents depending on user impact.

Built-in events trigger issues or incidents based on failing health signatures on entities, and custom events trigger issues or incidents based on defined thresholds of any given entity's individual metrics.

For information about built-events for the Google Cloud Storage, see the Built-in events reference.