From 7373d04d54a98bc2e84c294cbe4e94b9a6d1ec9f Mon Sep 17 00:00:00 2001 From: Aliaksandr Valialkin Date: Sun, 1 Oct 2023 20:35:07 +0200 Subject: [PATCH] docs/Single-server-VictoriaMetrics.md: refer to `active queries` and `top queries` pages at VMUI instead of refering to the corresponding HTTP endpoints "Active queries" and "Top queries" pages at VMUI are user-friendly than the corresponding HTTP endpoints --- README.md | 12 +++++++++--- docs/README.md | 12 +++++++++--- docs/Single-server-VictoriaMetrics.md | 12 +++++++++--- 3 files changed, 27 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index aab85c42e..525c6f2f6 100644 --- a/README.md +++ b/README.md @@ -365,6 +365,8 @@ See the [example VMUI at VictoriaMetrics playground](https://play.victoriametric * queries with the biggest average execution duration; * queries that took the most summary time for execution. +This information is obtained from the `/api/v1/status/top_queries` HTTP endpoint. + ## Active queries [VMUI](#vmui) provides `active queries` tab, which shows currently execute queries. @@ -374,6 +376,8 @@ It provides the following information per each query: - The duration of the query execution. - The client address, who initiated the query execution. +This information is obtained from the `/api/v1/status/active_queries` HTTP endpoint. + ## Metrics explorer [VMUI](#vmui) provides an ability to explore metrics exported by a particular `job` / `instance` in the following way: @@ -855,7 +859,7 @@ Additionally, VictoriaMetrics provides the following handlers: * `/api/v1/series/count` - returns the total number of time series in the database. Some notes: * the handler scans all the inverted index, so it can be slow if the database contains tens of millions of time series; * the handler may count [deleted time series](#how-to-delete-time-series) additionally to normal time series due to internal implementation restrictions; -* `/api/v1/status/active_queries` - returns a list of currently running queries. +* `/api/v1/status/active_queries` - returns the list of currently running queries. This list is also available at [`active queries` page at VMUI](#active-queries). * `/api/v1/status/top_queries` - returns the following query lists: * the most frequently executed queries - `topByCount` * queries with the biggest average execution duration - `topByAvgDuration` @@ -865,6 +869,8 @@ Additionally, VictoriaMetrics provides the following handlers: For example, request to `/api/v1/status/top_queries?topN=5&maxLifetime=30s` would return up to 5 queries per list, which were executed during the last 30 seconds. VictoriaMetrics tracks the last `-search.queryStats.lastQueriesCount` queries with durations at least `-search.queryStats.minQueryDuration`. + See also [`top queries` page at VMUI](#top-queries). + ### Timestamp formats VictoriaMetrics accepts the following formats for `time`, `start` and `end` query args @@ -1815,9 +1821,9 @@ Graphs on the dashboards contain useful hints - hover the `i` icon in the top le We recommend setting up [alerts](https://github.com/VictoriaMetrics/VictoriaMetrics/tree/master/deployment/docker#alerts) via [vmalert](https://docs.victoriametrics.com/vmalert.html) or via Prometheus. -VictoriaMetrics exposes currently running queries and their execution times at `/api/v1/status/active_queries` page. +VictoriaMetrics exposes currently running queries and their execution times at [`active queries` page](#active-queries). -VictoriaMetrics exposes queries, which take the most time to execute, at `/api/v1/status/top_queries` page. +VictoriaMetrics exposes queries, which take the most time to execute, at [`top queries` page](#top-queries). See also [VictoriaMetrics Monitoring](https://victoriametrics.com/blog/victoriametrics-monitoring/) and [troubleshooting docs](https://docs.victoriametrics.com/Troubleshooting.html). diff --git a/docs/README.md b/docs/README.md index fb316fa7d..4563dcaaf 100644 --- a/docs/README.md +++ b/docs/README.md @@ -368,6 +368,8 @@ See the [example VMUI at VictoriaMetrics playground](https://play.victoriametric * queries with the biggest average execution duration; * queries that took the most summary time for execution. +This information is obtained from the `/api/v1/status/top_queries` HTTP endpoint. + ## Active queries [VMUI](#vmui) provides `active queries` tab, which shows currently execute queries. @@ -377,6 +379,8 @@ It provides the following information per each query: - The duration of the query execution. - The client address, who initiated the query execution. +This information is obtained from the `/api/v1/status/active_queries` HTTP endpoint. + ## Metrics explorer [VMUI](#vmui) provides an ability to explore metrics exported by a particular `job` / `instance` in the following way: @@ -858,7 +862,7 @@ Additionally, VictoriaMetrics provides the following handlers: * `/api/v1/series/count` - returns the total number of time series in the database. Some notes: * the handler scans all the inverted index, so it can be slow if the database contains tens of millions of time series; * the handler may count [deleted time series](#how-to-delete-time-series) additionally to normal time series due to internal implementation restrictions; -* `/api/v1/status/active_queries` - returns a list of currently running queries. +* `/api/v1/status/active_queries` - returns the list of currently running queries. This list is also available at [`active queries` page at VMUI](#active-queries). * `/api/v1/status/top_queries` - returns the following query lists: * the most frequently executed queries - `topByCount` * queries with the biggest average execution duration - `topByAvgDuration` @@ -868,6 +872,8 @@ Additionally, VictoriaMetrics provides the following handlers: For example, request to `/api/v1/status/top_queries?topN=5&maxLifetime=30s` would return up to 5 queries per list, which were executed during the last 30 seconds. VictoriaMetrics tracks the last `-search.queryStats.lastQueriesCount` queries with durations at least `-search.queryStats.minQueryDuration`. + See also [`top queries` page at VMUI](#top-queries). + ### Timestamp formats VictoriaMetrics accepts the following formats for `time`, `start` and `end` query args @@ -1818,9 +1824,9 @@ Graphs on the dashboards contain useful hints - hover the `i` icon in the top le We recommend setting up [alerts](https://github.com/VictoriaMetrics/VictoriaMetrics/tree/master/deployment/docker#alerts) via [vmalert](https://docs.victoriametrics.com/vmalert.html) or via Prometheus. -VictoriaMetrics exposes currently running queries and their execution times at `/api/v1/status/active_queries` page. +VictoriaMetrics exposes currently running queries and their execution times at [`active queries` page](#active-queries). -VictoriaMetrics exposes queries, which take the most time to execute, at `/api/v1/status/top_queries` page. +VictoriaMetrics exposes queries, which take the most time to execute, at [`top queries` page](#top-queries). See also [VictoriaMetrics Monitoring](https://victoriametrics.com/blog/victoriametrics-monitoring/) and [troubleshooting docs](https://docs.victoriametrics.com/Troubleshooting.html). diff --git a/docs/Single-server-VictoriaMetrics.md b/docs/Single-server-VictoriaMetrics.md index d7c0b73f3..ffa2fa2af 100644 --- a/docs/Single-server-VictoriaMetrics.md +++ b/docs/Single-server-VictoriaMetrics.md @@ -376,6 +376,8 @@ See the [example VMUI at VictoriaMetrics playground](https://play.victoriametric * queries with the biggest average execution duration; * queries that took the most summary time for execution. +This information is obtained from the `/api/v1/status/top_queries` HTTP endpoint. + ## Active queries [VMUI](#vmui) provides `active queries` tab, which shows currently execute queries. @@ -385,6 +387,8 @@ It provides the following information per each query: - The duration of the query execution. - The client address, who initiated the query execution. +This information is obtained from the `/api/v1/status/active_queries` HTTP endpoint. + ## Metrics explorer [VMUI](#vmui) provides an ability to explore metrics exported by a particular `job` / `instance` in the following way: @@ -867,7 +871,7 @@ Additionally, VictoriaMetrics provides the following handlers: * `/api/v1/series/count` - returns the total number of time series in the database. Some notes: * the handler scans all the inverted index, so it can be slow if the database contains tens of millions of time series; * the handler may count [deleted time series](#how-to-delete-time-series) additionally to normal time series due to internal implementation restrictions; -* `/api/v1/status/active_queries` - returns a list of currently running queries. +* `/api/v1/status/active_queries` - returns the list of currently running queries. This list is also available at [`active queries` page at VMUI](#active-queries). * `/api/v1/status/top_queries` - returns the following query lists: * the most frequently executed queries - `topByCount` * queries with the biggest average execution duration - `topByAvgDuration` @@ -877,6 +881,8 @@ Additionally, VictoriaMetrics provides the following handlers: For example, request to `/api/v1/status/top_queries?topN=5&maxLifetime=30s` would return up to 5 queries per list, which were executed during the last 30 seconds. VictoriaMetrics tracks the last `-search.queryStats.lastQueriesCount` queries with durations at least `-search.queryStats.minQueryDuration`. + See also [`top queries` page at VMUI](#top-queries). + ### Timestamp formats VictoriaMetrics accepts the following formats for `time`, `start` and `end` query args @@ -1827,9 +1833,9 @@ Graphs on the dashboards contain useful hints - hover the `i` icon in the top le We recommend setting up [alerts](https://github.com/VictoriaMetrics/VictoriaMetrics/tree/master/deployment/docker#alerts) via [vmalert](https://docs.victoriametrics.com/vmalert.html) or via Prometheus. -VictoriaMetrics exposes currently running queries and their execution times at `/api/v1/status/active_queries` page. +VictoriaMetrics exposes currently running queries and their execution times at [`active queries` page](#active-queries). -VictoriaMetrics exposes queries, which take the most time to execute, at `/api/v1/status/top_queries` page. +VictoriaMetrics exposes queries, which take the most time to execute, at [`top queries` page](#top-queries). See also [VictoriaMetrics Monitoring](https://victoriametrics.com/blog/victoriametrics-monitoring/) and [troubleshooting docs](https://docs.victoriametrics.com/Troubleshooting.html).