Configure metrics collection

This section describes configuration properties for sending Apigee hybrid metrics data to Cloud Operations. Metrics collection is enabled by default. See also Metrics collection overview.

In some cases, you may wish to use your own metrics collection system, such as Prometheus or Grafana, in parallel with or instead of the default Cloud Operations system provided by Apigee. For details on using your own metrics collection system, see the article Bring your own Prometheus (and Grafana) to monitor Apigee hybrid in the Apigee Community.

Required configuration

The following overrides file settings configure metrics collection:

gcp:
  region: $GCP_REGION
  projectID: $GCP_PROJECT_ID

metrics:
  serviceAccountPath: $SERVICE_ACCOUNT_PATH

Where:

$GCP_REGION identifies the Google Cloud region where the apigee-logger and the apigee-metrics push their data.
$GCP_PROJECT_ID identifies the Google Cloud project where apigee-logger and the apigee-metrics push their data.
$SERVICE_ACCOUNT_PATH is the path on your filesystem to the Google Cloud service account key file that was downloaded during the Apigee hybrid installation procedure. The service account associated with the key must have the Monitoring Metrics Writer role. For details on creating service accounts, see About service accounts: Create the service accounts.

Example:

gcp:
  region: us-central1
  projectID: acme-project

metrics:
  serviceAccountPath: ./service-accounts/metrics-sa.json

How to disable metrics collection

To disable metrics collection, add the following configuration to your overrides and apply it to the cluster:

metrics:
  enabled: false