Tags:

• aura-authentication

Categories:

• monitoring

Authentication API metrics

http_request_duration_seconds

This metric is intended to store the information related to all the incoming HTTP requests received by aura-authentication-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-authentication-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

This metric was stored since Greenday (6.0.0) release.

outgoing_request_duration_seconds

This metric is intended to store the information related to all the outgoing HTTP requests made by aura-authentication-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

This metric was stored since Camela (5.0.0) release.

aura_token_generate

This metric is intended to store the information related to Kernel accessToken generation, used during the integrated authorization process of the Aura users in aura-authentication-api.

It is intended to make it possible to set an alarm in the happening of any error during token validation. It is stored as a Summary in Prometheus.

Labels:

• path: specific endpoint of the request.
• httpStatus: HTTP status returned by Kernel in the response.
• originStatus: status sent by Kernel in the body of the response in the happening of an error.
• origin: channelId of the channel that needs the accessToken in Aura.

This metric was stored since Iron Maiden (7.2.0) release.

aura_component_version

This metric is intended to store the number of aura-authentication-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 Barricada (5.3.0) release with the name of authentication_api_version and updated to aura_component_version in Iron Maiden (7.2.0).

aura_server_unhandled_error

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

Labels:

• error: exception message that forced the unhandled error.

This metric was stored since Iron Maiden (7.2.0) release.

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