Monitoring Google Cloud Datastore

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. Click CREATE CREDENTIALS > Service account.

SelectServiceAccount

  1. On the Create service account page, enter a unique name for the service account, and click CREATE AND CONTINUE.

  2. Select a role or create a custom one which contains at least the following permissions:

    • monitoring.timeSeries.list

    • resourcemanager.projects.get

      To create a custom role, complete the following steps:

      1. From the navigation menu, click Roles > CREATE ROLE.
      2. Enter the title of the role, and click ADD PERMISSIONS.
      3. Add the basic permissions that are mentioned previously, which are required for the role, and click CREATE.

  3. Select the account you created from the list of service accounts.

  4. Select the KEYS tab, and click ADD KEY.

  5. Select Create new key and select the key type as JSON, and then click CREATE.

serviceaccountkey

You need to record the location of the credential file where it is saved to complete the integration.

  1. Add a field credentials_path to the configuration.yml file with the path to the credentials file. For example, see configuration.

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

Configuration

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

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

Google Cloud Datastore - Metrics collection

Configuration data

  • Project Name
  • Project ID
  • Project Number
  • Creation Time

Performance metrics

Metric Description Reducer/Aligner
Requests Count Count of Datastore API calls. REDUCE_SUM/ALIGN_DELTA
Entity Read Size Average Distribution of sizes of read entities, average value. REDUCE_MEAN/ALIGN_DELTA
Entity Write Size Average Distribution of sizes of written entities, average value. REDUCE_MEAN/ALIGN_DELTA
Index Write Count Count of Datastore index writes. REDUCE_SUM/ALIGN_DELTA

Granularity for all metrics is 60 seconds.

Health signatures

For each sensor, there is a curated knowledge base 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 Datastore, see the Built-in events reference.