View the Metrics Description
Now that you have identified what is required to install CA Precision API Monitoring, let us look at the metrics that are collected, which enable you to manage the health of your APIs.
caapipm34
Now that you have identified what is required to install CA Precision API Monitoring, let us look at the metrics that are collected, which enable you to manage the health of your APIs.
Service Metrics
For every service execution, these metrics are collected and reported to CA APM.
The metrics that are collected for all services include:
Metric Name | Description |
Front End Average Response Time | Time (milliseconds) taken for CA API Gateway to receive the API call from a client, then send a response back to the client. |
Back End Average Response Time | Time (milliseconds) taken for CA API Gateway to forward the API call to the back-end service, then receive a response from the web service. Thus, the front end response time always includes the back end response time. The Back End response time includes all routings, if there are multiple routing assertions in the policy. The following Assertions are covered as back-end categories:
|
Policy Violations | Number of requests that failed policy assertions. |
Request size (bytes) | The size (bytes) of the entire message sent to the Gateway. |
Routing Failures | Number of requests that passed policy assertions but failed at the back end web service. |
Success Count | Number of API calls that have been successfully routed (completed). |
Total Requests | Total number of API calls that have been routed (both successful and failed). |
Blame Metrics
The metric values from the gateway that are passed to CA APM are displayed in Experience Views and are known as blame metrics. The blame metrics are derived using the following methods:
- Average Response Time values are taken from the gateway Front End Latency metrics.
- Errors Per Interval values are taken from the gateway Routing Failures metrics, and
- Responses Per Interval values are taken from the gateway Total Requests metrics.
Enhanced JVM Metrics
You can select the JVM metrics parameters on which to report. Additionally, there are more JVM metric parameters that you can use to help you understand and troubleshoot JVM‐related activity on the CA API Gateway.
The JVM metrics assertion properties dialog permits you to configure on which parameter to report. The solution kit has the policy pre‐configured to report JSON type metrics for performance reasons.
To use XML instead of JSON, modify the policy by selecting XML Metrics type.
Each JVM metric line is made up of the name of the gateway agent, the service, the actual API, and the metric that is being reported. The metric values are then passed along through the Type and Value variables. The JVM metrics are sent once in every service metric cycle. By default, service metrics are sent every 15 seconds.
OS Metrics
The following OS metric properties are supported:
Property | Description | Metric Name | Metric Value |
Disk Usage | The amount of hard disk space in use | Free Disk Space (MB) Free Disk Space (%) | Available disk space in MB and percentage. |
CPU Usage | The CPU load aggregated across all CPUs and cores | Average CPU Usage (%) | CPU Load |
NTP Status | The current status of the NTP server | NTP Status | 2=Synchronized 1=Unkown 0=Unsynchronized |
Audit Size | Number of audit events in the Gateway database | Audit Records | Number of audit events |
MySQL Status | MySQL status information | MySQL Status | Only non-zero value metrics are reported |
Log File size | Total size of all the Gateway log files | Log File Size in (KB) | Log file size in KB |
Swap space used | Amount of the swap file that is in use | Total Swap Space (MB) Used Swap Space (MB) Free Swap Space (MB) | Swap space in MBs |
Raid Status | The current status of a RAID array | Raid Enabled Raid Status Raid Level | Raid Enabled 1- enable 0-disable Raid Status 1-Active 0-Not Active Raid Level |
Kernel Information | Gateway Server kernel information | Kernel Information Kernel Boot Parameters | Note: The kernel information in the form of string that is delimited by '|' character is displayed. No graph is plotted. |
Memory Information | Gateway Server memory information | Total Memory Free Memory Buffers Cache Memory Swap Cache Memory | Memory size |
Operating Status | Gateway status information | Operating Status | 5=Running 4=Starting 3=Stopping 2=Crashed 1=Will Not Start 0=Stopped |