Apigee

Apigee

Remotely monitor your Apigee proxies.

Extension

Free trial Documentation

Product information
Release notes

Overview

This extension provides the ability to remotely monitor Apigee through the Analytics Metrics API. Every minute, this extension polls Apigee to ingest data about how each proxy is performing.

This is intended for users, who:

Would like to monitor the health and performance of the Apigee proxies
Look for analysis support for Ops, IT and developers.

This enables you to:

Monitor Apigee with a dedicated dashboard and Dynatrace entities to represent each proxy
Detect anomalies and alert on them

Use cases

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

Get started

For more information on the installation and configuration, please see Apigee extension in the Dynatrace Documentation.

Details

Compatibility information

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

Subscribe to new releases

Copy to clipboard

Feature sets

Below is a complete list of the feature sets provided in this version. To ensure a good fit for your needs, individual feature sets can be activated and deactivated by your administrator during configuration.

Feature setsNumber of metrics included

Metric name	Metric key	Description	Unit
Apigee Policy Errors	apigee.policy_errors	The total number of policy errors encountered.	Count

Metric name	Metric key	Description	Unit
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.	MilliSecond

Metric name	Metric key	Description	Unit
Apigee Target Response Time	apigee.target_response_time	The average amount of time in milliseconds, for the target server to respond to a call.	MilliSecond

Metric name	Metric key	Description	Unit
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.	Count

Metric name	Metric key	Description	Unit
Apigee Traffic (message count)	apigee.traffic	The total number of API calls processed by Edge in the specified time period.	Count

Metric name	Metric key	Description	Unit
Apigee Response Size	apigee.response_size	The average size of the response payload returned to the client, in bytes.	Byte

Metric name	Metric key	Description	Unit
Apigee Max Response Size	apigee.response_size_max	The maximum size of the response payload returned to the client, in bytes.	Byte

Metric name	Metric key	Description	Unit
Apigee Max Response Processing Latency	apigee.response_latency_max	The maximum amount of time in milliseconds, that it takes Edge to process API responses	MilliSecond

Metric name	Metric key	Description	Unit
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.	Count

Metric name	Metric key	Description	Unit
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.	MilliSecond

Metric name	Metric key	Description	Unit
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.	MilliSecond

Metric name	Metric key	Description	Unit
Apigee L1 Cache Elements	apigee.l1_cache_elements	The average number of elements in the L1 cache.	Count

Metric name	Metric key	Description	Unit
Apigee Max Request Size	apigee.request_size_max	The maximum size of the request payload received by Edge, in bytes.	Byte

Metric name	Metric key	Description	Unit
Apigee Proxy Errors	apigee.errors	The total number of times API proxies failed over the specified time period.	Count

Metric name	Metric key	Description	Unit
Apigee Cache Executed	apigee.ax_cache_executed	The number of times that a cache policy was executed during the processing of API requests.	Count

Metric name	Metric key	Description	Unit
Apigee API Connectivity	apigee.api.connectivity	Was Dynatrace able to poll the Apigee API without errors?	Percent

Metric name	Metric key	Description	Unit
Apigee Average Request Processing Latency	apigee.request_latency	The average amount of time in milliseconds, that it takes Edge to process incoming requests.	MilliSecond

Metric name	Metric key	Description	Unit
Apigee Average Transactions per Second	apigee.throughput	The average number of transactions, meaning API proxy requests, per second.	Count

Metric name	Metric key	Description	Unit
Apigee Response Processing Latency	apigee.response_latency	The average amount of time in milliseconds, that it takes Edge to process API responses	MilliSecond

Metric name	Metric key	Description	Unit
Apigee Max Request Processing Latency	apigee.request_latency_max	The maximum amount of time in milliseconds, that it takes Edge to process incoming requests.	MilliSecond

Metric name	Metric key	Description	Unit
Apigee Request Size	apigee.request_size	The average size of the request payload received by Edge, in bytes.	Byte

