WSO2 API Manager monitoring

Deprecation notice

This extension documentation is now deprecated and will no longer be updated. We recommend using the new WSO2 API Manager extension for improved functionality and support.

WSO2 API Manager is a fully open-source, full lifecycle API Management solution.

Prerequisites

Activation

  1. Go to Settings.
  2. Select Monitoring > Monitored technologies.
  3. Find the WSO2 API Manager entry and select Edit (pencil icon).
  4. Enable the Monitor this environment option.

See your data

Go to Hosts or Hosts Classic (latest Dynatrace), find your WSO2 host, select it to open Host overview page, and select the Tomcat process responsible for running WSOA2 API Manager.

Collected metrics

You'll find all the collected metrics in the WSO2 API Manager process group page.

Overall Carbon Health

#
Name
Unit
Comment
1
Carbon Faulty Services
Count
2
Carbon Response Time
ms
Average
3
Carbon Max Response Time
ms
4
Carbon EMB Database Read Time
ms
75th Percentile of read time
5
Carbon EMB Database Read Rate in 15 minute
Count/sec
6
Carbon EMB Database Write Time
ms
75th Percentile of write time
7
Carbon EMB Database Read Write in 15 minute
Count/sec

HTTP Connectivity Health

#
Name
Unit
Comment
8
HTTP Listener Active Connections
Count
9
HTTP Sender Active Connections
Count
10
HTTP Latency
ms
Average
11
Backend HTTP Latency
ms
Average
12
HTTP Request Mediation Latency
ms
Average
13
HTTP Response Mediation Latency
ms
Average
14
HTTP Backend to ESB Response Read Time
ms
Average
15
HTTP Client to ESB Request Read Time
ms
Average
16
HTTP ESB to Backend Request Write Time
ms
Average
17
HTTP ESB to Client Response Write Time
ms
Average

HTTPS Connectivity Health

#
Name
Unit
Comment
18
HTTPS Listener Active Connections
Count
19
HTTPS Sender Active Connections
Count
20
HTTPS Latency
ms
Average
21
Backend HTTPS Latency
ms
Average
22
HTTPS Request Mediation Latency
ms
Average
23
HTTPS Response Mediation Latency
ms
Average
24
HTTPS Backend to ESB Response Read Time
ms
Average
25
HTTPS Client to ESB Request Read Time
ms
Average
26
HTTPS ESB to Backend Request Write Time
ms
Average
27
HTTPS ESB to Client Response Write Time
ms
Average
28
HTTPS Client Worker Queued Time
ms
Average
29
HTTPS Server Worker Queued Time
ms
Average

Metrics from 1 to 7 are retrieved from the org.wso2.carbon Java MBeans path, while all the other metrics come from the org.apache.synapse path.

Alerts

The following alerts are enabled by default. Each alert is triggered after 5 consecutive reads.

#
Name
Alert condition
1
Carbon faulty services
At least one faulty Carbon service
2
Carbon high response time
Carbon response time is 1 minute or more
3
Carbon ESB high read time
Carbon ESB read time is 30 seconds or more
4
Carbon ESB high write time
Carbon ESB write time is 30 seconds or more
5
High HTTP latency
HTTP latency is 1 minute or more
6
High HTTP backend latency
HTTP backend latency is 1 minute or more
7
High HTTPS latency
HTTPS latency is 1 minute or more
8
High HTTPS backend latency
HTTPs backend latency 1 minute

Related topics