NOTE: Some aspects of this product are in Beta. The hybrid installation options are GA. To join the Beta program, reach out to your Apigee representative.

Configure metrics collection

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
k8sClusterName: cluster_name
...
metrics:
  enabled: true
  serviceAccountPath: service_account_file

Where:

  • gcpProjectID is a GCP project ID. Metrics data will be sent to the Stackdriver instance in that project.
  • k8sClusterName is the name of the Kubernetes cluster where the hybrid runtime is installed.
  • 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
k8sClusterName: acme-hybrid
...
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:

...
metrics:
  enabled: false
...