From ad2d079ba5bc02dcb79a57738afe14bc50c5e9c5 Mon Sep 17 00:00:00 2001 From: Roman Khavronenko Date: Fri, 12 May 2023 10:51:44 +0200 Subject: [PATCH] docs: update docs about VMUI pages (#4305) Signed-off-by: hagen1778 --- README.md | 12 ++++++++---- docs/CHANGELOG.md | 2 +- docs/README.md | 12 ++++++++---- docs/Single-server-VictoriaMetrics.md | 12 ++++++++---- 4 files changed, 25 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 2b95f2958..06ab22c34 100644 --- a/README.md +++ b/README.md @@ -309,10 +309,14 @@ Prometheus doesn't drop data during VictoriaMetrics restart. See [this article]( VictoriaMetrics provides UI for query troubleshooting and exploration. The UI is available at `http://victoriametrics:8428/vmui`. The UI allows exploring query results via graphs and tables. It also provides the following features: -- [metrics explorer](#metrics-explorer) -- [cardinality explorer](#cardinality-explorer) -- [query tracer](#query-tracing) -- [top queries explorer](#top-queries) +- Explore: + - [Metrics explorer](#metrics-explorer) - automatically builds graphs for selected metrics; + - [Cardinality explorer](#cardinality-explorer) - stats about existing metrics in TSDB; + - [Top queries](#top-queries) - shows most frequently executed queries; +- Tools: + - [Trace analyzer](#query-tracing) - playground for loading query traces in JSON format; + - [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](#relabeling) - playground for [relabeling](https://docs.victoriametrics.com/#relabeling) configs. VMUI automatically switches from graph view to heatmap view when the query returns [histogram](https://docs.victoriametrics.com/keyConcepts.html#histogram) buckets (both [Prometheus histograms](https://prometheus.io/docs/concepts/metric_types/#histogram) diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md index 4cf73ec0b..c721494be 100644 --- a/docs/CHANGELOG.md +++ b/docs/CHANGELOG.md @@ -74,7 +74,7 @@ The following tip changes can be tested by building VictoriaMetrics components f * BUGFIX: [vmctl](https://docs.victoriametrics.com/vmctl.html): fix performance issue when migrating data from VictoriaMetrics according to [these docs](https://docs.victoriametrics.com/vmctl.html#migrating-data-from-victoriametrics). Add the ability to speed up the data migration via `--vm-native-disable-retries` command-line flag. See [this issue](https://github.com/VictoriaMetrics/VictoriaMetrics/issues/4092). * BUGFIX: [stream aggregation](https://docs.victoriametrics.com/stream-aggregation.html): fix bug with duplicated labels during stream aggregation via single-node VictoriaMetrics. See [this issue](https://github.com/VictoriaMetrics/VictoriaMetrics/issues/4277). * BUGFIX: [csvimport](https://docs.victoriametrics.com/#how-to-import-csv-data): properly parse [csv line](https://docs.victoriametrics.com/#how-to-import-csv-data) when value in the last column is empty. See [this issue](https://github.com/VictoriaMetrics/VictoriaMetrics/issues/4048). -* BUGFIX: [relabeling](https://docs.victoriametrics.com/relabeling.html): properly validate labels input on Metric Relabel Debug page in VMUI. See [this issue](https://github.com/VictoriaMetrics/VictoriaMetrics/issues/4284). +* BUGFIX: [relabeling](https://docs.victoriametrics.com/relabeling.html): properly validate labels input on Metric Relabel Debug page in [VMUI](https://docs.victoriametrics.com/#vmui). See [this issue](https://github.com/VictoriaMetrics/VictoriaMetrics/issues/4284). ## [v1.90.0](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/tag/v1.90.0) diff --git a/docs/README.md b/docs/README.md index 50d81bed4..136512dad 100644 --- a/docs/README.md +++ b/docs/README.md @@ -310,10 +310,14 @@ Prometheus doesn't drop data during VictoriaMetrics restart. See [this article]( VictoriaMetrics provides UI for query troubleshooting and exploration. The UI is available at `http://victoriametrics:8428/vmui`. The UI allows exploring query results via graphs and tables. It also provides the following features: -- [metrics explorer](#metrics-explorer) -- [cardinality explorer](#cardinality-explorer) -- [query tracer](#query-tracing) -- [top queries explorer](#top-queries) +- Explore: + - [Metrics explorer](#metrics-explorer) - automatically builds graphs for selected metrics; + - [Cardinality explorer](#cardinality-explorer) - stats about existing metrics in TSDB; + - [Top queries](#top-queries) - shows most frequently executed queries; +- Tools: + - [Trace analyzer](#query-tracing) - playground for loading query traces in JSON format; + - [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](#relabeling) - playground for [relabeling](https://docs.victoriametrics.com/#relabeling) configs. VMUI automatically switches from graph view to heatmap view when the query returns [histogram](https://docs.victoriametrics.com/keyConcepts.html#histogram) buckets (both [Prometheus histograms](https://prometheus.io/docs/concepts/metric_types/#histogram) diff --git a/docs/Single-server-VictoriaMetrics.md b/docs/Single-server-VictoriaMetrics.md index dea0e6b03..1a166e9e6 100644 --- a/docs/Single-server-VictoriaMetrics.md +++ b/docs/Single-server-VictoriaMetrics.md @@ -313,10 +313,14 @@ Prometheus doesn't drop data during VictoriaMetrics restart. See [this article]( VictoriaMetrics provides UI for query troubleshooting and exploration. The UI is available at `http://victoriametrics:8428/vmui`. The UI allows exploring query results via graphs and tables. It also provides the following features: -- [metrics explorer](#metrics-explorer) -- [cardinality explorer](#cardinality-explorer) -- [query tracer](#query-tracing) -- [top queries explorer](#top-queries) +- Explore: + - [Metrics explorer](#metrics-explorer) - automatically builds graphs for selected metrics; + - [Cardinality explorer](#cardinality-explorer) - stats about existing metrics in TSDB; + - [Top queries](#top-queries) - shows most frequently executed queries; +- Tools: + - [Trace analyzer](#query-tracing) - playground for loading query traces in JSON format; + - [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](#relabeling) - playground for [relabeling](https://docs.victoriametrics.com/#relabeling) configs. VMUI automatically switches from graph view to heatmap view when the query returns [histogram](https://docs.victoriametrics.com/keyConcepts.html#histogram) buckets (both [Prometheus histograms](https://prometheus.io/docs/concepts/metric_types/#histogram)