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.
Required configuration
The following overrides file settings configure metrics collection:
$GCP_REGION identifies the GCP 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 GCP 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 Step 5: Add service
accounts.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-29 UTC."],[[["\u003cp\u003eThe current documentation version (1.6) for Apigee hybrid is end of life and users should upgrade to a newer version.\u003c/p\u003e\n"],["\u003cp\u003eThis documentation section details configuration properties for sending Apigee hybrid metrics to Cloud Operations, which is enabled by default.\u003c/p\u003e\n"],["\u003cp\u003eConfiguring metrics collection requires specifying the GCP region, project ID, and the service account key file path in the overrides file.\u003c/p\u003e\n"],["\u003cp\u003eMetrics collection can be disabled by setting \u003ccode\u003emetrics: enabled\u003c/code\u003e to \u003ccode\u003efalse\u003c/code\u003e in the overrides file and applying it to the cluster.\u003c/p\u003e\n"]]],[],null,["# Configure metrics collection\n\n| You are currently viewing version 1.6 of the Apigee hybrid documentation. **This version is end of life.** You should upgrade to a newer version. For more information, see [Supported versions](/apigee/docs/hybrid/supported-platforms#supported-versions).\n\n\nThis section describes configuration properties for sending Apigee hybrid metrics data to\n[Cloud Operations](https://cloud.google.com/monitoring/kubernetes-engine/).\nMetrics collection is enabled by default. See also [Metrics collection overview](./metrics-collection).\n\nRequired configuration\n----------------------\n\nThe following overrides file settings configure metrics collection: \n\n```actionscript-3\ngcp:\n region: $GCP_REGION\n projectID: $GCP_PROJECT_ID\n\nmetrics:\n serviceAccountPath: $SERVICE_ACCOUNT_PATH\n```\n\n\nWhere:\n\n- `$GCP_REGION` identifies the GCP [region](https://cloud.google.com/compute/docs/regions-zones#available) where the `apigee-logger` and the `apigee-metrics` push their data.\n- `$GCP_PROJECT_ID` identifies the project where `apigee-logger` and the `apigee-metrics` push their data.\n- `$SERVICE_ACCOUNT_PATH` is the path on your filesystem to the GCP service account key file that was downloaded during the Apigee hybrid [installation procedure](/apigee/docs/hybrid/v1.6/precog-overview). The service account associated with the key must have the **Monitoring Metrics Writer** role. For details on creating service accounts, see [Step 5: Add service\n accounts](/apigee/docs/hybrid/v1.6/precog-serviceaccounts).\n\n\nExample: \n\n```actionscript-3\ngcp:\n region: us-central1\n projectID: acme-project\n\nmetrics:\n serviceAccountPath: ./service-accounts/metrics-sa.json\n```\n\nHow to disable metrics collection\n---------------------------------\n\nTo disable metrics collection, add the following configuration to your overrides and apply it\nto the cluster:\n\n```actionscript-3\nmetrics:\n enabled: false\n```\n\n*[Google Cloud]: Google Cloud"]]