Metric name	Metric key	Description	Unit
Apigee L1 Cache Elements Max	apigee.l1_cache_elements_max	The maximum number of elements in the L1 cache.	Count

Full version history

To have more information on how to install the downloaded package, please follow the instructions on this page.

ReleaseDate

Full version history

Improve existing unified analysis screens

Full version history

WARNING: Possible breaking changes and warnings - PLEASE READ before upgrading:

This version requires a minimum Dynatrace version of 1.338.0 and a minimum EEC version of 1.333.0.
This version includes a breaking change for Dynatrace on Grail.
- With the inclusion of OpenPipeline processing rules, any metrics ingested from the extension will be processed by a dedicated OpenPipeline pipeline instead of the classic pipeline.
- This means that classic rules will no longer be used on metrics ingested from the extension. Please be sure to migrate any you still need to OpenPipeline rules.
- Additionally, some field names are handled differently in OpenPipeline, e.g. capitalization. Please double-check any custom dashboards and alerts you have created for this extension.
- You must opt-in to OpenPipeline configuration via Settings API – see the documentation.

New in this version:

Smartscape on Grail.
Refactored feature sets according to the best practices established here.
Added feature set metadata for recommended metrics.

Full version history

Proxy credentials are now optional and can be excluded

Full version history

Add extra metrics and support feature sets
Add support for custom google locations: https://docs.cloud.google.com/apigee/docs/locations#available-apigee-api-control-plane-hosting-jurisdictions
Add support for Oauth2 client_credentials grant type
Improve settings layout and documentation

Full version history

✨ New in this version:

Added Davis anomaly detector templates to extension package

Full version history

⚠️ NOTICE: This version requires a minimum Dynatrace and EEC version of 1.313

🚀 Improved in this version:

Add Dynatrace Error Codes to reported errors

Full version history

Adds the option to specify custom Client ID and Client Secret values for Oauth authentication.

Full version history

Generate new platform dashboard and screen updates
Add support for dt.security_context

Full version history

Add new platform dashboard

Full version history

Adds an option to ignore an empty metrics response from Apigee instead of raising it as an error.
The list of extra dimensions to collect can now be empty

Full version history

Include chardet as an install dependency. Without this requests uses charset-normalizer which requires an executable .so file, which is often blocked on noexec filesystems.

Full version history

Fixes a bug where requests were still being validated even if 'Verify' was set to false in the configuration.
Requires both Verify and Use Custom Certificates to be enabled before using custom certificate bundles to validate Apigee host SSL

Full version history

Note: This update requires Monitoring Configurations to be recreated. You cannot automatically update a configuration from 2.x.x to 3.0.0 due to the various configuration and UI changes.

Improve extension configuration settings
- Drop SAML auth from the supported options
- Google authentication properties can now be added to the extension configuration
- Credential vault support for username/password fields
- Improved documentation
Always Include the Proxy (apiproxy) dimension.
Reduce custom dimension selection to 4 (apiproxy is always the 5th)
Improved error reporting.
Collect an Apigee API connection metric
- Custom alert for when the apigee API connection fails
SSL verification settings now used in Google oauth2 requests

Full version history

Add option to mask 'Client IP' addresses.
Add organization and environment dimensions
Add a warning about high metric cardinality and sensitive data in the dimension selection field

Full version history

Add entity type to metrics for tags and management zone rules
Proxy icon for created Entities
Update dependency package versions

Full version history

Advanced configuration option - custom request timeout

Full version history

Support for all Apigee Analytics Dimensions

All

221 Results filtered by:

Akamai

Ingest logs and security events from Akamai products.

Alibaba Cloud

Automatically discover, baseline, and monitor Alicloud environment components.

Anypoint MQ

Gather metrics about your Anypoint MQ Queues.

Apache ActiveMQ Classic

Automatic and smart observability for ActiveMQ with trace and metric insights.

Apache Cassandra

Improve Apache Cassandra observability.

Apache CouchDB

Intelligently observe and optimize health and performance of your database.

