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)
Apigee Hybrid (Google Cloud)
Activation and setup
Activate the extension in your environment using the in-product Hub and 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.
Select this new service account, then select the KEYS tab, create and download a JSON private key file: project-id-key.json
Add the JSON file key to the Dynatrace ActiveGate or ActiveGates that the extension will run on.
The file must be stored in a location accessible to the Dynatrace ActiveGate user (dtuserag on Linux and Local Service account on Windows.
The location is defined as the Service account file in the extension configuration.
Instead of uploading the file, you can specify the path to the JSON credential fields directly 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; however, each endpoint is limited to five 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.
Polled proxies are limited to 1000 per endpoint. If you have more than this, you can specify 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.
maxL1CacheElements
Metric name
Metric key
Description
Apigee L1 Cache Elements Max
apigee.l1_cache_elements_max
The maximum number of elements in the L1 cache.
responseSize
Metric name
Metric key
Description
Apigee Response Size
apigee.response_size
The average size of the response payload returned to the client, in bytes.
requestSize
Metric name
Metric key
Description
Apigee Request Size
apigee.request_size
The average size of the request payload received by Edge, in bytes.
policyError
Metric name
Metric key
Description
Apigee Policy Errors
apigee.policy_errors
The total number of policy errors encountered.
throughput
Metric name
Metric key
Description
Apigee Average Transactions per Second
apigee.throughput
The average number of transactions, meaning API proxy requests, per second.
cacheHit
Metric name
Metric key
Description
Apigee Cache Hits
apigee.cache_hits
The number of successful API requests that use the Response Cache instead of the response from the target service.
default
Metric name
Metric key
Description
Apigee API Connectivity
apigee.api.connectivity
Was Dynatrace able to poll the Apigee API without errors?
maxTotalResponseTime
Metric name
Metric key
Description
Apigee Max Total Response Time
apigee.total_response_time_max
The maximum amount of time in milliseconds, from when Edge receives a request from a client to when Edge sends the response back to the client.
totalResponseTime
Metric name
Metric key
Description
Apigee Total Response Time
apigee.total_response_time
The amount of time in milliseconds, from when Edge receives a request from a client to when Edge sends the response back to the client.
proxyError
Metric name
Metric key
Description
Apigee Proxy Errors
apigee.errors
The total number of times API proxies failed over the specified time period.
maxResponseSize
Metric name
Metric key
Description
Apigee Max Response Size
apigee.response_size_max
The maximum size of the response payload returned to the client, in bytes.
maxRequestSize
Metric name
Metric key
Description
Apigee Max Request Size
apigee.request_size_max
The maximum size of the request payload received by Edge, in bytes.
responseLatency
Metric name
Metric key
Description
Apigee Response Processing Latency
apigee.response_latency
The average amount of time in milliseconds, that it takes Edge to process API responses
maxResponseLatency
Metric name
Metric key
Description
Apigee Max Response Processing Latency
apigee.response_latency_max
The maximum amount of time in milliseconds, that it takes Edge to process API responses
requestProcessingLatency
Metric name
Metric key
Description
Apigee Average Request Processing Latency
apigee.request_latency
The average amount of time in milliseconds, that it takes Edge to process incoming requests.
maxTargetResponseTime
Metric name
Metric key
Description
Apigee Max Target Response Time
apigee.target_response_time_max
The maximum amount of time in milliseconds, for the target server to respond to a call.
maxRequestProcessingLatency
Metric name
Metric key
Description
Apigee Max Request Processing Latency
apigee.request_latency_max
The maximum amount of time in milliseconds, that it takes Edge to process incoming requests.
traffic
Metric name
Metric key
Description
Apigee Traffic (message count)
apigee.traffic
The total number of API calls processed by Edge in the specified time period.
targetResponseTime
Metric name
Metric key
Description
Apigee Target Response Time
apigee.target_response_time
The average amount of time in milliseconds, for the target server to respond to a call.
l1CacheElements
Metric name
Metric key
Description
Apigee L1 Cache Elements
apigee.l1_cache_elements
The average number of elements in the L1 cache.
targetError
Metric name
Metric key
Description
Apigee Target Errors
apigee.target_errors
The total number of 5xx responses from the target service. These are target service errors not caused by Apigee.
axCacheExecuted
Metric name
Metric key
Description
Apigee Cache Executed
apigee.ax_cache_executed
The number of times that a cache policy was executed during the processing of API requests.
