github-mirrors/VictoriaMetrics
1
0
Fork 0
mirror of https://github.com/VictoriaMetrics/VictoriaMetrics.git synced 2024-11-21 14:44:00 +00:00
Code Issues Projects Releases Packages Wiki Activity

docs: use available_from shortcode for versioning features (#7492)

Browse source 
### 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 <roman@victoriametrics.com>
This commit is contained in:
Roman Khavronenko 2024-11-11 00:54:28 +01:00 committed by GitHub
parent 0f2233aef3
commit 564c309b11
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
5 changed files with 7 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/Cluster-VictoriaMetrics.md
View file

@ -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)._ _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/<suffix>`. `vmselect` can execute {{% available_from "v1.104.0" %}} queries over multiple [tenants](#multitenancy) via special `multitenant` endpoints `http://vmselect:8481/select/multitenant/<suffix>`.
Currently supported endpoints for `<suffix>` are: Currently supported endpoints for `<suffix>` are:
- `/prometheus/api/v1/query` - `/prometheus/api/v1/query`
- `/prometheus/api/v1/query_range` - `/prometheus/api/v1/query_range`

2
docs/README.md
View file

@ -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, 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. 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`. 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). 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 For example, `-downsampling.period='{__name__=~"(node|process)_.*"}:1d:1m` instructs VictoriaMetrics to deduplicate samples older than one day with one minute interval

4
docs/VictoriaLogs/vmalert.md
View file

@ -10,9 +10,7 @@ aliases:
- /VictoriaLogs/vmalert.html - /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/){{% 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)
[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)
and [`/select/logsql/stats_query_range`](https://docs.victoriametrics.com/victorialogs/querying/#querying-log-range-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). 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/). It allows using VictoriaLogs as the datasource in vmalert, creating alerting and recording rules via [LogsQL](https://docs.victoriametrics.com/victorialogs/logsql/).

8
docs/sd_configs.md
View file

@ -1463,9 +1463,7 @@ The list of discovered OpenStack targets is refreshed at the interval, which can
## ovhcloud_sd_configs ## ovhcloud_sd_configs
_Available from [v1.104](https://docs.victoriametrics.com/changelog/#v11040) version._ OVH Cloud SD configuration{{% available_from "v1.104.0" %}} allows retrieving scrape targets from [OVH Cloud VPS](https://www.ovhcloud.com/en/vps/)
OVH Cloud SD configuration 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/). and [OVH Cloud dedicated server](https://ovhcloud.com/en/bare-metal/).
Configuration example: Configuration example:
@ -1549,9 +1547,7 @@ The list of discovered OVH Cloud targets is refreshed at the interval, which can
## puppetdb_sd_configs ## puppetdb_sd_configs
_Available from [v1.106.0](https://docs.victoriametrics.com/changelog/#v11060) version._ PuppetDB SD configuration{{% available_from "v1.106.0" %}} allows retrieving scrape targets from [PuppetDB](https://www.puppet.com/docs/puppetdb/8/overview.html) resources.
PuppetDB SD configuration 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. This SD discovers resources and will create a target for each resource returned by the API.

6
docs/vmagent.md
View file

@ -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) 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`: 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. 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. 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. 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. 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. 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. 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. * 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. This relabeling is used for modifying labels in discovered targets and for dropping unneeded targets.