Apache Kafka

Automatic and intelligent observability with trace and metric insights.

Apache Solr

Open-source enterprise-search platform, written in Java.

Apache Spark

Enhanced insights for Spark Components.

Apache Zookeeper

Monitor and analyze your Apache Zookeeper with this JMX-based extension.

Apigee

Remotely monitor your Apigee proxies.

AWS Cloud Monitoring

New and enhanced monitoring capabilities for your AWS cloud platforms.

AWS Entities for Metric Streaming

Analyse metrics in the context of an entity based on AWS Metric Streaming.

Azure Cloud Monitoring

New and enhanced monitoring capabilities for your Azure cloud platforms.

Extensioncoming soon

Azure Managed Apache Cassandra

Gain insights into your Azure Managed Cassandra Instance health and performance.

Black Duck

Ingest Black Duck security events and audit logs.

Ceph storage

Monitor usage of Ceph storage system at both client side and host level.

Checkmarx

Ingest Checkmarx security events and audit logs.

Check Point Firewall

Gain insights into the performance of your Check Point Firewall devices.

Cisco ACI/APIC

Get insights into your Cisco Application Centric Infrastructure (ACI).

Cisco Catalyst Center (DNA Center)

Get insights into the Cisco Catalyst Center infrastructure (f.k.a. DNA Center).

Cisco Catalyst SD-WAN Manager (Viptela)

Get insights into the Cisco SD-WAN performance through the vManage API.

Cisco Firepower

Monitor Cisco Firepower devices using SNMP.

Cisco UCS C-Series

Get insights into your Cisco UCS C-Series devices.

Cisco UCS M-Series

Get insights into your Cisco UCS M-Series devices.

Citrix DaaS & Virtual Apps and Desktops

Gain insight into your Citrix DaaS & Virtual Apps and Desktops environments.

Citrix Netscaler ADC

Remotely monitor your Citrix NetScaler devices.

Citrix NetScaler SDX

Remotely monitor your Citrix NetScaler SDX devices.

Cloudflare (extension)

Collect notification history and various metrics from your Cloudflare accounts.

Cloud Foundry

Monitor your Cloud Foundry resource definitions by connecting to the foundation.

Confluent Cloud (Kafka)

Remotely monitor your Confluent Cloud Kafka Clusters and other resources!.

Connection Pools: Apache Commons

Application method of pooling and sharing multiple connections to a database.

Connection Pools: C3P0

Application server method of pooling and sharing connections to a database.

Connection Pools: JBoss

Application server method of pooling and sharing connections to a database.

Connection Pools: WebLogic

Application server method of pooling and sharing connections to a database.

Connection Pools: WebSphere Liberty

Application server method of pooling and sharing connections to a database.

Consul Service Mesh (StatsD)

Extend visibility into your Consul Service Mesh instances to monitor health and improve performance.

Control-M Jobs v2

Monitor your Control-M jobs execution status.

CoreDNS (2.0)

Collect important data from your CoreDNS processes.

Couchbase

Couchbase Capella (SaaS) database monitoring.

CPU Core Monitoring

Get insights into CPU Core utilization on your OneAgent hosts.

CrowdStrike

Ingest CrowdStrike detection findings.

CyberArk

Ingest CyberArk audit logs via SIEM integration for reporting and analysis.

Databricks

Monitor your Databricks Clusters via its multiple APIs!.

Databricks Workspace

Remotely monitor your Databricks Workspaces!.

definity

Monitor and optimize your Lakehouse, Spark, and Databricks pipelines.

Defunct Process Monitoring

Monitoring defunct processes stuck on your linux servers.

Dell EMC Isilon - PowerScale

Monitor your Dell EMC Isilon / Powerscale clusters through the OneFS API.

Dell EMC PowerMax

Monitor PowerMax Arrays for performance and health, with Dell Unisphere API.

Dell iDRAC

Connect to the Redfish API to get insights into your Dell iDRAC environment.