Apigee hybrid metrics collection is disabled by default; you must provide
a few configuration properties in your overrides file to enable hybrid
to send the collected metrics data to
Stackdriver.
Required configuration
To enable Apigee hybrid to send collected metrics data to Stackdriver,
you must provide these configuration settings in your overrides
file:
...
# gcpProjectID: project_ID # Deprecated.
gcp: # v1.2.0 and later: Use this element instead of gcpProjectID.
region: gcp-region
projectID: gcp-project-id
metrics:
enabled: true
serviceAccountPath: service_account_file
Where:
gcpProjectID identifies the Google Cloud project where apigee-logger and the apigee-metrics push
their data.
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.
serviceAccountPath 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.
Example:
...
# gcpProjectID: acme-hybrid # Deprecated
gcp: # v1.2.0 and later: Use this element instead of gcpProjectID.
region: us-central1
projectID: acme-project
metrics:
enabled: true
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:
[[["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-20 UTC."],[[["\u003cp\u003eVersion 1.2 of the Apigee hybrid documentation is end of life, and users should upgrade to a newer version.\u003c/p\u003e\n"],["\u003cp\u003eApigee hybrid metrics collection is disabled by default and requires specific configuration properties in the overrides file to enable sending data to Stackdriver.\u003c/p\u003e\n"],["\u003cp\u003eEnabling metrics requires setting \u003ccode\u003emetrics: enabled\u003c/code\u003e to \u003ccode\u003etrue\u003c/code\u003e and providing the correct \u003ccode\u003egcp: region\u003c/code\u003e, \u003ccode\u003egcp: projectID\u003c/code\u003e, and \u003ccode\u003eserviceAccountPath\u003c/code\u003e within the overrides file.\u003c/p\u003e\n"],["\u003cp\u003eTo disable metrics collection, you must set \u003ccode\u003emetrics: enabled\u003c/code\u003e to \u003ccode\u003efalse\u003c/code\u003e in your overrides file and apply the change to your cluster.\u003c/p\u003e\n"]]],[],null,[]]
