Apigee extension

  • Latest Dynatrace
  • Extension
  • Published Oct 27, 2025

Track Apigee proxy health via Analytics Metrics API with dashboards and alerts.

Get started

Overview

This extension provides the ability to remotely monitor Apigee through the Analytics Metrics API. The extension polls Apigee every minute to ingest data on how each proxy is performing.

Use cases

The extension enables insights into the overall health of Apigee and API proxies.

  • Monitor the health and performance of the Apigee proxies
  • Look for analysis support for Ops, IT and developers.
  • Monitor Apigee with a dedicated dashboard and Dynatrace entities to represent each proxy.
  • Detect anomalies and alert on them.

Compatibility information

  • Apigee Edge
  • Apigee Private Cloud
  • Apigee X (Google cloud platform)
  • Apigee Hybrid (Google cloud platform)

Activation and setup

Activate the extension in your environment using the in-product Hub, provide the necessary apigee proxy and authentication configuration. Follow the instructions and prompts within the extension settings.

Authentication

The extension requires an Apigee user with Apigee Analytics Viewer permissions.

Auth types supported:

  • Basic Auth (username / password)
  • Oauth2
  • SAML auth
  • Google GCP Service Account JSON file

Google Cloud - Apigee X or Apigee Hybrid

Google Apigee requires Google OAuth2 authentication through a GCP service account.

  1. Create a Google Cloud Service Account (e.g., Dynatrace-apigee-extension)
  2. Provide the role Apigee Analytics Viewer
  3. Select this new service account, then select the KEYS tab, create and download a JSON private key file: project-id-key.json
  4. Add the JSON file key to the Dynatrace ActiveGate or ActiveGates that the extension will run on.
    • The file must be stored in location accessible to the Dynatrace ActiveGate user (dtuserag on Linux and Local Service account on Windows.
    • The location is deifned as the Service account file in the extension configuration

Details

The extension uses the Analytics Metrics API to collect important proxy performance metrics.

Users can specify the metric dimensions to target within the extension configuration. Most Apigee dimensions are supported and available, but each endpoint is limited to 5 different dimensions to prevent excessive metric splitting. It is recommended to always include the ‘proxy’ (apiproxy) dimension, as this is what is used to model the Dynatrace entity for an Apigee API Proxy.

For the full list of Apigee Dimensions refer to Apigee Dimensions.

Polled proxies are limited to 1000 per endpoint. If you have more than this, you can specific individual proxy names to monitor and/or set the sorting order for which 1000 proxies to return. Wildcards are supported in the list of named proxies.

Proxy sort by options:

  • slowest_response_time
  • highest_message_count
  • highest_proxy_errors
  • highest_throughput
  • highest_latency

Feature sets

When activating your extension using monitoring configuration, you can limit monitoring to one of the feature sets. To work properly the extension has to collect at least one metric after the activation.

In highly segmented networks, feature sets can reflect the segments of your environment. Then, when you create a monitoring configuration, you can select a feature set and a corresponding ActiveGate group that can connect to this particular segment.

All metrics that aren't categorized into any feature set are considered to be the default and are always reported.

A metric inherits the feature set of a subgroup, which in turn inherits the feature set of a group. Also, the feature set defined on the metric level overrides the feature set defined on the subgroup level, which in turn overrides the feature set defined on the group level.

apigee
Metric nameMetric keyDescription
Apigee API Connectivityapigee.api.connectivityWas Dynatrace able to poll the Apigee API without errors?
Apigee Average Transactions per Secondapigee.throughputThe average number of transactions, meaning API proxy requests, per second.
Apigee Cache Hitsapigee.cache_hitsThe number of successful API requests that use the Response Cache instead of the response from the target service.
Apigee Traffic (message count)apigee.trafficThe total number of API calls processed by Edge in the specified time period.
Apigee Proxy Errorsapigee.errorsThe total number of times API proxies failed over the specified time period.
Apigee Target Errorsapigee.target_errorsThe total number of 5xx responses from the target service. These are target service errors not caused by Apigee.
Apigee Total Response Timeapigee.total_response_timeThe amount of time in milliseconds, from when Edge receives a request from a client to when Edge sends the response back to the client.
Apigee Request Sizeapigee.request_sizeThe size of the request payload received by Edge, in bytes.
Apigee Response Sizeapigee.response_sizeThe size of the response payload returned to the client, in bytes.
Apigee Target Response Timeapigee.target_response_timeThe amount of time in milliseconds, for the target server to respond to a call.
Apigee Response Processing Latencyapigee.response_latencyThe amount of time in milliseconds, that it takes Edge to process API responses
Apigee Request Processing Latencyapigee.request_latencyThe amount of time in milliseconds, that it takes Edge to process incoming requests.
Related tags
ApplicationPythonAPI managerGoogleApplication Observability