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 metrics collection system provided by Apigee. For details on using your
own metrics collection system, see the articleBring your own Prometheus (and Grafana) to monitor Apigee hybridin the Apigee Community.
Required configuration
The following overrides file settings configure metrics collection:
$GCP_REGIONidentifies the Google Cloudregionwhere theapigee-loggerand theapigee-metricspush their data.
$GCP_PROJECT_IDidentifies the Google Cloud
project whereapigee-loggerand theapigee-metricspush
their data.
$SERVICE_ACCOUNT_PATHis the path on your filesystem to the Google Cloud service account
key file that was downloaded during the Apigee hybridinstallation procedure.
The service account associated with the key must have theMonitoring Metrics Writerrole. For details on creating service accounts, seeAbout service accounts: Create the 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-09-04 UTC."],[[["\u003cp\u003eThis document provides configuration details for sending Apigee hybrid metrics to Cloud Operations for GKE, which is enabled by default.\u003c/p\u003e\n"],["\u003cp\u003eYou can use alternative metrics collection systems like Prometheus or Grafana instead of or in addition to the default setup.\u003c/p\u003e\n"],["\u003cp\u003eConfiguring metrics collection requires specifying the Google Cloud region, project ID, and service account path in the overrides file.\u003c/p\u003e\n"],["\u003cp\u003eThe specified service account must have the Monitoring Metrics Writer role.\u003c/p\u003e\n"],["\u003cp\u003eMetrics collection can be disabled by setting \u003ccode\u003emetrics: enabled: false\u003c/code\u003e in your overrides file.\u003c/p\u003e\n"]]],[],null,["# Configure metrics collection\n\n| You are currently viewing version 1.9 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 for GKE](https://cloud.google.com/monitoring/kubernetes-engine/).\nMetrics collection is enabled by default. See also [Metrics collection overview](./metrics-collection).\n\nIn some cases, you may wish to use your own metrics collection system, such as\nPrometheus or Grafana, in parallel with or\ninstead of the default metrics collection system provided by Apigee. For details on using your\nown metrics collection system, see the article [Bring your own Prometheus (and Grafana) to monitor Apigee hybrid](https://www.googlecloudcommunity.com/gc/Cloud-Product-Articles/BYOP-Bring-your-own-Prometheus-and-Grafana-to-monitor-Apigee/ta-p/499772)\nin the Apigee Community.\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 Google Cloud [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 Google Cloud service account key file that was downloaded during the Apigee hybrid [installation procedure](/apigee/docs/hybrid/v1.9/precog-overview). 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](/apigee/docs/hybrid/v1.9/sa-about#create-the-service-accounts).\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"]]
