Metrics

GET {{URL}}/metrics

Returns metrics for the Webapp

HEADERS

| Key | Datatype | Required | Description | | Authorization | string | | |

RESPONSES

status: OK

"{\n    \"metrics\": {\n        \"web_uptime\": {\n            \"type\": \"gauge\",\n            \"help\": \"Number of seconds since web server has started\",\n            \"data\": [\n                {\n                    \"labels\": {\n                        \"node\": \"06475793be9d\"\n                    },\n                    \"value\": 348842\n                }\n            ]\n        },\n        \"web_connections\": {\n            \"type\": \"counter\",\n            \"help\": \"Total number of connections accepted\",\n            \"data\": [\n                {\n                    \"labels\": {\n                        \"node\": \"06475793be9d\"\n                    },\n                    \"value\": 23781\n                }\n            ]\n        },\n        \"web_pending_connections\": {\n            \"type\": \"gauge\",\n            \"help\": \"Current number of pending connections in the queue\",\n            \"data\": [\n                {\n                    \"labels\": {\n                        \"node\": \"06475793be9d\"\n                    },\n                    \"value\": 0\n                }\n            ]\n        },\n        \"web_max_pending_connections\": {\n            \"type\": \"gauge\",\n            \"help\": \"Maximum number of pending connections in the queue\",\n            \"data\": [\n                {\n                    \"labels\": {\n                        \"node\": \"06475793be9d\"\n                    },\n                    \"value\": 10\n                }\n            ]\n        },\n        \"web_queue_len\": {\n            \"type\": \"gauge\",\n            \"help\": \"Size of queue for pending connections\",\n            \"data\": [\n                {\n                    \"labels\": {\n                        \"node\": \"06475793be9d\"\n                    },\n                    \"value\": 128\n                }\n            ]\n        },\n        \"web_idle_processes\": {\n            \"type\": \"gauge\",\n            \"help\": \"Current number of idle processes\",\n            \"data\": [\n                {\n                    \"labels\": {\n                        \"node\": \"06475793be9d\"\n                    },\n                    \"value\": 10\n                }\n            ]\n        },\n        \"web_total_processes\": {\n            \"type\": \"gauge\",\n            \"help\": \"Total process limit\",\n            \"data\": [\n                {\n                    \"labels\": {\n                        \"node\": \"06475793be9d\"\n                    },\n                    \"value\": 12\n                }\n            ]\n        },\n        \"web_process_limit_hit\": {\n            \"type\": \"counter\",\n            \"help\": \"Total number of times reached process limit\",\n            \"data\": [\n                {\n                    \"labels\": {\n                        \"node\": \"06475793be9d\"\n                    },\n                    \"value\": 0\n                }\n            ]\n        },\n        \"web_handled_requests\": {\n            \"type\": \"counter\",\n            \"help\": \"Total number of requests handled\",\n            \"data\": [\n                {\n                    \"labels\": {\n                        \"node\": \"06475793be9d\"\n                    },\n                    \"value\": 29841\n                }\n            ]\n        },\n        \"web_out_kbytes\": {\n            \"type\": \"counter\",\n            \"help\": \"Total outgoing traffic in kbytes\",\n            \"data\": [\n                {\n                    \"labels\": {\n                        \"node\": \"06475793be9d\"\n                    },\n                    \"value\": 115529\n                }\n            ]\n        },\n        \"web_requests\": {\n            \"type\": \"gauge\",\n            \"help\": \"Number of ongoing requests\",\n            \"data\": [\n                {\n                    \"labels\": {\n                        \"node\": \"06475793be9d\",\n                        \"state\": \"read\"\n                    },\n                    \"value\": 1\n                },\n                {\n                    \"labels\": {\n                        \"node\": \"06475793be9d\",\n                        \"state\": \"handle-request\"\n                    },\n                    \"value\": 2\n                },\n            ]\n        },\n        \"api_requests_duration_ms_sum\": {\n            \"type\": \"counter\",\n            \"help\": \"Total number of durations of API requests\",\n            \"data\": [\n                {\n                    \"labels\": {\n                        \"node\": \"06475793be9d\",\n                        \"result\": \"200\",\n                        \"method\": \"GET_v1_groups\"\n                    },\n                    \"value\": 753\n                },\n                {\n                    \"labels\": {\n                        \"node\": \"06475793be9d\",\n                        \"result\": \"200\",\n                        \"method\": \"POST_v1_settings_backup\"\n                    },\n                    \"value\": 1255\n                },\n                {\n                    \"labels\": {\n                        \"node\": \"06475793be9d\",\n                        \"result\": \"200\",\n                        \"method\": \"PATCH_v1_settings_application\"\n                    },\n                    \"value\": 491\n                },\n                ...\n            ]\n        },\n        \"api_requests_duration_ms_count\": {\n            \"type\": \"counter\",\n            \"help\": \"Total number of API requests\",\n            \"data\": [\n                {\n                    \"labels\": {\n                        \"node\": \"06475793be9d\",\n                        \"result\": \"401\",\n                        \"method\": \"GET_v1_settings_application\"\n                    },\n                    \"value\": 30\n                },\n                {\n                    \"labels\": {\n                        \"node\": \"06475793be9d\",\n                        \"result\": \"200\",\n                        \"method\": \"GET_metrics\"\n                    },\n                    \"value\": 5937\n                },\n                {\n                    \"labels\": {\n                        \"node\": \"06475793be9d\",\n                        \"result\": \"404\",\n                        \"method\": \"POST_v1_users_login\"\n                    },\n                    \"value\": 1\n                },\n            ]\n        },\n        \"api_requests_db_duration_ms_sum\": {\n            \"type\": \"counter\",\n            \"help\": \"Total time spent in making DB calls\",\n            \"data\": [\n                {\n                    \"labels\": {\n                        \"node\": \"06475793be9d\",\n                        \"query\": \"connect\",\n                        \"result\": \"ok\",\n                        \"method\": \"POST_v1_users_login\"\n                    },\n                    \"value\": 0\n                },\n                {\n                    \"labels\": {\n                        \"node\": \"06475793be9d\",\n                        \"query\": \"executeQuery\",\n                        \"result\": \"ok\",\n                        \"method\": \"GET_v1_groups\"\n                    },\n                    \"value\": 16\n                },\n                {\n                    \"labels\": {\n                        \"node\": \"06475793be9d\",\n                        \"query\": \"connect\",\n                        \"result\": \"ok\",\n                        \"method\": \"POST_v1_media\"\n                    },\n                    \"value\": 3\n                },\n                ...\n            ]\n        },\n        \"api_requests_db_duration_ms_count\": {\n            \"type\": \"counter\",\n            \"help\": \"Total number of calls to the DB\",\n            \"data\": [\n                {\n                    \"labels\": {\n                        \"node\": \"06475793be9d\",\n                        \"query\": \"connect\",\n                        \"result\": \"ok\",\n                        \"method\": \"GET_v1_stats_db\"\n                    },\n                    \"value\": 548\n                },\n                {\n                    \"labels\": {\n                        \"node\": \"06475793be9d\",\n                        \"query\": \"executeUpdate\",\n                        \"result\": \"ok\",\n                        \"method\": \"POST_v1_users_login\"\n                    },\n                    \"value\": 51\n                },\n                {\n                    \"labels\": {\n                        \"node\": \"06475793be9d\",\n                        \"query\": \"connect\",\n                        \"result\": \"ok\",\n                        \"method\": \"PATCH_v1_settings_application\"\n                    },\n                    \"value\": 38\n                },\n                ...\n            ]\n        },\n        \"api_requests_coreapp_duration_ms_sum\": {\n            \"type\": \"counter\",\n            \"help\": \"Total time spent in making CoreApp calls\",\n            \"data\": [\n                {\n                    \"labels\": {\n                        \"node\": \"06475793be9d\",\n                        \"coreapp\": \"wacore:6252\",\n                        \"result\": \"ok\",\n                        \"method\": \"GET_v1_stats_db\"\n                    },\n                    \"value\": 2934\n                },\n                {\n                    \"labels\": {\n                        \"node\": \"06475793be9d\",\n                        \"coreapp\": \"wacore:6252\",\n                        \"result\": \"ok\",\n                        \"method\": \"GET_v1_health\"\n                    },\n                    \"value\": 2083\n                },\n                {\n                    \"labels\": {\n                        \"node\": \"06475793be9d\",\n                        \"coreapp\": \"wacore:6252\",\n                        \"result\": \"ok\",\n                        \"method\": \"PATCH_v1_settings_application\"\n                    },\n                    \"value\": 328\n                },\n                ...\n            ]\n        },\n        \"api_requests_coreapp_duration_ms_count\": {\n            \"type\": \"counter\",\n            \"help\": \"Total number of calls to the CoreApp\",\n            \"data\": [\n                {\n                    \"labels\": {\n                        \"node\": \"06475793be9d\",\n                        \"coreapp\": \"wacore:6252\",\n                        \"result\": \"ok\",\n                        \"method\": \"GET_v1_stats_db\"\n                    },\n                    \"value\": 274\n                },\n                {\n                    \"labels\": {\n                        \"node\": \"06475793be9d\",\n                        \"coreapp\": \"wacore:6252\",\n                        \"result\": \"ok\",\n                        \"method\": \"POST_v1_settings_backup\"\n                    },\n                    \"value\": 14\n                },\n                {\n                    \"labels\": {\n                        \"node\": \"06475793be9d\",\n                        \"coreapp\": \"wacore:6252\",\n                        \"result\": \"ok\",\n                        \"method\": \"GET_v1_settings_application\"\n                    },\n                    \"value\": 4\n                },\n                ...\n            ]\n        }\n    },\n    \"meta\": {\n        \"version\": \"v2.45.1\",\n        \"api_status\": \"stable\"\n    }\n}\n"