Kiu/VictoriaMetrics
Kiu/VictoriaMetrics
1
0
Fork 0
mirror of https://github.com/VictoriaMetrics/VictoriaMetrics.git synced 2024-11-23 12:31:07 +01:00
Code Issues Actions 8 Packages Projects Releases Wiki Activity

docs/sd_configs.md: document __scrape_timeout__, __scrape_interval__ and __series_limit__ labels

Browse Source
This commit is contained in:
Aliaksandr Valialkin 2022-10-09 15:05:06 +03:00
parent 50f5eae0e0
commit 921918cb49
No known key found for this signature in database
GPG Key ID: A72BEC6CD3D0DED1
2 changed files with 14 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/relabeling.md
View File

@ -249,7 +249,7 @@ See also [useful tips for target relabeling](#useful-tips-for-target-relabeling)
Single-node VictoriaMetrics and [vmagent](https://docs.victoriametrics.com/vmagent.html) automatically add `instance` and `job` labels per each discovered target: Single-node VictoriaMetrics and [vmagent](https://docs.victoriametrics.com/vmagent.html) automatically add `instance` and `job` labels per each discovered target:
* The `job` label is set to `job_name` value specified in the corresponding [scrape_config](https://docs.victoriametrics.com/sd_configs.html#scrape_configs). * The `job` label is set to `job_name` value specified in the corresponding [scrape_config](https://docs.victoriametrics.com/sd_configs.html#scrape_configs).
* The `instance` label is set to the host:port part of `__address__` label value after target-level relabeling. * The `instance` label is set to the `host:port` part of `__address__` label value after target-level relabeling.
The `__address__` label value is automatically set to the most suitable value depending The `__address__` label value is automatically set to the most suitable value depending
on the used [service discovery type](https://docs.victoriametrics.com/sd_configs.html#supported-service-discovery-configs). on the used [service discovery type](https://docs.victoriametrics.com/sd_configs.html#supported-service-discovery-configs).
The `__address__` label can be overriden during relabeling - see [these docs](#how-to-modify-scrape-urls-in-targets). The `__address__` label can be overriden during relabeling - see [these docs](#how-to-modify-scrape-urls-in-targets).
@ -284,7 +284,7 @@ URLs for scrape targets are composed of the following parts:
just update the `__address__` label during relabeling to the needed value. just update the `__address__` label during relabeling to the needed value.
The port part is optional. If it is missing, then it is automatically set either to `80` or `443` depending The port part is optional. If it is missing, then it is automatically set either to `80` or `443` depending
on the used scheme (`http` or `https`). on the used scheme (`http` or `https`).
The host:port part from the final `__address__` label is automatically set to `instance` label unless the `instance` The `host:port` part from the final `__address__` label is automatically set to `instance` label unless the `instance`
label is explicitly set during relabeling. label is explicitly set during relabeling.
The `__address__` label can contain the full scrape url, e.g. `http://host:port/metrics/path?query_args`. The `__address__` label can contain the full scrape url, e.g. `http://host:port/metrics/path?query_args`.
In this case the `__scheme__` and `__metrics_path__` labels are ignored. In this case the `__scheme__` and `__metrics_path__` labels are ignored.

12
docs/sd_configs.md
View File

@ -1089,6 +1089,9 @@ scrape_configs:
# Example values: # Example values:
# - "30s" - 30 seconds # - "30s" - 30 seconds
# - "2m" - 2 minutes # - "2m" - 2 minutes
# The scrape_interval can be set on a per-target basis by specifying `__scrape_interval__`
# label during target relabeling phase.
# See https://docs.victoriametrics.com/vmagent.html#relabeling
# scrape_interval: <duration> # scrape_interval: <duration>
# scrape_timeout is an optional timeout when scraping the targets. # scrape_timeout is an optional timeout when scraping the targets.
@ -1100,6 +1103,9 @@ scrape_configs:
# - "30s" - 30 seconds # - "30s" - 30 seconds
# - "2m" - 2 minutes # - "2m" - 2 minutes
# The `scrape_timeout` cannot exceed the `scrape_interval`. # The `scrape_timeout` cannot exceed the `scrape_interval`.
# The scrape_timeout can be set on a per-target basis by specifying `__scrape_timeout__`
# label during target relabeling phase.
# See https://docs.victoriametrics.com/vmagent.html#relabeling
# scrape_timeout: <duration> # scrape_timeout: <duration>
# metrics_path is the path to fetch metrics from targets. # metrics_path is the path to fetch metrics from targets.
@ -1190,6 +1196,9 @@ scrape_configs:
# stream_parse allows enabling stream parsing mode when scraping targets. # stream_parse allows enabling stream parsing mode when scraping targets.
# By default stream parsing mode is disabled for targets which return up to a few thosands samples. # By default stream parsing mode is disabled for targets which return up to a few thosands samples.
# See https://docs.victoriametrics.com/vmagent.html#stream-parsing-mode . # See https://docs.victoriametrics.com/vmagent.html#stream-parsing-mode .
# The stream_parse can be set on a per-target basis by specifying `__stream_parse__`
# label during target relabeling phase.
# See https://docs.victoriametrics.com/vmagent.html#relabeling
# stream_parse: <boolean> # stream_parse: <boolean>
# scrape_align_interval allows aligning scrapes to the given interval. # scrape_align_interval allows aligning scrapes to the given interval.
@ -1210,6 +1219,9 @@ scrape_configs:
# a single target can expose during all the scrapes. # a single target can expose during all the scrapes.
# By default there is no limit on the number of exposed series. # By default there is no limit on the number of exposed series.
# See https://docs.victoriametrics.com/vmagent.html#cardinality-limiter . # See https://docs.victoriametrics.com/vmagent.html#cardinality-limiter .
# The series_limit can be set on a per-target basis by specifying `__series_limit__`
# label during target relabeling phase.
# See https://docs.victoriametrics.com/vmagent.html#relabeling
# series_limit: ... # series_limit: ...
# no_stale_markers allows disabling staleness tracking. # no_stale_markers allows disabling staleness tracking.