Microgateway 10.5 | webMethods Microgateway Help | Kubernetes Support | Prometheus Microgateway Metrics
 
Prometheus Microgateway Metrics
The Prometheus Microgateway metrics are provided at the server and API levels. This section provides details of both these metrics.
Server-Level Metrics
All server metrics have the metric type guage and a Prometheus label of host="hostname|ipaddress". The table lists the server-level Prometheus metrics for a Microgateway.
Prometheus metric name
Description
sag_microgateway_api_count
The number of deployed APIs.
sag_microgateway_http_requests
The total number of HTTP requests since the last statistics poll.
sag_microgateway_total_http_requests
The total number of HTTP requests since Microgateway startup.
sag_microgateway_max_memory_mb
The maximum memory in MB that the Microgateway JVM instance attempts to use.
This indicates the upper memory threshold.
sag_microgateway_total_memory_mb
The total memory in MB allocated in the Microgateway JVM.
This value may vary over time depending on the JVM memory handling.
sag_microgateway_free_memory_mb
The free memory in MB in the Microgateway JVM.
This value may increase due to JVM's garbage collection.
sag_microgateway_used_memory_mb
The memory in MB that is occupied in the Microgateway JVM.
This value is calculated as sag_microgateway_total_memory_mb - sag_microgateway_free_memory_mb.
sag_microgateway_threads
The current number of threads in use in a Microgateway instance.
sag_microgateway_max_threads
The maximum number of threads in a Microgateway JVM within a measured interval.
sag_microgateway_connections
The current number of internal TCP connections allocated by the Microgateway server.
This number might increase during parallel multi-user access to the server.
sag_microgateway_max_connections
The maximum number of internal TCP connections the Microgateway server has allocated.
sag_microgateway_total_connections
The total number of internal TCP connections the Microgateway server might allocate.
This indicates the upper threshold number of TCP connections allocated by the Microgateway server.
The metrics are stored as time series. Each sample consists of:
*a float64 value
*a millisecond-precision timestamp
Sample for the metric sag_microgateway_api_count
# HELP sag_microgateway_api_count The number of deployed APIs.
# TYPE sag_microgateway_api_count gauge
sag_microgateway_api_count{host="microgateway-10-4-cd6d47f85-z2rwq"}
2 1549887734839
Sample for the metric sag_microgateway_http_requests
# HELP sag_microgateway_http_requests The total number of HTTP requests since
last poll.
# TYPE sag_microgateway_http_requests gauge
sag_microgateway_http_requests{host="microgateway-10-4-cd6d47f85-z2rwq"}
100 1549887734839
Sample for the metric sag_microgateway_total_http_requests
# HELP sag_microgateway_total_http_requests The total number of HTTP requests
since Microgateway startup.
# TYPE sag_microgateway_total_http_requests gauge
sag_microgateway_total_http_requests{host="microgateway-10-4-cd6d47f85-z2rwq"}
1100 1549887734839
API-Level Metrics
All API-level metrics have the metric type guage and Prometheus labels of host="hostname|ipaddress" and api="apiName". The table lists the API-level Prometheus metrics for a Microgateway.
Prometheus metric name
Description
sag_microgateway_api_error_count
Total number of error events.
sag_microgateway_api_policy_violation_count
Total number of policy violations.
sag_microgateway_api_transaction_count
Total number of transactions.
sag_microgateway_api_average_response_time
The average time taken by the API to complete all invocations in the current interval. This is measured from the moment API Gateway receives the request until the moment it returns the response to the client.
sag_microgateway_api_fault_count
The number of failed invocations since the last statistics poll.
sag_microgateway_api_maximum_response_time
The maximum time taken by the API to complete an invocation since the last statistics poll.
sag_microgateway_api_minimum_response_time
The minimum time taken by the API to complete an invocation since the last statistics poll.
sag_microgateway_api_successful_request_count
The number of successful API invocations since the last statistics poll.
sag_microgateway_api_total_request_count
The total number of requests for each active API in API Gateway since the last statistics poll.