Get App Stats Prometheus Format
GET {{URL}}/v1/stats/app?format=prometheus
Send a GET call the
/v1/stats/app
endpoint with
format
=
prometheus
to retrieve Coreapp stats in Prometheus format. Coreapp stats live in memory and can be queried at regular intervals if needed.
Returned Fields
| Name | Description |
|---|---|
callback_queue_size
Type: Object | Current callback queue size. |
callback_requests_duration_ms_count
Type: Object | Total number of callback requests made and result. |
callback_requests_duration_ms_sum
Type: Object | Total duration (ms) of callback requests. |
concurrent_rate_limit_triggered
Type: Object | Current number of concurrent rate limit triggers. |
db_request_duration_us_count
Type: Object | Total number of successful SQL queries. |
db_request_duration_us_sum
Type: Object | Total duration (microseconds) of successful SQL queries. |
db_request_error_duration_us_count
Type: Object | Total number of failed SQL queries. |
db_request_error_duration_us_sum
Type: Object | Total duration(microseconds) of failed SQL queries. |
endpoint_requests
Type: Object | Total number of endpoint requests made for a given endpoint and result (either ok or an error code). |
endpoint_requests_duration_ms_count
Type: Object | Total number of endpoint requests. |
endpoint_requests_duration_ms_sum
Type: Object | Total duration (ms) of endpoint requests. |
in_message_decoded
Type: Object | Total number of incoming messages decrypted successfully. |
in_message_from_server
Type: Object | Total number of incoming encrypted messages from server. |
in_message_persisted
Type: Object | Total number of incoming messages cached in the database. |
in_messages_pending_processing
Type: Object | Number of encrypted messages received yet to be processed. |
internal_server_conn_duration_ms_count
Type: Object | Total number of internal server connection requests made. |
internal_server_conn_duration_ms_sum
Type: Object | Total duration (ms) spent in connecting to internal server in ms. |
internal_server_requests_duration_ms_count
Type: Object | Total number of internal server requests. |
internal_server_requests_duration_ms_sum
Type: Object | Total duration(ms) of internal server requests. |
media_downloads
Type: Object | Total number of media files downloaded from server. |
media_uploads
Type: Object | Total number of media files uploaded to server. |
out_message_persisted
Type: Object | Total number of outgoing messages cached in the database. |
out_message_status
Type: Object | Total number of outgoing messages of a particular status. |
out_message_sent_duration_ms_count
Type: Object | Total number of messages sent to server successfully. |
out_message_sent_duration_ms_sum
Type: Object | Total duration (ms) used to send messages to server. |
pending_callbacks
Type: Object | Current number of pending callbacks in the queue for each callback type. |
pending_messages
Type: Object | Current number of pending messages in the queue. |
per_sec_request_rate_limit_triggered
Type: Object | Current number of per second request rate limit triggers. |
per_hour_request_rate_limit_triggered
Type: Object | Current number of per hour request rate limit triggers. |
per_day_request_rate_limit_triggered
Type: Object | Current number of per day request rate limit triggers. |
per_day_contacts_scrape_limit_triggered
Type: Object | Current number of per day contact scrape limit triggers. |
Request Params
| Key | Datatype | Required | Description |
| format | string | | |
HEADERS
| Key | Datatype | Required | Description |
RESPONSES
status: OK
{"stats":{"app":{"your-hostname1:your-container-id1":{"callback_queue_size":{"data":[{"value":450}],"help":"Current callback queue size","type":"gauge"}},"your-hostname2:your-container-id2":{"callback_queue_size":{"data":[{"value":10}],"help":"Current callback queue size","type":"gauge"}}}},"meta":{"version":"v2.45.1","api_status":"stable"}}