API Operational Metrics

Edit online

API Gateway provides API operational (Prometheus) metrics to report metric statistics for API calls, error, and error rates.

The following table describes the Prometheus metrics including, the description of the metric, metric type, and the Prometheus label for the metric.

Prometheus metric name Description Metric type Prometheus label

sag_apigw_apicalls_total

The total number of API invocations per HTTP response code.
Note:
  • The API invocations are counted per node and not for the complete cluster.
  • The count starts from zero when the server starts.
  • Counts only the API invocations within an API Gateway instance.

Sample apicall metrics is as follows: 

# HELP sag_apigw_apicalls_total Total number of API invocations per response code
# TYPE sag_apigw_apicalls_total counter
sag_apigw_apicalls_total {code="200" ,env="default"} 32 1635169035001
 Counter

code

env

Prometheus labels

Prometheus label Description
code The code label shows the HTTP response code for the API calls counted. For each HTTP response code that occurred during the lifetime of the API Gateway server, the metrics response will contain a separate counter entry.

Sample apicall metrics with HTTP response code is as follows: 

# HELP sag_apigw_apicalls_total Total number of API invocations per response code
# TYPE sag_apigw_apicalls total counter
sag_apigw_apicalls_total {code="200" ,env="default"} 32 1635169035001

In the example shown, 32 API calls are returned with the HTTP response code 200.

env The name of the customer environment.

The value of the env label is taken from the pg.gateway.elasticsearch.tenantId property in the config.properties file located at SAGInstallDir/IntegrationServer/instances/instance_name/packages/WmAPIGateway/config/resources/elasticsearch.