From 564c309b1153fa311abee0c33b3ace5198b480e9 Mon Sep 17 00:00:00 2001 From: Roman Khavronenko Date: Mon, 11 Nov 2024 00:54:28 +0100 Subject: [PATCH] docs: use `available_from` shortcode for versioning features (#7492) ### Describe Your Changes Please provide a brief description of the changes you made. Be as specific as possible to help others understand the purpose and impact of your modifications. ### Checklist The following checks are **mandatory**: - [ ] My change adheres [VictoriaMetrics contributing guidelines](https://docs.victoriametrics.com/contributing/). Signed-off-by: hagen1778 --- docs/Cluster-VictoriaMetrics.md | 2 +- docs/README.md | 2 +- docs/VictoriaLogs/vmalert.md | 4 +--- docs/sd_configs.md | 8 ++------ docs/vmagent.md | 6 ++---- 5 files changed, 7 insertions(+), 15 deletions(-) diff --git a/docs/Cluster-VictoriaMetrics.md b/docs/Cluster-VictoriaMetrics.md index 8e460a2e4..992973bd7 100644 --- a/docs/Cluster-VictoriaMetrics.md +++ b/docs/Cluster-VictoriaMetrics.md @@ -116,7 +116,7 @@ such as [Graphite](https://docs.victoriametrics.com/#how-to-send-data-from-graph _For better performance prefer specifying [tenants in read URL](https://docs.victoriametrics.com/cluster-victoriametrics/#url-format)._ -`vmselect` can execute queries over multiple [tenants](#multitenancy) {{% available_from "v1.104.0" %}} via special `multitenant` endpoints `http://vmselect:8481/select/multitenant/`. +`vmselect` can execute {{% available_from "v1.104.0" %}} queries over multiple [tenants](#multitenancy) via special `multitenant` endpoints `http://vmselect:8481/select/multitenant/`. Currently supported endpoints for `` are: - `/prometheus/api/v1/query` - `/prometheus/api/v1/query_range` diff --git a/docs/README.md b/docs/README.md index 307b3c3cf..333b85cf0 100644 --- a/docs/README.md +++ b/docs/README.md @@ -2071,7 +2071,7 @@ The `-downsampling.period` command-line flag can be specified multiple times in For example, `-downsampling.period=30d:5m,180d:1h` instructs leaving the last sample per each 5-minute interval for samples older than 30 days, while leaving the last sample per each 1-hour interval for samples older than 180 days. -VictoriaMetrics supports (_available from [v1.100.0](https://docs.victoriametrics.com/changelog/#v11000)_) configuring independent downsampling per different sets of [time series](https://docs.victoriametrics.com/keyconcepts/#time-series) +VictoriaMetrics supports{{% available_from "v1.100.0" %}} configuring independent downsampling per different sets of [time series](https://docs.victoriametrics.com/keyconcepts/#time-series) via `-downsampling.period=filter:offset:interval` syntax. In this case the given `offset:interval` downsampling is applied only to time series matching the given `filter`. The `filter` can contain arbitrary [series filter](https://docs.victoriametrics.com/keyconcepts/#filtering). For example, `-downsampling.period='{__name__=~"(node|process)_.*"}:1d:1m` instructs VictoriaMetrics to deduplicate samples older than one day with one minute interval diff --git a/docs/VictoriaLogs/vmalert.md b/docs/VictoriaLogs/vmalert.md index 89b26fb0e..0654cec22 100644 --- a/docs/VictoriaLogs/vmalert.md +++ b/docs/VictoriaLogs/vmalert.md @@ -10,9 +10,7 @@ aliases: - /VictoriaLogs/vmalert.html --- -_Available from [v1.106.0](https://docs.victoriametrics.com/changelog/#v11060) vmalert version and [v0.36.0](https://docs.victoriametrics.com/victorialogs/changelog/#v0360) VictoriaLogs version._ - -[vmalert](https://docs.victoriametrics.com/vmalert/) integrates with VictoriaLogs via stats APIs [`/select/logsql/stats_query`](https://docs.victoriametrics.com/victorialogs/querying/#querying-log-stats) +[vmalert](https://docs.victoriametrics.com/vmalert/){{% available_from "v1.106.0" %}} integrates with VictoriaLogs {{% available_from "v0.36.0" "logs" %}} via stats APIs [`/select/logsql/stats_query`](https://docs.victoriametrics.com/victorialogs/querying/#querying-log-stats) and [`/select/logsql/stats_query_range`](https://docs.victoriametrics.com/victorialogs/querying/#querying-log-range-stats). These endpoints return the log stats in a format compatible with [Prometheus querying API](https://prometheus.io/docs/prometheus/latest/querying/api/#instant-queries). It allows using VictoriaLogs as the datasource in vmalert, creating alerting and recording rules via [LogsQL](https://docs.victoriametrics.com/victorialogs/logsql/). diff --git a/docs/sd_configs.md b/docs/sd_configs.md index 90ac6550d..29572ddc3 100644 --- a/docs/sd_configs.md +++ b/docs/sd_configs.md @@ -1463,9 +1463,7 @@ The list of discovered OpenStack targets is refreshed at the interval, which can ## ovhcloud_sd_configs -_Available from [v1.104](https://docs.victoriametrics.com/changelog/#v11040) version._ - -OVH Cloud SD configuration allows retrieving scrape targets from [OVH Cloud VPS](https://www.ovhcloud.com/en/vps/) +OVH Cloud SD configuration{{% available_from "v1.104.0" %}} allows retrieving scrape targets from [OVH Cloud VPS](https://www.ovhcloud.com/en/vps/) and [OVH Cloud dedicated server](https://ovhcloud.com/en/bare-metal/). Configuration example: @@ -1549,9 +1547,7 @@ The list of discovered OVH Cloud targets is refreshed at the interval, which can ## puppetdb_sd_configs -_Available from [v1.106.0](https://docs.victoriametrics.com/changelog/#v11060) version._ - -PuppetDB SD configuration allows retrieving scrape targets from [PuppetDB](https://www.puppet.com/docs/puppetdb/8/overview.html) resources. +PuppetDB SD configuration{{% available_from "v1.106.0" %}} allows retrieving scrape targets from [PuppetDB](https://www.puppet.com/docs/puppetdb/8/overview.html) resources. This SD discovers resources and will create a target for each resource returned by the API. diff --git a/docs/vmagent.md b/docs/vmagent.md index 475333d63..2ecb7c524 100644 --- a/docs/vmagent.md +++ b/docs/vmagent.md @@ -575,17 +575,15 @@ generated metrics. But they still can be relabeled via `-remoteWrite.relabelConf VictoriaMetrics components support [Prometheus-compatible relabeling](https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config) with [additional enhancements](#relabeling-enhancements). The relabeling can be defined in the following places processed by `vmagent`: -* At the `global -> relabel_configs` section in `-promscrape.config` file. +* At the `global -> relabel_configs` section in `-promscrape.config` file{{% available_from "v1.106.0" %}}. This relabeling is used for modifying labels in discovered targets and for dropping unneeded targets. Configuration from global section will be prepended to the `relabel_config` of targets from `scrape_config` section. See [relabeling cookbook](https://docs.victoriametrics.com/relabeling/) for details. -_Available from [v1.106.0](https://docs.victoriametrics.com/changelog/#v11060) version._ -* At the `global -> metric_relabel_configs` section in `-promscrape.config` file. +* At the `global -> metric_relabel_configs` section in `-promscrape.config` file{{% available_from "v1.106.0" %}}. This relabeling is used for modifying labels in scraped metrics and for dropping unneeded metrics. Configuration from global section will be prepended to the `metric_relabel_config` of targets from `scrape_config` section. See [relabeling cookbook](https://docs.victoriametrics.com/relabeling/) for details. -_Available from [v1.106.0](https://docs.victoriametrics.com/changelog/#v11060) version._ * At the `scrape_config -> relabel_configs` section in `-promscrape.config` file. This relabeling is used for modifying labels in discovered targets and for dropping unneeded targets.