From 2b0555929305adbecf9a7216bb3f353426ed2bcf Mon Sep 17 00:00:00 2001 From: hagen1778 Date: Tue, 19 Mar 2024 13:31:14 +0100 Subject: [PATCH] docs: mention Query Analyzer in docs Signed-off-by: hagen1778 (cherry picked from commit 21d9393c9e71dc19537bdcb1ccb1070acd8589ca) Signed-off-by: hagen1778 --- docs/README.md | 5 +++++ docs/Single-server-VictoriaMetrics.md | 5 +++++ docs/Troubleshooting.md | 2 ++ 3 files changed, 12 insertions(+) diff --git a/docs/README.md b/docs/README.md index 842de3ffff..c0bf35d536 100644 --- a/docs/README.md +++ b/docs/README.md @@ -379,6 +379,7 @@ The UI allows exploring query results via graphs and tables. It also provides th - [Active queries](#active-queries) - shows currently executed queries; - Tools: - [Trace analyzer](#query-tracing) - playground for loading query traces in JSON format; + - [Query analyzer](#query-tracing) - playground for loading query results and traces in JSON format. See `Export query` button below; - [WITH expressions playground](https://play.victoriametrics.com/select/accounting/1/6a716b0f-38bc-4856-90ce-448fd713e3fe/prometheus/graph/#/expand-with-exprs) - test how WITH expressions work; - [Metric relabel debugger](https://play.victoriametrics.com/select/accounting/1/6a716b0f-38bc-4856-90ce-448fd713e3fe/prometheus/graph/#/relabeling) - playground for [relabeling](#relabeling) configs. @@ -414,6 +415,10 @@ Graphs for a particular query can be temporarily hidden by clicking the `eye` ic When the `eye` icon is clicked while holding the `ctrl` key, then query results for the rest of queries become hidden except of the current query results. +VMUI allows sharing query and [trace](https://docs.victoriametrics.com/#query-tracing) results by clicking on +`Export query` button in top right corner of the graph area. The query and trace will be exported as a file that later +can be loaded in VMUI via `Query Analyzer` tool. + See the [example VMUI at VictoriaMetrics playground](https://play.victoriametrics.com/select/accounting/1/6a716b0f-38bc-4856-90ce-448fd713e3fe/prometheus/graph/?g0.expr=100%20*%20sum(rate(process_cpu_seconds_total))%20by%20(job)&g0.range_input=1d). ## Top queries diff --git a/docs/Single-server-VictoriaMetrics.md b/docs/Single-server-VictoriaMetrics.md index 1089860a35..aec8156644 100644 --- a/docs/Single-server-VictoriaMetrics.md +++ b/docs/Single-server-VictoriaMetrics.md @@ -387,6 +387,7 @@ The UI allows exploring query results via graphs and tables. It also provides th - [Active queries](#active-queries) - shows currently executed queries; - Tools: - [Trace analyzer](#query-tracing) - playground for loading query traces in JSON format; + - [Query analyzer](#query-tracing) - playground for loading query results and traces in JSON format. See `Export query` button below; - [WITH expressions playground](https://play.victoriametrics.com/select/accounting/1/6a716b0f-38bc-4856-90ce-448fd713e3fe/prometheus/graph/#/expand-with-exprs) - test how WITH expressions work; - [Metric relabel debugger](https://play.victoriametrics.com/select/accounting/1/6a716b0f-38bc-4856-90ce-448fd713e3fe/prometheus/graph/#/relabeling) - playground for [relabeling](#relabeling) configs. @@ -422,6 +423,10 @@ Graphs for a particular query can be temporarily hidden by clicking the `eye` ic When the `eye` icon is clicked while holding the `ctrl` key, then query results for the rest of queries become hidden except of the current query results. +VMUI allows sharing query and [trace](https://docs.victoriametrics.com/#query-tracing) results by clicking on +`Export query` button in top right corner of the graph area. The query and trace will be exported as a file that later +can be loaded in VMUI via `Query Analyzer` tool. + See the [example VMUI at VictoriaMetrics playground](https://play.victoriametrics.com/select/accounting/1/6a716b0f-38bc-4856-90ce-448fd713e3fe/prometheus/graph/?g0.expr=100%20*%20sum(rate(process_cpu_seconds_total))%20by%20(job)&g0.range_input=1d). ## Top queries diff --git a/docs/Troubleshooting.md b/docs/Troubleshooting.md index 815238803f..071ccc41be 100644 --- a/docs/Troubleshooting.md +++ b/docs/Troubleshooting.md @@ -196,6 +196,8 @@ If you see unexpected or unreliable query results from VictoriaMetrics, then try 1. If the steps above didn't help identifying the root cause of unexpected query results, then [file a bugreport](https://github.com/VictoriaMetrics/VictoriaMetrics/issues/new) with details on how to reproduce the issue. + Instead of sharing screenshots in the issue, consider sharing query and [trace](https://docs.victoriametrics.com/#query-tracing) + results in [VMUI](https://docs.victoriametrics.com/#vmui) by clicking on `Export query` button in top right corner of the graph area. ## Slow data ingestion