Tags:

• aura-bridge

Categories:

• monitoring

Aura Bridge metrics

http_request_duration_seconds

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

It measures the duration since the request lands in aura-bridge until its HTTP response is returned, indicating to the client that Aura is processing the request to obtain a proper answer for the user.

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 allows measuring the behavior of the requests from any given endpoint:

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

This metric was stored since Greenday (6.0.0) release.

outgoing_message_duration_seconds

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

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

As aura-bridge is an asynchronous server, the processing of a request does not end when the HTTP response is returned, but when the proper answer for the user is sent back to the client callback.

This metric measures the duration since the request lands in aura-bridge until the last message of its answer is sent to the client callback.

Labels:

• host: host and domain where the request is being sent.
• method: HTTP method used by the request being stored (GET, POST, PUT, DELETE, etc.)
• path: specific endpoint of the request.
• originStatus: third party status sent in the body of the response. Usually, this status is sent by whatsapp.
• status: HTTP status code returned in the response.
• origin: specific source of the request. The value could be: ‘4p’, ‘whatsapp’, ‘aura-bot’ or ‘genesys’.
• channel: channel of the request.

This metric allows measuring the behavior of the requests from any given endpoint:

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

This metric was stored since Greenday (6.0.0) release.

incoming_message_duration_seconds

This metric is intended to store the number requests arriving to aura-bridge from a channel or Direct Line.

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

As aura-bridge is an asynchronous server, the processing of a request does not end when the HTTP response is returned, but when the proper answer for the channel or Direct Line is sent back to the client callback. This metric measures the duration from when the request arrives at aura-bridge until it is processed to send to the channel or Direct Line.

Labels:

• path: specific endpoint of the request.
• httpStatus: HTTP status code returned in the response.
• originStatus: status sent by Direct Line or channel in the body of the response in the happening of an error.
• origin: specific host of the request. If origin is missing, the content of path label will be added.
• channel: channel of the request. In Auraline requests used to get conversationId with path: /aura-services/v1/auraline/conversations, channel will be missing.

aura_response_ack_duration_seconds

This metric is intended to store the information related to all the ACK requests sent by the clients to aura-bridge. The ACK requests are used by the clients (WhatsApp) to notify if in the end Aura’s answer was delivered to the user or not.

It is stored as a Summary in Prometheus, so every sample, besides the defined labels, also includes its duration. The duration measures since the ACK request lands in aura-bridge until its asynchronous answer is sent to the user.

Labels:

• host: host and domain where the request is being sent.
• method: HTTP method used by the request being stored (GET, POST, PUT, DELETE, etc.)
• path: specific endpoint of the request.
• originStatus: third party status sent in the body of the response. Usually, this status is sent by whatsapp.
• status: HTTP status code returned in the response.
• origin: specific source of the request. The value could be: ‘4p’, ‘whatsapp’, ‘aura-bot’ or ‘genesys’.
• channel: channel of the request.

This 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

This metric was stored since Heroes (7.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-bridge. It is stored as a Summary in Prometheus, so every sample, besides the defined labels, also includes its duration.

Labels:

• method: HTTP method used by the request being stored (GET, POST, PUT, DELETE, …)
• 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 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

This metric was stored since Greenday (6.0.0) release.

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.

aura_token_generate

This metric is intended to store the information related to Kernel accessToken refreshments in aura-bridge. It is intended to make it possible to set an alarm in the happening of any error during refresh of the 2-legged accessToken needed to access Kernel WhatsApp APIs.

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-bridge 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 Greenday (6.0.0) release with the name of aura_bridge_version and updated to aura_component_version in Iron Maiden (7.2.0).

aura_bridge_wa_incoming_message

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