From b01607e3fb5aa4b895a351f0f0f931a624fdb0c5 Mon Sep 17 00:00:00 2001 From: Aliaksandr Valialkin Date: Sat, 10 Dec 2022 20:49:44 -0800 Subject: [PATCH] docs: clarify that single-node VictoriaMetrics also provides functionality for relabel debugging Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/3407 --- README.md | 6 +++++- app/vmagent/README.md | 12 ++++++++---- docs/README.md | 6 +++++- docs/Single-server-VictoriaMetrics.md | 6 +++++- docs/vmagent.md | 12 ++++++++---- 5 files changed, 31 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 79624e4fb..61c72a714 100644 --- a/README.md +++ b/README.md @@ -1245,7 +1245,11 @@ Example contents for `-relabelConfig` file: regex: true ``` -VictoriaMetrics provides additional relabeling features such as Graphite-style relabeling. See [these docs](https://docs.victoriametrics.com/vmagent.html#relabeling) for more details. +VictoriaMetrics provides additional relabeling features such as Graphite-style relabeling. +See [these docs](https://docs.victoriametrics.com/vmagent.html#relabeling) for more details. + +The relabeling can be debugged at `http://victoriametrics:8428/metric-relabel-debug` page. +See [these docs](https://docs.victoriametrics.com/vmagent.html#relabel-debug) for more details. ## Federation diff --git a/app/vmagent/README.md b/app/vmagent/README.md index 03b09af21..3c994f4af 100644 --- a/app/vmagent/README.md +++ b/app/vmagent/README.md @@ -593,20 +593,24 @@ Additionally, the `action: graphite` relabeling rules usually work much faster t ## Relabel debug -`vmagent` provides the following tools for debugging target-level and metric-level relabeling: +`vmagent` and [single-node VictoriaMetrics](https://docs.victoriametrics.com/Single-server-VictoriaMetrics.html) +provide the following tools for debugging target-level and metric-level relabeling: - Target-level relabeling (e.g. `relabel_configs` section at [scrape_configs](https://docs.victoriametrics.com/sd_configs.html#scrape_configs)) - can be performed by navigating to `http://vmagent:8429/targets` page and clicking the `debug` link at the target, which must be debugged. + can be performed by navigating to `http://vmagent:8429/targets` page (`http://victoriametrics:8428/targets` page for single-node VictoriaMetrics) + and clicking the `debug` link at the target, which must be debugged. The opened page will show step-by-step results for the actual relabeling rules applied to the target labels. The `http://vmagent:8429/targets` page shows only active targets. If you need to understand why some target - is dropped during the relabeling, then navigate to `http://vmagent:8428/service-discovery` page, find the dropped target + is dropped during the relabeling, then navigate to `http://vmagent:8428/service-discovery` page + (`http://victoriametrics:8428/service-discovery` for single-node VictoriaMetrics), find the dropped target and click the `debug` link there. The opened page will show step-by-step results for the actual relabeling rules, - which resulted to target drop. + which result to target drop. - Metric-level relabeling (e.g. `metric_relabel_configs` section at [scrape_configs](https://docs.victoriametrics.com/sd_configs.html#scrape_configs) and all the relabeling, which can be set up via `-relabelConfig`, `-remoteWrite.relabelConfig` and `-remoteWrite.urlRelabelConfig` command-line flags) can be performed by navigating to `http://vmagent:8429/metric-relabel-debug` page + (`http://victoriametrics:8428/metric-relabel-debug` page for single-node VictoriaMetrics) and submitting there relabeling rules together with the metric to be relabeled. The page will show step-by-step results for the entered relabeling rules executed against the entered metric. diff --git a/docs/README.md b/docs/README.md index eedee6b44..579967f79 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1246,7 +1246,11 @@ Example contents for `-relabelConfig` file: regex: true ``` -VictoriaMetrics provides additional relabeling features such as Graphite-style relabeling. See [these docs](https://docs.victoriametrics.com/vmagent.html#relabeling) for more details. +VictoriaMetrics provides additional relabeling features such as Graphite-style relabeling. +See [these docs](https://docs.victoriametrics.com/vmagent.html#relabeling) for more details. + +The relabeling can be debugged at `http://victoriametrics:8428/metric-relabel-debug` page. +See [these docs](https://docs.victoriametrics.com/vmagent.html#relabel-debug) for more details. ## Federation diff --git a/docs/Single-server-VictoriaMetrics.md b/docs/Single-server-VictoriaMetrics.md index 43f8f0fe6..8039e6465 100644 --- a/docs/Single-server-VictoriaMetrics.md +++ b/docs/Single-server-VictoriaMetrics.md @@ -1249,7 +1249,11 @@ Example contents for `-relabelConfig` file: regex: true ``` -VictoriaMetrics provides additional relabeling features such as Graphite-style relabeling. See [these docs](https://docs.victoriametrics.com/vmagent.html#relabeling) for more details. +VictoriaMetrics provides additional relabeling features such as Graphite-style relabeling. +See [these docs](https://docs.victoriametrics.com/vmagent.html#relabeling) for more details. + +The relabeling can be debugged at `http://victoriametrics:8428/metric-relabel-debug` page. +See [these docs](https://docs.victoriametrics.com/vmagent.html#relabel-debug) for more details. ## Federation diff --git a/docs/vmagent.md b/docs/vmagent.md index c1558e594..8340d4275 100644 --- a/docs/vmagent.md +++ b/docs/vmagent.md @@ -597,20 +597,24 @@ Additionally, the `action: graphite` relabeling rules usually work much faster t ## Relabel debug -`vmagent` provides the following tools for debugging target-level and metric-level relabeling: +`vmagent` and [single-node VictoriaMetrics](https://docs.victoriametrics.com/Single-server-VictoriaMetrics.html) +provide the following tools for debugging target-level and metric-level relabeling: - Target-level relabeling (e.g. `relabel_configs` section at [scrape_configs](https://docs.victoriametrics.com/sd_configs.html#scrape_configs)) - can be performed by navigating to `http://vmagent:8429/targets` page and clicking the `debug` link at the target, which must be debugged. + can be performed by navigating to `http://vmagent:8429/targets` page (`http://victoriametrics:8428/targets` page for single-node VictoriaMetrics) + and clicking the `debug` link at the target, which must be debugged. The opened page will show step-by-step results for the actual relabeling rules applied to the target labels. The `http://vmagent:8429/targets` page shows only active targets. If you need to understand why some target - is dropped during the relabeling, then navigate to `http://vmagent:8428/service-discovery` page, find the dropped target + is dropped during the relabeling, then navigate to `http://vmagent:8428/service-discovery` page + (`http://victoriametrics:8428/service-discovery` for single-node VictoriaMetrics), find the dropped target and click the `debug` link there. The opened page will show step-by-step results for the actual relabeling rules, - which resulted to target drop. + which result to target drop. - Metric-level relabeling (e.g. `metric_relabel_configs` section at [scrape_configs](https://docs.victoriametrics.com/sd_configs.html#scrape_configs) and all the relabeling, which can be set up via `-relabelConfig`, `-remoteWrite.relabelConfig` and `-remoteWrite.urlRelabelConfig` command-line flags) can be performed by navigating to `http://vmagent:8429/metric-relabel-debug` page + (`http://victoriametrics:8428/metric-relabel-debug` page for single-node VictoriaMetrics) and submitting there relabeling rules together with the metric to be relabeled. The page will show step-by-step results for the entered relabeling rules executed against the entered metric.