Tags:

• aura-gateway-api

Categories:

• monitoring

Gateway API metrics

http_request_duration_seconds

This metric is intended to store the information related to all the incoming HTTP requests received by aura-gateway-api.

It is stored as a Summary in Prometheus, so every sample, besides the defined labels, also includes its duration.

This metric allows measuring the behavior of the requests from any given endpoint. Specifically, the duration since the request lands in aura-gateway-api until its HTTP response is returned:

• The number of requests during a time
• The average/min/max duration of these requests

Labels:

• method: HTTP method used by the request being stored (GET, POST, PUT, DELETE, etc.)
• host: host and domain where the request is being sent
• path: specific endpoint of the request
• status_code: HTTP status code returned in the response
• application: Application name of the request.
• channel: Channel name of the request. Only for NLPaaS endpoint.
• preset: Preset name of the request. Only for Generative endpoint.

outgoing_request_duration_seconds

This metric is intended to store the information related to all the outgoing HTTP requests made by aura-gateway-api. It is stored as a Summary in Prometheus, so every sample, besides the defined labels, also includes its duration.

The metric allows measuring the behavior of the requests to any given endpoint:

• The number of requests during a time
• The average/min/max duration of these requests

Labels:

• method: HTTP method used by the request being stored (GET, POST, PUT, DELETE, etc.)
• host: host and domain where the request is being sent
• path: specific endpoint of the request
• status: HTTP status code returned in the response

aura_component_version

This metric is intended to store the number of aura-gateway-api instances (pods) running each version of the code.

It is stored as a Gauge in Prometheus.

Labels:

• version: version field in the package.json file included in the running docker container.
• component: name of the component that is writing the metric.

This metric was stored since Beatles (8.9.0) release.

aura_server_unhandled_error

This metric is intended to store the number of unhandled errors happening in aura-gateway. It is stored as a Counter in Prometheus.

Labels:

• error: exception message that forced the unhandled error.

services_status

This metric is intended to store the number of success or errored checks of modules of the server. It is stored as a Counter in Prometheus.

Labels:

• moduleId: Id of the module.
• status: OK or ERROR