Gain insights into your WSO2 deployment.
Monitor WSO2 specific metrics for your OneAgent monitored processes.
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 this extension to:
This extension supports the following versions of the WSO2 API Manager:
3.2.04.1.04.2.0There is no charge to use the extension. You are only charged for the data that the extension ingests.
The WSO2 API Manager extension ingests custom metrics, which consume Davis Data Units (DDUs) (Dynatrace classic license) or Metrics powered by Grail (DPS), according to your license model.
In total, the WSO2 API Manager extension collects 27 metrics per process group instance per minute. You can estimate the metric data points produced per minute by using the following formula:
27 * N
N represents the number of process group instances reporting metrics to this extension.
In the Dynatrace Platform Subscription, metric ingestion consumes Metrics powered by Grail according to the number of ingested metric data points.
To calculate the approximate yearly consumption, apply the following calculation: <metric data points per minute> * 60 minutes * 24 hours * 365 days.
In the classic licensing model, metric ingestion consumes Davis Data Units (DDUs) at the rate of .001 DDUs per metric data point. Multiply the above formula for annual data points by .001 to estimate annual DDU usage.
The DDU cost above does not include any possible log events or custom events that are triggered by the extension. For more information, see DDU events.
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.synapseUsing a tool like jConsole can be useful in these situations.
When activating your extension using a 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.
| 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 |