WSO2 API Manager monitoring

  • 4-min read
  • Published Jun 24, 2020
  • Outdated
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, 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

#NameUnitComment
1Carbon Faulty ServicesCount
2Carbon Response TimemsAverage
3Carbon Max Response Timems
4Carbon EMB Database Read Timems75th Percentile of read time
5Carbon EMB Database Read Rate in 15 minuteCount/sec
6Carbon EMB Database Write Timems75th Percentile of write time
7Carbon EMB Database Read Write in 15 minuteCount/sec

HTTP Connectivity Health

#NameUnitComment
8HTTP Listener Active ConnectionsCount
9HTTP Sender Active ConnectionsCount
10HTTP LatencymsAverage
11Backend HTTP LatencymsAverage
12HTTP Request Mediation LatencymsAverage
13HTTP Response Mediation LatencymsAverage
14HTTP Backend to ESB Response Read TimemsAverage
15HTTP Client to ESB Request Read TimemsAverage
16HTTP ESB to Backend Request Write TimemsAverage
17HTTP ESB to Client Response Write TimemsAverage

HTTPS Connectivity Health

#NameUnitComment
18HTTPS Listener Active ConnectionsCount
19HTTPS Sender Active ConnectionsCount
20HTTPS LatencymsAverage
21Backend HTTPS LatencymsAverage
22HTTPS Request Mediation LatencymsAverage
23HTTPS Response Mediation LatencymsAverage
24HTTPS Backend to ESB Response Read TimemsAverage
25HTTPS Client to ESB Request Read TimemsAverage
26HTTPS ESB to Backend Request Write TimemsAverage
27HTTPS ESB to Client Response Write TimemsAverage
28HTTPS Client Worker Queued TimemsAverage
29HTTPS Server Worker Queued TimemsAverage

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.

#NameAlert condition
1Carbon faulty servicesAt least one faulty Carbon service
2Carbon high response timeCarbon response time is 1 minute or more
3Carbon ESB high read timeCarbon ESB read time is 30 seconds or more
4Carbon ESB high write timeCarbon ESB write time is 30 seconds or more
5High HTTP latencyHTTP latency is 1 minute or more
6High HTTP backend latencyHTTP backend latency is 1 minute or more
7High HTTPS latencyHTTPS latency is 1 minute or more
8High HTTPS backend latencyHTTPs backend latency 1 minute