WSO2 API Manager extension
- Latest Dynatrace
- Extension
- Published Oct 27, 2025
Gain insights into your WSO2 deployment.
Monitor WSO2 specific metrics for your OneAgent monitored processes.
Get started
Overview
This extension retrieves metrics through the JMX framework, using the default MBeans exposed by WSO2 API Manager. For more information, see the JMX-Based Monitoring documentation.
Use cases
Use this extension to:
- Gain detailed insights into your WSO2 deployment.
- Monitor desired hots via WSO2 specific metrics.
Requirements
- Dynatrace OneAgent running on the hosts you want to monitor.
- Activated the extension in your environment using in-product Hub.
- A monitoring configuration containing the hosts you want to monitor.
Compatibility information
This extension supports the following versions of the WSO2 API Manager:
3.2.04.1.04.2.0
Details
Licensing and cost
In total, the WSO2 API Manager extension collects 27 metrics. You can calculate the approximate of the yearly DDU consumption by using the following formula:
27 x 525.6 x N
N represents the number of process group instances reporting metrics to this extension.
For more information, see DDUs for metrics or Metrics powered by Grail overview (DPS) depending on your license model.
Troubleshooting
If you don't see any metrics, or are missing some metrics, ensure that your deployment exposes MBeans in the following namespaces:
org.wso2.carbonorg.wso2.carbon.metricsorg.apache.synapse
Using a tool like jConsole can be useful in these situations.
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.
default
| Metric name | Metric key | Description |
|---|---|---|
| Carbon - Number of faulty services | wso2-apim.number_faulty_services | Carbon - Number of faulty services |
| Carbon - System response time average | wso2-apim.system_response_time_avg | Carbon - System response time average |
| Carbon - System response time maximum | wso2-apim.system_response_time_max | Carbon - System response time maximum |
| Carbon - Database Read time 75th Percentile | wso2-apim.mb_database_read_75p | Carbon - Database Read time 75th Percentile |
| Carbon - Database Read Events rate in 15 minutes window | wso2-apim.mb_database_read_fifteenminuterate | Carbon - Database Read Events rate in 15 minutes window |
| Carbon - Database Write time 75th Percentile | wso2-apim.mb_database_write_75p | Carbon - Database Write time 75th Percentile |
| Carbon - Database Write Events rate in 15 minutes window | wso2-apim.mb_database_write_fifteenminuterate | Carbon - Database Write Events rate in 15 minutes window |
| Active http listener connections | wso2-apim.active_http_listener_connections | Active http listener connections |
| Active http sender connections | wso2-apim.active_http_sender_connections | Active http sender connections |
| Active https listener connections | wso2-apim.active_https_listener_connections | Active https listener connections |
| Active https sender connections | wso2-apim.active_https_sender_connections | Active https sender connections |
| HTTP - Average latency | wso2-apim.http_latency_avg | HTTP - Average latency |
| HTTP - Average backend latency | wso2-apim.http_latency_backend_avg | HTTP - Average backend latency |
| HTTP - Average request mediation latency | wso2-apim.http_request_mediation_latency_avg | HTTP - Average request mediation latency |
| HTTP - Average response mediation latency | wso2-apim.http_response_mediation_latency_avg | HTTP - Average response mediation latency |
| HTTP - Average time taken to read the response from gateway to backend | wso2-apim.http_backend_to_esb_response_read_time_avg | HTTP - Average time taken to read the response from gateway to backend |
| HTTP - Average time taken to read request by gateway which is sent by the client | wso2-apim.http_client_to_esb_request_read_time_avg | HTTP - Average time taken to read request by gateway which is sent by the client |
| HTTP - Average time taken to write the request from gateway to the backend | wso2-apim.http_esb_to_backend_request_write_time_avg | HTTP - Average time taken to write the request from gateway to the backend |
| HTTP - Average time taken to write the request from gateway to client app | wso2-apim.http_esb_to_client_response_write_time_avg | HTTP - Average time taken to write the request from gateway to client app |
| HTTPS - Average latency | wso2-apim.https_latency_avg | HTTPS - Average latency |
| HTTPS - Average backend latency | wso2-apim.https_latency_backend_avg | HTTPS - Average backend latency |
| HTTPS - Average request mediation latency | wso2-apim.https_request_mediation_latency_avg | HTTPS - Average request mediation latency |
| HTTPS - Average response mediation latency | wso2-apim.https_response_mediation_latency_avg | HTTPS - Average response mediation latency |
| HTTPS - Average time taken to read the response from gateway to backend | wso2-apim.https_backend_to_esb_response_read_time_avg | HTTPS - Average time taken to read the response from gateway to backend |
| HTTPS - Average time taken to read request by gateway which is sent by the client | wso2-apim.https_client_to_esb_request_read_time_avg | HTTPS - Average time taken to read request by gateway which is sent by the client |
| HTTPS - Average time taken to write the request from gateway to the backend | wso2-apim.https_esb_to_backend_request_write_time_avg | HTTPS - Average time taken to write the request from gateway to the backend |
| HTTPS - Average time taken to write the request from gateway to client app | wso2-apim.https_esb_to_client_response_write_time_avg | HTTPS - Average time taken to write the request from gateway to client app |
