mudhorn/prometheus
1
0
Fork 0
mirror of https://github.com/prometheus/prometheus.git synced 2024-11-14 01:24:04 -08:00
Code Issues Actions 4 Packages Projects Releases Wiki Activity
prometheus/docs/configuration/configuration.md

2842 lines
110 KiB
Markdown
Raw Normal View History

Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
---
title: Configuration
Consolidate configuration and rules docs in docs/configuration/
2017-10-27 00:47:38 -07:00
sort_rank: 1
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
---
# Configuration
Prometheus is configured via command-line flags and a configuration file. While
the command-line flags configure immutable system parameters (such as storage
locations, amount of data to keep on disk and in memory, etc.), the
configuration file defines everything related to scraping [jobs and their
Added another full link to the configuration docs (#3553)
2017-12-07 00:31:15 -08:00
instances](https://prometheus.io/docs/concepts/jobs_instances/), as well as
Consolidate configuration and rules docs in docs/configuration/
2017-10-27 00:47:38 -07:00
which [rule files to load](recording_rules.md#configuring-rules).
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
docs: Fix minor issues with the docs. (#3389) Signed-off-by: Goutham Veeramachaneni <cs14btech11014@iith.ac.in>
2017-11-01 08:35:50 -07:00
To view all available command-line flags, run `./prometheus -h`.
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
Prometheus can reload its configuration at runtime. If the new configuration
is not well-formed, the changes will not be applied.
A configuration reload is triggered by sending a `SIGHUP` to the Prometheus process or
docs: Fix minor issues with the docs. (#3389) Signed-off-by: Goutham Veeramachaneni <cs14btech11014@iith.ac.in>
2017-11-01 08:35:50 -07:00
sending a HTTP POST request to the `/-/reload` endpoint (when the `--web.enable-lifecycle` flag is enabled).
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
This will also reload any configured rule files.
## Configuration file
docs: Fix minor issues with the docs. (#3389) Signed-off-by: Goutham Veeramachaneni <cs14btech11014@iith.ac.in>
2017-11-01 08:35:50 -07:00
To specify which configuration file to load, use the `--config.file` flag.
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
Replacing 'HTTP' by 'HTTPS' for securing links (#5252) Currently, when we access the modified pages with **HTTP**, it is redirected to **HTTPS** automatically. So this commit aims to replace **HTTP** to **HTTPs** for security. Co-Authored-By: Nguyen Phuong An <AnNP@vn.fujitsu.com> Signed-off-by: Kim Bao Long <longkb@vn.fujitsu.com>
2019-02-22 05:33:02 -08:00
The file is written in [YAML format](https://en.wikipedia.org/wiki/YAML),
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
defined by the scheme described below.
Brackets indicate that a parameter is optional. For non-list parameters the
value is set to the specified default.
Generic placeholders are defined as follows:
* `<boolean>`: a boolean that can take the values `true` or `false`
Human-friendly durations in PromQL (#7713) * Add support for user-friendly durations Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2020-08-04 12:12:41 -07:00
* `<duration>`: a duration matching the regular expression `((([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?|0)`, e.g. `1d`, `1h30m`, `5m`, `10s`
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
* `<filename>`: a valid path in the current working directory
* `<host>`: a valid string consisting of a hostname or IP followed by an optional port number
Docs: fix types (#7508) I have batched a bunch of fixes around types in the documentation. Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2020-07-02 14:27:14 -07:00
* `<int>`: an integer value
* `<labelname>`: a string matching the regular expression `[a-zA-Z_][a-zA-Z0-9_]*`
* `<labelvalue>`: a string of unicode characters
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
* `<path>`: a valid URL path
* `<scheme>`: a string that can take the values `http` or `https`
* `<secret>`: a regular string that is a secret, such as a password
Docs: fix types (#7508) I have batched a bunch of fixes around types in the documentation. Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2020-07-02 14:27:14 -07:00
* `<string>`: a regular string
Mark body_size_limit as experimental. (#8886) Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2021-06-02 08:32:08 -07:00
* `<size>`: a size in bytes, e.g. `512MB`. A unit is required. Supported units: B, KB, MB, GB, TB, PB, EB.
docs: Document new recording rule format (#3378)
2017-11-01 05:58:32 -07:00
* `<tmpl_string>`: a string which is template-expanded before usage
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
The other placeholders are specified separately.
A valid example file can be found [here](/config/testdata/conf.good.yml).
The global configuration specifies parameters that are valid in all other configuration
contexts. They also serve as defaults for other configuration sections.
```yaml
global:
# How frequently to scrape targets by default.
[ scrape_interval: <duration> | default = 1m ]
# How long until a scrape request times out.
[ scrape_timeout: <duration> | default = 10s ]
# How frequently to evaluate rules.
[ evaluation_interval: <duration> | default = 1m ]
# The labels to add to any time series or alerts when communicating with
# external systems (federation, remote storage, Alertmanager).
external_labels:
[ <labelname>: <labelvalue> ... ]
Add query log (#6520) * Add query log, make stats logged in JSON like in the API Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2020-01-08 05:28:43 -08:00
# File to which PromQL queries are logged.
# Reloading the configuration will reopen the file.
[ query_log_file: <string> ]
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
# Rule files specifies a list of globs. Rules and alerts are read from
# all matching files.
rule_files:
[ - <filepath_glob> ... ]
# A list of scrape configurations.
scrape_configs:
[ - <scrape_config> ... ]
# Alerting specifies settings related to the Alertmanager.
alerting:
alert_relabel_configs:
[ - <relabel_config> ... ]
alertmanagers:
[ - <alertmanager_config> ... ]
Add 2.0 stability guarantees (#3484) As discussed generally consider SDs as unstable, as realistically they are never going to be. Drop the words "experimental/beta" from most places in the docs, as users are getting the wrong impression from this.
2017-12-14 04:54:32 -08:00
# Settings related to the remote write feature.
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
remote_write:
[ - <remote_write> ... ]
Add 2.0 stability guarantees (#3484) As discussed generally consider SDs as unstable, as realistically they are never going to be. Drop the words "experimental/beta" from most places in the docs, as users are getting the wrong impression from this.
2017-12-14 04:54:32 -08:00
# Settings related to the remote read feature.
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
remote_read:
[ - <remote_read> ... ]
```
### `<scrape_config>`
A `scrape_config` section specifies a set of targets and parameters describing how
to scrape them. In the general case, one scrape configuration specifies a single
job. In advanced configurations, this may change.
Targets may be statically configured via the `static_configs` parameter or
dynamically discovered using one of the supported service-discovery mechanisms.
Additionally, `relabel_configs` allow advanced modifications to any
target and its labels before scraping.
```yaml
# The job name assigned to scraped metrics by default.
job_name: <job_name>
# How frequently to scrape targets from this job.
[ scrape_interval: <duration> | default = <global_config.scrape_interval> ]
# Per-scrape timeout when scraping this job.
[ scrape_timeout: <duration> | default = <global_config.scrape_timeout> ]
# The HTTP resource path on which to fetch metrics from targets.
[ metrics_path: <path> | default = /metrics ]
# honor_labels controls how Prometheus handles conflicts between labels that are
# already present in scraped data and labels that Prometheus would attach
# server-side ("job" and "instance" labels, manually configured target
# labels, and labels generated by service discovery implementations).
#
# If honor_labels is set to "true", label conflicts are resolved by keeping label
# values from the scraped data and ignoring the conflicting server-side labels.
#
# If honor_labels is set to "false", label conflicts are resolved by renaming
# conflicting labels in the scraped data to "exported_<original-label>" (for
# example "exported_instance", "exported_job") and then attaching server-side
Clarifying honor_labels documentation Previously, the wording could be misunderstood as setting honor_labels to "false" for federation. This also adds scraping the Pushgateway as a typical use case for honor_labels=true. Signed-off-by: beorn7 <beorn@grafana.com>
2019-07-02 04:23:20 -07:00
# labels.
#
# Setting honor_labels to "true" is useful for use cases such as federation and
# scraping the Pushgateway, where all labels specified in the target should be
# preserved.
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
#
# Note that any globally configured "external_labels" are unaffected by this
# setting. In communication with external systems, they are always applied only
# when a time series does not have a given label yet and are ignored otherwise.
[ honor_labels: <boolean> | default = false ]
Add honor_timestamps (#5304) Fixes #5302 Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2019-03-15 03:04:15 -07:00
# honor_timestamps controls whether Prometheus respects the timestamps present
# in scraped data.
#
# If honor_timestamps is set to "true", the timestamps of the metrics exposed
# by the target will be used.
#
# If honor_timestamps is set to "false", the timestamps of the metrics exposed
# by the target will be ignored.
[ honor_timestamps: <boolean> | default = true ]
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
# Configures the protocol scheme used for requests.
[ scheme: <scheme> | default = http ]
# Optional HTTP URL parameters.
params:
[ <string>: [<string>, ...] ]
# Sets the `Authorization` header on every scrape request with the
# configured username and password.
support reading basic_auth password_file for HTTP basic auth (#4077) Issue: https://github.com/prometheus/prometheus/issues/4076 Signed-off-by: Adam Shannon <adamkshannon@gmail.com>
2018-04-25 10:19:06 -07:00
# password and password_file are mutually exclusive.
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
basic_auth:
[ username: <string> ]
[ password: <secret> ]
support reading basic_auth password_file for HTTP basic auth (#4077) Issue: https://github.com/prometheus/prometheus/issues/4076 Signed-off-by: Adam Shannon <adamkshannon@gmail.com>
2018-04-25 10:19:06 -07:00
[ password_file: <string> ]
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
# Sets the `Authorization` header on every scrape request with
Update common to support credentials type Most of the backwards compat tests is done in common. Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2021-02-18 14:14:49 -08:00
# the configured credentials.
authorization:
# Sets the authentication type of the request.
[ type: <string> | default: Bearer ]
# Sets the credentials of the request. It is mutually exclusive with
# `credentials_file`.
[ credentials: <secret> ]
# Sets the credentials of the request with the credentials read from the
# configured file. It is mutually exclusive with `credentials`.
[ credentials_file: <filename> ]
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
Add OAuth 2.0 Config (#8761) * Introduced oauth2 config into the codebase Signed-off-by: Levi Harrison <git@leviharrison.dev>
2021-04-28 05:47:52 -07:00
# Optional OAuth 2.0 configuration.
# Cannot be used at the same time as basic_auth or authorization.
oauth2:
[ <oauth2> ]
Support follow_redirect This PR introduces support for follow_redirect, to enable users to disable following HTTP redirects. Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2021-02-26 13:48:06 -08:00
# Configure whether scrape requests follow HTTP 3xx redirects.
[ follow_redirects: <bool> | default = true ]
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
# Configures the scrape request's TLS settings.
tls_config:
[ <tls_config> ]
# Optional proxy URL.
[ proxy_url: <string> ]
# List of Azure service discovery configurations.
azure_sd_configs:
[ - <azure_sd_config> ... ]
# List of Consul service discovery configurations.
consul_sd_configs:
[ - <consul_sd_config> ... ]
Add DigitalOcean service discovery (#7407) Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2020-06-18 08:04:41 -07:00
# List of DigitalOcean service discovery configurations.
digitalocean_sd_configs:
[ - <digitalocean_sd_config> ... ]
Implement Docker discovery (#8629) * Implement Docker discovery Signed-off-by: Robert Jacob <xperimental@solidproject.de>
2021-03-29 13:30:23 -07:00
# List of Docker service discovery configurations.
docker_sd_configs:
[ - <docker_sd_config> ... ]
Docker Swarm service discovery (#7420) * Docker Swarm service discovery Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2020-06-26 03:25:58 -07:00
# List of Docker Swarm service discovery configurations.
dockerswarm_sd_configs:
[ - <dockerswarm_sd_config> ... ]
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
# List of DNS service discovery configurations.
dns_sd_configs:
[ - <dns_sd_config> ... ]
# List of EC2 service discovery configurations.
ec2_sd_configs:
[ - <ec2_sd_config> ... ]
Add Eureka Service Discovery (#3369) Signed-off-by: kangwoo <kangwoo@gmail.com>
2020-08-26 08:36:59 -07:00
# List of Eureka service discovery configurations.
eureka_sd_configs:
[ - <eureka_sd_config> ... ]
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
# List of file service discovery configurations.
file_sd_configs:
[ - <file_sd_config> ... ]
# List of GCE service discovery configurations.
gce_sd_configs:
[ - <gce_sd_config> ... ]
Add hetzner service discovery (#7822) Signed-off-by: Lukas Kämmerling <lukas.kaemmerling@hetzner-cloud.de>
2020-08-21 06:49:19 -07:00
# List of Hetzner service discovery configurations.
hetzner_sd_configs:
[ - <hetzner_sd_config> ... ]
http_sd (#8839) Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2021-06-11 09:04:45 -07:00
# List of HTTP service discovery configurations.
http_sd_configs:
[ - <http_sd_config> ... ]
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
# List of Kubernetes service discovery configurations.
kubernetes_sd_configs:
[ - <kubernetes_sd_config> ... ]
Add documentation for kuma_sd configuration Signed-off-by: austin ce <austin.cawley@gmail.com>
2021-05-04 12:47:53 -07:00
# List of Kuma service discovery configurations.
kuma_sd_configs:
[ - <kuma_sd_config> ... ]
Add lightsail service discovery (#8693) Signed-off-by: N888 <drifto@gmail.com>
2021-04-28 02:29:12 -07:00
# List of Lightsail service discovery configurations.
lightsail_sd_configs:
[ - <lightsail_sd_config> ... ]
Add Linode Service Discovery (#8846) * Add Linode Service Discovery Signed-off-by: TJ Hoplock <t.hoplock@gmail.com>
2021-06-01 11:32:36 -07:00
# List of Linode service discovery configurations.
linode_sd_configs:
[ - <linode_sd_config> ... ]
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
# List of Marathon service discovery configurations.
marathon_sd_configs:
[ - <marathon_sd_config> ... ]
# List of AirBnB's Nerve service discovery configurations.
nerve_sd_configs:
[ - <nerve_sd_config> ... ]
Add new SD's to alertmanager config (#7584) Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2020-07-15 11:51:14 -07:00
# List of OpenStack service discovery configurations.
openstack_sd_configs:
[ - <openstack_sd_config> ... ]
Add PuppetDB service discovery We have been Puppet user for 10 years and we are users of https://github.com/camptocamp/prometheus-puppetdb-sd However, that file_sd implementation contains business logic and assumptions around e.g. the modules which you are using. This pull request adds a simple PuppetDB service discovery, which will enable more use cases than the upstream sd. Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2021-06-01 05:04:58 -07:00
# List of PuppetDB service discovery configurations.
puppetdb_sd_configs:
[ - <puppetdb_sd_config> ... ]
add support for scaleway service discovery (#8555) Co-authored-by: Patrik <patrik@ptrk.io> Co-authored-by: Julien Pivotto <roidelapluie@inuits.eu> Signed-off-by: Rémy Léone <rleone@scaleway.com>
2021-03-10 06:10:17 -08:00
# List of Scaleway service discovery configurations.
scaleway_sd_configs:
[ - <scaleway_sd_config> ... ]
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
# List of Zookeeper Serverset service discovery configurations.
serverset_sd_configs:
[ - <serverset_sd_config> ... ]
# List of Triton service discovery configurations.
triton_sd_configs:
[ - <triton_sd_config> ... ]
Add Uyuni service discovery (#8190) * Add Uyuni service discovery Signed-off-by: Witek Bedyk <witold.bedyk@suse.com> Co-authored-by: Joao Cavalheiro <jcavalheiro@suse.de> Co-authored-by: Marcelo Chiaradia <mchiaradia@suse.com> Co-authored-by: Stefano Torresi <stefano@torresi.io> Co-authored-by: Julien Pivotto <roidelapluie@gmail.com>
2021-10-18 16:00:44 -07:00
# List of Uyuni service discovery configurations.
uyuni_sd_configs:
[ - <uyuni_sd_config> ... ]
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
# List of labeled statically configured targets for this job.
static_configs:
[ - <static_config> ... ]
# List of target relabel configurations.
relabel_configs:
[ - <relabel_config> ... ]
# List of metric relabel configurations.
metric_relabel_configs:
[ - <relabel_config> ... ]
Add body_size_limit to prevent bad targets response large body cause Prometheus server OOM (#8827) Signed-off-by: hanjm <hanjinming@outlook.com>
2021-05-15 19:19:22 -07:00
# An uncompressed response body larger than this many bytes will cause the
# scrape to fail. 0 means no limit. Example: 100MB.
Mark body_size_limit as experimental. (#8886) Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2021-06-02 08:32:08 -07:00
# This is an experimental feature, this behaviour could
# change or be removed in the future.
[ body_size_limit: <size> | default = 0 ]
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
# Per-scrape limit on number of scraped samples that will be accepted.
Add per scrape-config targets limit (#7554) * Add per scrape-config targets limit Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2020-07-30 05:20:24 -07:00
# If more than this number of samples are present after metric relabeling
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
# the entire scrape will be treated as failed. 0 means no limit.
[ sample_limit: <int> | default = 0 ]
Add per scrape-config targets limit (#7554) * Add per scrape-config targets limit Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2020-07-30 05:20:24 -07:00
Add label scrape limits (#8777) * scrape: add label limits per scrape Add three new limits to the scrape configuration to provide some mechanism to defend against unbound number of labels and excessive label lengths. If any of these limits are broken by a sample from a scrape, the whole scrape will fail. For all of these configuration options, a zero value means no limit. The `label_limit` configuration will provide a mechanism to bound the number of labels per-scrape of a certain sample to a user defined limit. This limit will be tested against the sample labels plus the discovery labels, but it will exclude the __name__ from the count since it is a mandatory Prometheus label to which applying constraints isn't meaningful. The `label_name_length_limit` and `label_value_length_limit` will prevent having labels of excessive lengths. These limits also skip the __name__ label for the same reasons as the `label_limit` option and will also make the scrape fail if any sample has a label name/value length that exceed the predefined limits. Signed-off-by: Damien Grisonnet <dgrisonn@redhat.com> * scrape: add metrics and alert to label limits Add three gauge, one for each label limit to easily access the limit set by a certain scrape target. Also add a counter to count the number of targets that exceeded the label limits and thus were dropped. This is useful for the `PrometheusLabelLimitHit` alert that will notify the users that scraping some targets failed because they had samples exceeding the label limits defined in the scrape configuration. Signed-off-by: Damien Grisonnet <dgrisonn@redhat.com> * scrape: apply label limits to __name__ label Apply limits to the __name__ label that was previously skipped and truncate the label names and values in the error messages as they can be very very long. Signed-off-by: Damien Grisonnet <dgrisonn@redhat.com> * scrape: remove label limits gauges and refactor Remove `prometheus_target_scrape_pool_label_limit`, `prometheus_target_scrape_pool_label_name_length_limit`, and `prometheus_target_scrape_pool_label_value_length_limit` as they are not really useful since we don't have the information on the labels in it. Signed-off-by: Damien Grisonnet <dgrisonn@redhat.com>
2021-05-06 01:56:21 -07:00
# Per-scrape limit on number of labels that will be accepted for a sample. If
# more than this number of labels are present post metric-relabeling, the
# entire scrape will be treated as failed. 0 means no limit.
[ label_limit: <int> | default = 0 ]
# Per-scrape limit on length of labels name that will be accepted for a sample.
# If a label name is longer than this number post metric-relabeling, the entire
# scrape will be treated as failed. 0 means no limit.
[ label_name_length_limit: <int> | default = 0 ]
# Per-scrape limit on length of labels value that will be accepted for a sample.
# If a label value is longer than this number post metric-relabeling, the
# entire scrape will be treated as failed. 0 means no limit.
[ label_value_length_limit: <int> | default = 0 ]
Add per scrape-config targets limit (#7554) * Add per scrape-config targets limit Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2020-07-30 05:20:24 -07:00
# Per-scrape config limit on number of unique targets that will be
# accepted. If more than this number of targets are present after target
# relabeling, Prometheus will mark the targets as failed without scraping them.
# 0 means no limit. This is an experimental feature, this behaviour could
# change in the future.
[ target_limit: <int> | default = 0 ]
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
```
Where `<job_name>` must be unique across all scrape configurations.
### `<tls_config>`
A `tls_config` allows configuring TLS connections.
```yaml
# CA certificate to validate API server certificate with.
[ ca_file: <filename> ]
# Certificate and key files for client cert authentication to the server.
[ cert_file: <filename> ]
[ key_file: <filename> ]
# ServerName extension to indicate the name of the server.
Update remaining deprecated links in docs (#5271) Signed-off-by: Vu Cong Tuan <tuanvc@vn.fujitsu.com>
2019-02-26 02:16:38 -08:00
# https://tools.ietf.org/html/rfc4366#section-3.1
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
[ server_name: <string> ]
# Disable validation of the server certificate.
[ insecure_skip_verify: <boolean> ]
```
http_sd (#8839) Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2021-06-11 09:04:45 -07:00
### `<oauth2>`
Add OAuth 2.0 Config (#8761) * Introduced oauth2 config into the codebase Signed-off-by: Levi Harrison <git@leviharrison.dev>
2021-04-28 05:47:52 -07:00
OAuth 2.0 authentication using the client credentials grant type.
Prometheus fetches an access token from the specified endpoint with
the given client access and secret keys.
```yaml
client_id: <string>
[ client_secret: <secret> ]
# Read the client secret from a file.
# It is mutually exclusive with `client_secret`.
[ client_secret_file: <filename> ]
# Scopes for the token request.
scopes:
[ - <string> ... ]
# The URL to fetch the token from.
token_url: <string>
# Optional parameters to append to the token URL.
endpoint_params:
[ <string>: <string> ... ]
Enable tls_config in oauth2 (#9550) * Enable tls_config in oauth2 Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2021-10-20 14:10:18 -07:00
# Configures the token request's TLS settings.
tls_config:
[ <tls_config> ]
Add OAuth 2.0 Config (#8761) * Introduced oauth2 config into the codebase Signed-off-by: Levi Harrison <git@leviharrison.dev>
2021-04-28 05:47:52 -07:00
```
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
### `<azure_sd_config>`
Azure SD configurations allow retrieving scrape targets from Azure VMs.
add relabeling link to be consistent with other section (#7851) Signed-off-by: Luke Chen <showuon@gmail.com>
2020-08-26 00:39:31 -07:00
The following meta labels are available on targets during [relabeling](#relabel_config):
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
* `__meta_azure_machine_id`: the machine ID
* `__meta_azure_machine_location`: the location the machine runs in
* `__meta_azure_machine_name`: the machine name
Add computer name to azure sd Signed-off-by: darshanime <deathbullet@gmail.com>
2021-07-25 09:34:32 -07:00
* `__meta_azure_machine_computer_name`: the machine computer name
Add OS type meta label to Azure SD (#3863) There is currently no way to differentiate Windows instances from Linux ones. This is needed when you have a mix of node_exporters / wmi_exporters for OS-level metrics and you want to have them in separate scrape jobs. This change allows you to do just that. Example: ``` - job_name: 'node' azure_sd_configs: - <azure_sd_config> relabel_configs: - source_labels: [__meta_azure_machine_os_type] regex: Linux action: keep ``` The way the vendor'd AzureSDK provides to get the OsType is a bit awkward - as far as I can tell, this information can only be gotten from the startup disk. Newer versions of the SDK appear to improve this a bit (by having OS information in the InstanceView), but the current way still works.
2018-02-19 07:40:57 -08:00
* `__meta_azure_machine_os_type`: the machine operating system
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
* `__meta_azure_machine_private_ip`: the machine's private IP
Add azure public ip label (#5475) * Update Azure SD Config with Public IP label Signed-off-by: earthmant <trammell@cloudify.co>
2019-04-17 08:05:44 -07:00
* `__meta_azure_machine_public_ip`: the machine's public IP if it exists
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
* `__meta_azure_machine_resource_group`: the machine's resource group
add logic to check if an azure VM is deallocated or not (#4908) * add logic to check if an azure VM is deallocated or not * update documentation with the new azure power state label Signed-off-by: tariqibrahim <tariq.ibrahim@microsoft.com>
2018-11-30 03:32:40 -08:00
* `__meta_azure_machine_tag_<tagname>`: each tag value of the machine
Revert "add logic to check if an azure VM is deallocated or not (#4908)" (#4980) This reverts commit 61cf4365 Signed-off-by: tariqibrahim <tariq.ibrahim@microsoft.com>
2018-12-12 00:27:12 -08:00
* `__meta_azure_machine_scale_set`: the name of the scale set which the vm is part of (this value is only set if you are using a [scale set](https://docs.microsoft.com/en-us/azure/virtual-machine-scale-sets/))
Sort Signed-off-by: Fabian Reinartz <freinartz@google.com>
2018-12-23 04:06:36 -08:00
* `__meta_azure_subscription_id`: the subscription ID
* `__meta_azure_tenant_id`: the tenant ID
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
See below for the configuration options for Azure discovery:
```yaml
# The information to access the Azure API.
Adding support for multiple azure environments (#4569) Signed-off-by: Tariq Ibrahim <tariq.ibrahim@microsoft.com>
2018-09-04 08:55:40 -07:00
# The Azure environment.
[ environment: <string> | default = AzurePublicCloud ]
discovery: add support for Managed Identity authentication in Azure SD (#4590) Signed-off-by: Marcel Juhnke <marrat@marrat.de>
2018-12-19 02:03:33 -08:00
# The authentication method, either OAuth or ManagedIdentity.
# See https://docs.microsoft.com/en-us/azure/active-directory/managed-identities-azure-resources/overview
[ authentication_method: <string> | default = OAuth]
# The subscription ID. Always required.
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
subscription_id: <string>
discovery: add support for Managed Identity authentication in Azure SD (#4590) Signed-off-by: Marcel Juhnke <marrat@marrat.de>
2018-12-19 02:03:33 -08:00
# Optional tenant ID. Only required with authentication_method OAuth.
[ tenant_id: <string> ]
# Optional client ID. Only required with authentication_method OAuth.
[ client_id: <string> ]
# Optional client secret. Only required with authentication_method OAuth.
[ client_secret: <secret> ]
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
# Refresh interval to re-read the instance list.
[ refresh_interval: <duration> | default = 300s ]
# The port to scrape metrics from. If using the public IP address, this must
# instead be specified in the relabeling rule.
[ port: <int> | default = 80 ]
Add common HTTP client to Azure SD (#9267) * Add `proxy_url` option to Azure SD Signed-off-by: Levi Harrison <git@leviharrison.dev>
2021-10-20 14:09:58 -07:00
# Authentication information used to authenticate to the consul server.
# Note that `basic_auth`, `authorization` and `oauth2` options are
# mutually exclusive.
# `password` and `password_file` are mutually exclusive.
# Optional HTTP basic authentication information, currently not support by Azure.
basic_auth:
[ username: <string> ]
[ password: <secret> ]
[ password_file: <string> ]
# Optional `Authorization` header configuration, currently not supported by Azure.
authorization:
# Sets the authentication type.
[ type: <string> | default: Bearer ]
# Sets the credentials. It is mutually exclusive with
# `credentials_file`.
[ credentials: <secret> ]
# Sets the credentials to the credentials read from the configured file.
# It is mutually exclusive with `credentials`.
[ credentials_file: <filename> ]
# Optional OAuth 2.0 configuration, currently not supported by Azure.
oauth2:
[ <oauth2> ]
# Optional proxy URL.
[ proxy_url: <string> ]
# Configure whether HTTP requests follow HTTP 3xx redirects.
[ follow_redirects: <bool> | default = true ]
# TLS configuration.
tls_config:
[ <tls_config> ]
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
```
### `<consul_sd_config>`
Consul SD configurations allow retrieving scrape targets from [Consul's](https://www.consul.io)
Catalog API.
The following meta labels are available on targets during [relabeling](#relabel_config):
* `__meta_consul_address`: the address of the target
* `__meta_consul_dc`: the datacenter name for the target
Consul: document health meta label (#7466) implemented in #5313 fixes #770 Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2020-06-26 03:14:51 -07:00
* `__meta_consul_health`: the health status of the service
consul: improve consul service discovery (#3814) * consul: improve consul service discovery Related to #3711 - Add the ability to filter by tag and node-meta in an efficient way (`/catalog/services` allow filtering by node-meta, and returns a `map[string]string` or `service`->`tags`). Tags and nore-meta are also used in `/catalog/service` requests. - Do not require a call to the catalog if services are specified by name. This is important because on large cluster `/catalog/services` changes all the time. - Add `allow_stale` configuration option to do stale reads. Non-stale reads can be costly, even more when you are doing them to a remote datacenter with 10k+ targets over WAN (which is common for federation). - Add `refresh_interval` to minimize the strain on the catalog and on the service endpoint. This is needed because of that kind of behavior from consul: https://github.com/hashicorp/consul/issues/3712 and because a catalog on a large cluster would basically change *all* the time. No need to discover targets in 1sec if we scrape them every minute. - Added plenty of unit tests. Benchmarks ---------- ```yaml scrape_configs: - job_name: prometheus scrape_interval: 60s static_configs: - targets: ["127.0.0.1:9090"] - job_name: "observability-by-tag" scrape_interval: "60s" metrics_path: "/metrics" consul_sd_configs: - server: consul.service.par.consul.prod.crto.in:8500 tag: marathon-user-observability # Used in After refresh_interval: 30s # Used in After+delay relabel_configs: - source_labels: [__meta_consul_tags] regex: ^(.*,)?marathon-user-observability(,.*)?$ action: keep - job_name: "observability-by-name" scrape_interval: "60s" metrics_path: "/metrics" consul_sd_configs: - server: consul.service.par.consul.prod.crto.in:8500 services: - observability-cerebro - observability-portal-web - job_name: "fake-fake-fake" scrape_interval: "15s" metrics_path: "/metrics" consul_sd_configs: - server: consul.service.par.consul.prod.crto.in:8500 services: - fake-fake-fake ``` Note: tested with ~1200 services, ~5000 nodes. | Resource | Empty | Before | After | After + delay | | -------- |:-----:|:------:|:-----:|:-------------:| |/service-discovery size|5K|85MiB|27k|27k|27k| |`go_memstats_heap_objects`|100k|1M|120k|110k| |`go_memstats_heap_alloc_bytes`|24MB|150MB|28MB|27MB| |`rate(go_memstats_alloc_bytes_total[5m])`|0.2MB/s|28MB/s|2MB/s|0.3MB/s| |`rate(process_cpu_seconds_total[5m])`|0.1%|15%|2%|0.01%| |`process_open_fds`|16|*1236*|22|22| |`rate(prometheus_sd_consul_rpc_duration_seconds_count{call="services"}[5m])`|~0|1|1|*0.03*| |`rate(prometheus_sd_consul_rpc_duration_seconds_count{call="service"}[5m])`|0.1|*80*|0.5|0.5| |`prometheus_target_sync_length_seconds{quantile="0.9",scrape_job="observability-by-tag"}`|N/A|200ms|0.2ms|0.2ms| |Network bandwidth|~10kbps|~2.8Mbps|~1.6Mbps|~10kbps| Filtering by tag using relabel_configs uses **100kiB and 23kiB/s per service per job** and quite a lot of CPU. Also sends and additional *1Mbps* of traffic to consul. Being a little bit smarter about this reduces the overhead quite a lot. Limiting the number of `/catalog/services` queries per second almost removes the overhead of service discovery. * consul: tweak `refresh_interval` behavior `refresh_interval` now does what is advertised in the documentation, there won't be more that one update per `refresh_interval`. It now defaults to 30s (which was also the current waitTime in the consul query). This also make sure we don't wait another 30s if we already waited 29s in the blocking call by substracting the number of elapsed seconds. Hopefully this will do what people expect it does and will be safer for existing consul infrastructures.
2018-03-23 07:48:43 -07:00
* `__meta_consul_metadata_<key>`: each node metadata key value of the target
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
* `__meta_consul_node`: the node name defined for the target
* `__meta_consul_service_address`: the service address of the target
* `__meta_consul_service_id`: the service ID of the target
Discovery consul service meta (#4280) * Upgrade Consul client * Add ServiceMeta to the labels in ConsulSD Signed-off-by: Romain Baugue <romain.baugue@elwinar.com>
2018-07-17 21:06:56 -07:00
* `__meta_consul_service_metadata_<key>`: each service metadata key value of the target
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
* `__meta_consul_service_port`: the service port of the target
* `__meta_consul_service`: the name of the service the target belongs to
Consul: document health meta label (#7466) implemented in #5313 fixes #770 Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2020-06-26 03:14:51 -07:00
* `__meta_consul_tagged_address_<key>`: each node tagged address key value of the target
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
* `__meta_consul_tags`: the list of tags of the target joined by the tag separator
```yaml
# The information to access the Consul API. It is to be defined
# as the Consul documentation requires.
Set consul server default to localhost:8500 (#3703)
2018-01-24 04:14:32 -08:00
[ server: <host> | default = "localhost:8500" ]
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
[ token: <secret> ]
[ datacenter: <string> ]
consul_sd: Add namespace support for Consul Enterprise Signed-off-by: Frederic Hemberger <mail@frederic-hemberger.de>
2021-06-07 08:24:54 -07:00
# Namespaces are only supported in Consul Enterprise.
[ namespace: <string> ]
Set consul server default to localhost:8500 (#3703)
2018-01-24 04:14:32 -08:00
[ scheme: <string> | default = "http" ]
Enable reading consul token from file (#8926) * Adopted common http client Signed-off-by: Levi Harrison <git@leviharrison.dev>
2021-06-11 15:06:59 -07:00
# The username and password fields are deprecated in favor of the basic_auth configuration.
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
[ username: <string> ]
[ password: <secret> ]
# A list of services for which targets are retrieved. If omitted, all services
# are scraped.
services:
[ - <string> ]
consul: improve consul service discovery (#3814) * consul: improve consul service discovery Related to #3711 - Add the ability to filter by tag and node-meta in an efficient way (`/catalog/services` allow filtering by node-meta, and returns a `map[string]string` or `service`->`tags`). Tags and nore-meta are also used in `/catalog/service` requests. - Do not require a call to the catalog if services are specified by name. This is important because on large cluster `/catalog/services` changes all the time. - Add `allow_stale` configuration option to do stale reads. Non-stale reads can be costly, even more when you are doing them to a remote datacenter with 10k+ targets over WAN (which is common for federation). - Add `refresh_interval` to minimize the strain on the catalog and on the service endpoint. This is needed because of that kind of behavior from consul: https://github.com/hashicorp/consul/issues/3712 and because a catalog on a large cluster would basically change *all* the time. No need to discover targets in 1sec if we scrape them every minute. - Added plenty of unit tests. Benchmarks ---------- ```yaml scrape_configs: - job_name: prometheus scrape_interval: 60s static_configs: - targets: ["127.0.0.1:9090"] - job_name: "observability-by-tag" scrape_interval: "60s" metrics_path: "/metrics" consul_sd_configs: - server: consul.service.par.consul.prod.crto.in:8500 tag: marathon-user-observability # Used in After refresh_interval: 30s # Used in After+delay relabel_configs: - source_labels: [__meta_consul_tags] regex: ^(.*,)?marathon-user-observability(,.*)?$ action: keep - job_name: "observability-by-name" scrape_interval: "60s" metrics_path: "/metrics" consul_sd_configs: - server: consul.service.par.consul.prod.crto.in:8500 services: - observability-cerebro - observability-portal-web - job_name: "fake-fake-fake" scrape_interval: "15s" metrics_path: "/metrics" consul_sd_configs: - server: consul.service.par.consul.prod.crto.in:8500 services: - fake-fake-fake ``` Note: tested with ~1200 services, ~5000 nodes. | Resource | Empty | Before | After | After + delay | | -------- |:-----:|:------:|:-----:|:-------------:| |/service-discovery size|5K|85MiB|27k|27k|27k| |`go_memstats_heap_objects`|100k|1M|120k|110k| |`go_memstats_heap_alloc_bytes`|24MB|150MB|28MB|27MB| |`rate(go_memstats_alloc_bytes_total[5m])`|0.2MB/s|28MB/s|2MB/s|0.3MB/s| |`rate(process_cpu_seconds_total[5m])`|0.1%|15%|2%|0.01%| |`process_open_fds`|16|*1236*|22|22| |`rate(prometheus_sd_consul_rpc_duration_seconds_count{call="services"}[5m])`|~0|1|1|*0.03*| |`rate(prometheus_sd_consul_rpc_duration_seconds_count{call="service"}[5m])`|0.1|*80*|0.5|0.5| |`prometheus_target_sync_length_seconds{quantile="0.9",scrape_job="observability-by-tag"}`|N/A|200ms|0.2ms|0.2ms| |Network bandwidth|~10kbps|~2.8Mbps|~1.6Mbps|~10kbps| Filtering by tag using relabel_configs uses **100kiB and 23kiB/s per service per job** and quite a lot of CPU. Also sends and additional *1Mbps* of traffic to consul. Being a little bit smarter about this reduces the overhead quite a lot. Limiting the number of `/catalog/services` queries per second almost removes the overhead of service discovery. * consul: tweak `refresh_interval` behavior `refresh_interval` now does what is advertised in the documentation, there won't be more that one update per `refresh_interval`. It now defaults to 30s (which was also the current waitTime in the consul query). This also make sure we don't wait another 30s if we already waited 29s in the blocking call by substracting the number of elapsed seconds. Hopefully this will do what people expect it does and will be safer for existing consul infrastructures.
2018-03-23 07:48:43 -07:00
# See https://www.consul.io/api/catalog.html#list-nodes-for-service to know more
# about the possible filters that can be used.
update Consul vendor code so that catalog.ServiceMultipleTags can be (#5151) Signed-off-by: Callum Styan <callumstyan@gmail.com>
2019-03-12 03:31:27 -07:00
# An optional list of tags used to filter nodes for a given service. Services must contain all tags in the list.
tags:
[ - <string> ]
consul: improve consul service discovery (#3814) * consul: improve consul service discovery Related to #3711 - Add the ability to filter by tag and node-meta in an efficient way (`/catalog/services` allow filtering by node-meta, and returns a `map[string]string` or `service`->`tags`). Tags and nore-meta are also used in `/catalog/service` requests. - Do not require a call to the catalog if services are specified by name. This is important because on large cluster `/catalog/services` changes all the time. - Add `allow_stale` configuration option to do stale reads. Non-stale reads can be costly, even more when you are doing them to a remote datacenter with 10k+ targets over WAN (which is common for federation). - Add `refresh_interval` to minimize the strain on the catalog and on the service endpoint. This is needed because of that kind of behavior from consul: https://github.com/hashicorp/consul/issues/3712 and because a catalog on a large cluster would basically change *all* the time. No need to discover targets in 1sec if we scrape them every minute. - Added plenty of unit tests. Benchmarks ---------- ```yaml scrape_configs: - job_name: prometheus scrape_interval: 60s static_configs: - targets: ["127.0.0.1:9090"] - job_name: "observability-by-tag" scrape_interval: "60s" metrics_path: "/metrics" consul_sd_configs: - server: consul.service.par.consul.prod.crto.in:8500 tag: marathon-user-observability # Used in After refresh_interval: 30s # Used in After+delay relabel_configs: - source_labels: [__meta_consul_tags] regex: ^(.*,)?marathon-user-observability(,.*)?$ action: keep - job_name: "observability-by-name" scrape_interval: "60s" metrics_path: "/metrics" consul_sd_configs: - server: consul.service.par.consul.prod.crto.in:8500 services: - observability-cerebro - observability-portal-web - job_name: "fake-fake-fake" scrape_interval: "15s" metrics_path: "/metrics" consul_sd_configs: - server: consul.service.par.consul.prod.crto.in:8500 services: - fake-fake-fake ``` Note: tested with ~1200 services, ~5000 nodes. | Resource | Empty | Before | After | After + delay | | -------- |:-----:|:------:|:-----:|:-------------:| |/service-discovery size|5K|85MiB|27k|27k|27k| |`go_memstats_heap_objects`|100k|1M|120k|110k| |`go_memstats_heap_alloc_bytes`|24MB|150MB|28MB|27MB| |`rate(go_memstats_alloc_bytes_total[5m])`|0.2MB/s|28MB/s|2MB/s|0.3MB/s| |`rate(process_cpu_seconds_total[5m])`|0.1%|15%|2%|0.01%| |`process_open_fds`|16|*1236*|22|22| |`rate(prometheus_sd_consul_rpc_duration_seconds_count{call="services"}[5m])`|~0|1|1|*0.03*| |`rate(prometheus_sd_consul_rpc_duration_seconds_count{call="service"}[5m])`|0.1|*80*|0.5|0.5| |`prometheus_target_sync_length_seconds{quantile="0.9",scrape_job="observability-by-tag"}`|N/A|200ms|0.2ms|0.2ms| |Network bandwidth|~10kbps|~2.8Mbps|~1.6Mbps|~10kbps| Filtering by tag using relabel_configs uses **100kiB and 23kiB/s per service per job** and quite a lot of CPU. Also sends and additional *1Mbps* of traffic to consul. Being a little bit smarter about this reduces the overhead quite a lot. Limiting the number of `/catalog/services` queries per second almost removes the overhead of service discovery. * consul: tweak `refresh_interval` behavior `refresh_interval` now does what is advertised in the documentation, there won't be more that one update per `refresh_interval`. It now defaults to 30s (which was also the current waitTime in the consul query). This also make sure we don't wait another 30s if we already waited 29s in the blocking call by substracting the number of elapsed seconds. Hopefully this will do what people expect it does and will be safer for existing consul infrastructures.
2018-03-23 07:48:43 -07:00
Fix consul_sd_config to follow types convention (#7316) Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2020-05-29 12:20:37 -07:00
# Node metadata key/value pairs to filter nodes for a given service.
consul: improve consul service discovery (#3814) * consul: improve consul service discovery Related to #3711 - Add the ability to filter by tag and node-meta in an efficient way (`/catalog/services` allow filtering by node-meta, and returns a `map[string]string` or `service`->`tags`). Tags and nore-meta are also used in `/catalog/service` requests. - Do not require a call to the catalog if services are specified by name. This is important because on large cluster `/catalog/services` changes all the time. - Add `allow_stale` configuration option to do stale reads. Non-stale reads can be costly, even more when you are doing them to a remote datacenter with 10k+ targets over WAN (which is common for federation). - Add `refresh_interval` to minimize the strain on the catalog and on the service endpoint. This is needed because of that kind of behavior from consul: https://github.com/hashicorp/consul/issues/3712 and because a catalog on a large cluster would basically change *all* the time. No need to discover targets in 1sec if we scrape them every minute. - Added plenty of unit tests. Benchmarks ---------- ```yaml scrape_configs: - job_name: prometheus scrape_interval: 60s static_configs: - targets: ["127.0.0.1:9090"] - job_name: "observability-by-tag" scrape_interval: "60s" metrics_path: "/metrics" consul_sd_configs: - server: consul.service.par.consul.prod.crto.in:8500 tag: marathon-user-observability # Used in After refresh_interval: 30s # Used in After+delay relabel_configs: - source_labels: [__meta_consul_tags] regex: ^(.*,)?marathon-user-observability(,.*)?$ action: keep - job_name: "observability-by-name" scrape_interval: "60s" metrics_path: "/metrics" consul_sd_configs: - server: consul.service.par.consul.prod.crto.in:8500 services: - observability-cerebro - observability-portal-web - job_name: "fake-fake-fake" scrape_interval: "15s" metrics_path: "/metrics" consul_sd_configs: - server: consul.service.par.consul.prod.crto.in:8500 services: - fake-fake-fake ``` Note: tested with ~1200 services, ~5000 nodes. | Resource | Empty | Before | After | After + delay | | -------- |:-----:|:------:|:-----:|:-------------:| |/service-discovery size|5K|85MiB|27k|27k|27k| |`go_memstats_heap_objects`|100k|1M|120k|110k| |`go_memstats_heap_alloc_bytes`|24MB|150MB|28MB|27MB| |`rate(go_memstats_alloc_bytes_total[5m])`|0.2MB/s|28MB/s|2MB/s|0.3MB/s| |`rate(process_cpu_seconds_total[5m])`|0.1%|15%|2%|0.01%| |`process_open_fds`|16|*1236*|22|22| |`rate(prometheus_sd_consul_rpc_duration_seconds_count{call="services"}[5m])`|~0|1|1|*0.03*| |`rate(prometheus_sd_consul_rpc_duration_seconds_count{call="service"}[5m])`|0.1|*80*|0.5|0.5| |`prometheus_target_sync_length_seconds{quantile="0.9",scrape_job="observability-by-tag"}`|N/A|200ms|0.2ms|0.2ms| |Network bandwidth|~10kbps|~2.8Mbps|~1.6Mbps|~10kbps| Filtering by tag using relabel_configs uses **100kiB and 23kiB/s per service per job** and quite a lot of CPU. Also sends and additional *1Mbps* of traffic to consul. Being a little bit smarter about this reduces the overhead quite a lot. Limiting the number of `/catalog/services` queries per second almost removes the overhead of service discovery. * consul: tweak `refresh_interval` behavior `refresh_interval` now does what is advertised in the documentation, there won't be more that one update per `refresh_interval`. It now defaults to 30s (which was also the current waitTime in the consul query). This also make sure we don't wait another 30s if we already waited 29s in the blocking call by substracting the number of elapsed seconds. Hopefully this will do what people expect it does and will be safer for existing consul infrastructures.
2018-03-23 07:48:43 -07:00
[ node_meta:
Fix consul_sd_config to follow types convention (#7316) Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2020-05-29 12:20:37 -07:00
[ <string>: <string> ... ] ]
consul: improve consul service discovery (#3814) * consul: improve consul service discovery Related to #3711 - Add the ability to filter by tag and node-meta in an efficient way (`/catalog/services` allow filtering by node-meta, and returns a `map[string]string` or `service`->`tags`). Tags and nore-meta are also used in `/catalog/service` requests. - Do not require a call to the catalog if services are specified by name. This is important because on large cluster `/catalog/services` changes all the time. - Add `allow_stale` configuration option to do stale reads. Non-stale reads can be costly, even more when you are doing them to a remote datacenter with 10k+ targets over WAN (which is common for federation). - Add `refresh_interval` to minimize the strain on the catalog and on the service endpoint. This is needed because of that kind of behavior from consul: https://github.com/hashicorp/consul/issues/3712 and because a catalog on a large cluster would basically change *all* the time. No need to discover targets in 1sec if we scrape them every minute. - Added plenty of unit tests. Benchmarks ---------- ```yaml scrape_configs: - job_name: prometheus scrape_interval: 60s static_configs: - targets: ["127.0.0.1:9090"] - job_name: "observability-by-tag" scrape_interval: "60s" metrics_path: "/metrics" consul_sd_configs: - server: consul.service.par.consul.prod.crto.in:8500 tag: marathon-user-observability # Used in After refresh_interval: 30s # Used in After+delay relabel_configs: - source_labels: [__meta_consul_tags] regex: ^(.*,)?marathon-user-observability(,.*)?$ action: keep - job_name: "observability-by-name" scrape_interval: "60s" metrics_path: "/metrics" consul_sd_configs: - server: consul.service.par.consul.prod.crto.in:8500 services: - observability-cerebro - observability-portal-web - job_name: "fake-fake-fake" scrape_interval: "15s" metrics_path: "/metrics" consul_sd_configs: - server: consul.service.par.consul.prod.crto.in:8500 services: - fake-fake-fake ``` Note: tested with ~1200 services, ~5000 nodes. | Resource | Empty | Before | After | After + delay | | -------- |:-----:|:------:|:-----:|:-------------:| |/service-discovery size|5K|85MiB|27k|27k|27k| |`go_memstats_heap_objects`|100k|1M|120k|110k| |`go_memstats_heap_alloc_bytes`|24MB|150MB|28MB|27MB| |`rate(go_memstats_alloc_bytes_total[5m])`|0.2MB/s|28MB/s|2MB/s|0.3MB/s| |`rate(process_cpu_seconds_total[5m])`|0.1%|15%|2%|0.01%| |`process_open_fds`|16|*1236*|22|22| |`rate(prometheus_sd_consul_rpc_duration_seconds_count{call="services"}[5m])`|~0|1|1|*0.03*| |`rate(prometheus_sd_consul_rpc_duration_seconds_count{call="service"}[5m])`|0.1|*80*|0.5|0.5| |`prometheus_target_sync_length_seconds{quantile="0.9",scrape_job="observability-by-tag"}`|N/A|200ms|0.2ms|0.2ms| |Network bandwidth|~10kbps|~2.8Mbps|~1.6Mbps|~10kbps| Filtering by tag using relabel_configs uses **100kiB and 23kiB/s per service per job** and quite a lot of CPU. Also sends and additional *1Mbps* of traffic to consul. Being a little bit smarter about this reduces the overhead quite a lot. Limiting the number of `/catalog/services` queries per second almost removes the overhead of service discovery. * consul: tweak `refresh_interval` behavior `refresh_interval` now does what is advertised in the documentation, there won't be more that one update per `refresh_interval`. It now defaults to 30s (which was also the current waitTime in the consul query). This also make sure we don't wait another 30s if we already waited 29s in the blocking call by substracting the number of elapsed seconds. Hopefully this will do what people expect it does and will be safer for existing consul infrastructures.
2018-03-23 07:48:43 -07:00
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
# The string by which Consul tags are joined into the tag label.
[ tag_separator: <string> | default = , ]
consul: improve consul service discovery (#3814) * consul: improve consul service discovery Related to #3711 - Add the ability to filter by tag and node-meta in an efficient way (`/catalog/services` allow filtering by node-meta, and returns a `map[string]string` or `service`->`tags`). Tags and nore-meta are also used in `/catalog/service` requests. - Do not require a call to the catalog if services are specified by name. This is important because on large cluster `/catalog/services` changes all the time. - Add `allow_stale` configuration option to do stale reads. Non-stale reads can be costly, even more when you are doing them to a remote datacenter with 10k+ targets over WAN (which is common for federation). - Add `refresh_interval` to minimize the strain on the catalog and on the service endpoint. This is needed because of that kind of behavior from consul: https://github.com/hashicorp/consul/issues/3712 and because a catalog on a large cluster would basically change *all* the time. No need to discover targets in 1sec if we scrape them every minute. - Added plenty of unit tests. Benchmarks ---------- ```yaml scrape_configs: - job_name: prometheus scrape_interval: 60s static_configs: - targets: ["127.0.0.1:9090"] - job_name: "observability-by-tag" scrape_interval: "60s" metrics_path: "/metrics" consul_sd_configs: - server: consul.service.par.consul.prod.crto.in:8500 tag: marathon-user-observability # Used in After refresh_interval: 30s # Used in After+delay relabel_configs: - source_labels: [__meta_consul_tags] regex: ^(.*,)?marathon-user-observability(,.*)?$ action: keep - job_name: "observability-by-name" scrape_interval: "60s" metrics_path: "/metrics" consul_sd_configs: - server: consul.service.par.consul.prod.crto.in:8500 services: - observability-cerebro - observability-portal-web - job_name: "fake-fake-fake" scrape_interval: "15s" metrics_path: "/metrics" consul_sd_configs: - server: consul.service.par.consul.prod.crto.in:8500 services: - fake-fake-fake ``` Note: tested with ~1200 services, ~5000 nodes. | Resource | Empty | Before | After | After + delay | | -------- |:-----:|:------:|:-----:|:-------------:| |/service-discovery size|5K|85MiB|27k|27k|27k| |`go_memstats_heap_objects`|100k|1M|120k|110k| |`go_memstats_heap_alloc_bytes`|24MB|150MB|28MB|27MB| |`rate(go_memstats_alloc_bytes_total[5m])`|0.2MB/s|28MB/s|2MB/s|0.3MB/s| |`rate(process_cpu_seconds_total[5m])`|0.1%|15%|2%|0.01%| |`process_open_fds`|16|*1236*|22|22| |`rate(prometheus_sd_consul_rpc_duration_seconds_count{call="services"}[5m])`|~0|1|1|*0.03*| |`rate(prometheus_sd_consul_rpc_duration_seconds_count{call="service"}[5m])`|0.1|*80*|0.5|0.5| |`prometheus_target_sync_length_seconds{quantile="0.9",scrape_job="observability-by-tag"}`|N/A|200ms|0.2ms|0.2ms| |Network bandwidth|~10kbps|~2.8Mbps|~1.6Mbps|~10kbps| Filtering by tag using relabel_configs uses **100kiB and 23kiB/s per service per job** and quite a lot of CPU. Also sends and additional *1Mbps* of traffic to consul. Being a little bit smarter about this reduces the overhead quite a lot. Limiting the number of `/catalog/services` queries per second almost removes the overhead of service discovery. * consul: tweak `refresh_interval` behavior `refresh_interval` now does what is advertised in the documentation, there won't be more that one update per `refresh_interval`. It now defaults to 30s (which was also the current waitTime in the consul query). This also make sure we don't wait another 30s if we already waited 29s in the blocking call by substracting the number of elapsed seconds. Hopefully this will do what people expect it does and will be safer for existing consul infrastructures.
2018-03-23 07:48:43 -07:00
Updated the 'consistency-modes' consul.io/api link to point to its new location (#5572) Ref: https://github.com/hashicorp/consul/commit/626392eb62994e05ebf675dcee5a6fbea5bd174a Signed-off-by: Samuel Alfageme <samuel@alfage.me>
2019-05-16 07:52:35 -07:00
# Allow stale Consul results (see https://www.consul.io/api/features/consistency.html). Will reduce load on Consul.
Docs: fix types (#7508) I have batched a bunch of fixes around types in the documentation. Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2020-07-02 14:27:14 -07:00
[ allow_stale: <boolean> | default = true ]
consul: improve consul service discovery (#3814) * consul: improve consul service discovery Related to #3711 - Add the ability to filter by tag and node-meta in an efficient way (`/catalog/services` allow filtering by node-meta, and returns a `map[string]string` or `service`->`tags`). Tags and nore-meta are also used in `/catalog/service` requests. - Do not require a call to the catalog if services are specified by name. This is important because on large cluster `/catalog/services` changes all the time. - Add `allow_stale` configuration option to do stale reads. Non-stale reads can be costly, even more when you are doing them to a remote datacenter with 10k+ targets over WAN (which is common for federation). - Add `refresh_interval` to minimize the strain on the catalog and on the service endpoint. This is needed because of that kind of behavior from consul: https://github.com/hashicorp/consul/issues/3712 and because a catalog on a large cluster would basically change *all* the time. No need to discover targets in 1sec if we scrape them every minute. - Added plenty of unit tests. Benchmarks ---------- ```yaml scrape_configs: - job_name: prometheus scrape_interval: 60s static_configs: - targets: ["127.0.0.1:9090"] - job_name: "observability-by-tag" scrape_interval: "60s" metrics_path: "/metrics" consul_sd_configs: - server: consul.service.par.consul.prod.crto.in:8500 tag: marathon-user-observability # Used in After refresh_interval: 30s # Used in After+delay relabel_configs: - source_labels: [__meta_consul_tags] regex: ^(.*,)?marathon-user-observability(,.*)?$ action: keep - job_name: "observability-by-name" scrape_interval: "60s" metrics_path: "/metrics" consul_sd_configs: - server: consul.service.par.consul.prod.crto.in:8500 services: - observability-cerebro - observability-portal-web - job_name: "fake-fake-fake" scrape_interval: "15s" metrics_path: "/metrics" consul_sd_configs: - server: consul.service.par.consul.prod.crto.in:8500 services: - fake-fake-fake ``` Note: tested with ~1200 services, ~5000 nodes. | Resource | Empty | Before | After | After + delay | | -------- |:-----:|:------:|:-----:|:-------------:| |/service-discovery size|5K|85MiB|27k|27k|27k| |`go_memstats_heap_objects`|100k|1M|120k|110k| |`go_memstats_heap_alloc_bytes`|24MB|150MB|28MB|27MB| |`rate(go_memstats_alloc_bytes_total[5m])`|0.2MB/s|28MB/s|2MB/s|0.3MB/s| |`rate(process_cpu_seconds_total[5m])`|0.1%|15%|2%|0.01%| |`process_open_fds`|16|*1236*|22|22| |`rate(prometheus_sd_consul_rpc_duration_seconds_count{call="services"}[5m])`|~0|1|1|*0.03*| |`rate(prometheus_sd_consul_rpc_duration_seconds_count{call="service"}[5m])`|0.1|*80*|0.5|0.5| |`prometheus_target_sync_length_seconds{quantile="0.9",scrape_job="observability-by-tag"}`|N/A|200ms|0.2ms|0.2ms| |Network bandwidth|~10kbps|~2.8Mbps|~1.6Mbps|~10kbps| Filtering by tag using relabel_configs uses **100kiB and 23kiB/s per service per job** and quite a lot of CPU. Also sends and additional *1Mbps* of traffic to consul. Being a little bit smarter about this reduces the overhead quite a lot. Limiting the number of `/catalog/services` queries per second almost removes the overhead of service discovery. * consul: tweak `refresh_interval` behavior `refresh_interval` now does what is advertised in the documentation, there won't be more that one update per `refresh_interval`. It now defaults to 30s (which was also the current waitTime in the consul query). This also make sure we don't wait another 30s if we already waited 29s in the blocking call by substracting the number of elapsed seconds. Hopefully this will do what people expect it does and will be safer for existing consul infrastructures.
2018-03-23 07:48:43 -07:00
# The time after which the provided names are refreshed.
# On large setup it might be a good idea to increase this value because the catalog will change all the time.
[ refresh_interval: <duration> | default = 30s ]
Enable reading consul token from file (#8926) * Adopted common http client Signed-off-by: Levi Harrison <git@leviharrison.dev>
2021-06-11 15:06:59 -07:00
# Authentication information used to authenticate to the consul server.
# Note that `basic_auth`, `authorization` and `oauth2` options are
# mutually exclusive.
# `password` and `password_file` are mutually exclusive.
# Optional HTTP basic authentication information.
basic_auth:
[ username: <string> ]
[ password: <secret> ]
[ password_file: <string> ]
# Optional `Authorization` header configuration.
authorization:
# Sets the authentication type.
[ type: <string> | default: Bearer ]
# Sets the credentials. It is mutually exclusive with
# `credentials_file`.
[ credentials: <secret> ]
# Sets the credentials to the credentials read from the configured file.
# It is mutually exclusive with `credentials`.
[ credentials_file: <filename> ]
# Optional OAuth 2.0 configuration.
oauth2:
[ <oauth2> ]
# Optional proxy URL.
[ proxy_url: <string> ]
# Configure whether HTTP requests follow HTTP 3xx redirects.
[ follow_redirects: <bool> | default = true ]
# TLS configuration.
tls_config:
[ <tls_config> ]
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
```
Note that the IP number and port used to scrape the targets is assembled as
`<__meta_consul_address>:<__meta_consul_service_port>`. However, in some
Consul setups, the relevant address is in `__meta_consul_service_address`.
In those cases, you can use the [relabel](#relabel_config)
feature to replace the special `__address__` label.
consul: improve consul service discovery (#3814) * consul: improve consul service discovery Related to #3711 - Add the ability to filter by tag and node-meta in an efficient way (`/catalog/services` allow filtering by node-meta, and returns a `map[string]string` or `service`->`tags`). Tags and nore-meta are also used in `/catalog/service` requests. - Do not require a call to the catalog if services are specified by name. This is important because on large cluster `/catalog/services` changes all the time. - Add `allow_stale` configuration option to do stale reads. Non-stale reads can be costly, even more when you are doing them to a remote datacenter with 10k+ targets over WAN (which is common for federation). - Add `refresh_interval` to minimize the strain on the catalog and on the service endpoint. This is needed because of that kind of behavior from consul: https://github.com/hashicorp/consul/issues/3712 and because a catalog on a large cluster would basically change *all* the time. No need to discover targets in 1sec if we scrape them every minute. - Added plenty of unit tests. Benchmarks ---------- ```yaml scrape_configs: - job_name: prometheus scrape_interval: 60s static_configs: - targets: ["127.0.0.1:9090"] - job_name: "observability-by-tag" scrape_interval: "60s" metrics_path: "/metrics" consul_sd_configs: - server: consul.service.par.consul.prod.crto.in:8500 tag: marathon-user-observability # Used in After refresh_interval: 30s # Used in After+delay relabel_configs: - source_labels: [__meta_consul_tags] regex: ^(.*,)?marathon-user-observability(,.*)?$ action: keep - job_name: "observability-by-name" scrape_interval: "60s" metrics_path: "/metrics" consul_sd_configs: - server: consul.service.par.consul.prod.crto.in:8500 services: - observability-cerebro - observability-portal-web - job_name: "fake-fake-fake" scrape_interval: "15s" metrics_path: "/metrics" consul_sd_configs: - server: consul.service.par.consul.prod.crto.in:8500 services: - fake-fake-fake ``` Note: tested with ~1200 services, ~5000 nodes. | Resource | Empty | Before | After | After + delay | | -------- |:-----:|:------:|:-----:|:-------------:| |/service-discovery size|5K|85MiB|27k|27k|27k| |`go_memstats_heap_objects`|100k|1M|120k|110k| |`go_memstats_heap_alloc_bytes`|24MB|150MB|28MB|27MB| |`rate(go_memstats_alloc_bytes_total[5m])`|0.2MB/s|28MB/s|2MB/s|0.3MB/s| |`rate(process_cpu_seconds_total[5m])`|0.1%|15%|2%|0.01%| |`process_open_fds`|16|*1236*|22|22| |`rate(prometheus_sd_consul_rpc_duration_seconds_count{call="services"}[5m])`|~0|1|1|*0.03*| |`rate(prometheus_sd_consul_rpc_duration_seconds_count{call="service"}[5m])`|0.1|*80*|0.5|0.5| |`prometheus_target_sync_length_seconds{quantile="0.9",scrape_job="observability-by-tag"}`|N/A|200ms|0.2ms|0.2ms| |Network bandwidth|~10kbps|~2.8Mbps|~1.6Mbps|~10kbps| Filtering by tag using relabel_configs uses **100kiB and 23kiB/s per service per job** and quite a lot of CPU. Also sends and additional *1Mbps* of traffic to consul. Being a little bit smarter about this reduces the overhead quite a lot. Limiting the number of `/catalog/services` queries per second almost removes the overhead of service discovery. * consul: tweak `refresh_interval` behavior `refresh_interval` now does what is advertised in the documentation, there won't be more that one update per `refresh_interval`. It now defaults to 30s (which was also the current waitTime in the consul query). This also make sure we don't wait another 30s if we already waited 29s in the blocking call by substracting the number of elapsed seconds. Hopefully this will do what people expect it does and will be safer for existing consul infrastructures.
2018-03-23 07:48:43 -07:00
The [relabeling phase](#relabel_config) is the preferred and more powerful
way to filter services or nodes for a service based on arbitrary labels. For
users with thousands of services it can be more efficient to use the Consul API
directly which has basic support for filtering nodes (currently by node
metadata and a single tag).
Add DigitalOcean service discovery (#7407) Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2020-06-18 08:04:41 -07:00
### `<digitalocean_sd_config>`
DigitalOcean SD configurations allow retrieving scrape targets from [DigitalOcean's](https://www.digitalocean.com/)
Droplets API.
This service discovery uses the public IPv4 address by default, by that can be
changed with relabelling, as demonstrated in [the Prometheus digitalocean-sd
configuration file](/documentation/examples/prometheus-digitalocean.yml).
The following meta labels are available on targets during [relabeling](#relabel_config):
* `__meta_digitalocean_droplet_id`: the id of the droplet
* `__meta_digitalocean_droplet_name`: the name of the droplet
Update docs/configuration/configuration.md Co-authored-by: Julien Pivotto <roidelapluie@gmail.com> Signed-off-by: Matteo Valentini <matteo.valentini@nethesis.it>
2021-02-16 02:20:12 -08:00
* `__meta_digitalocean_image`: the slug of the droplet's image
* `__meta_digitalocean_image_name`: the display name of the droplet's image
Add DigitalOcean service discovery (#7407) Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2020-06-18 08:04:41 -07:00
* `__meta_digitalocean_private_ipv4`: the private IPv4 of the droplet
* `__meta_digitalocean_public_ipv4`: the public IPv4 of the droplet
* `__meta_digitalocean_public_ipv6`: the public IPv6 of the droplet
* `__meta_digitalocean_region`: the region of the droplet
* `__meta_digitalocean_size`: the size of the droplet
* `__meta_digitalocean_status`: the status of the droplet
* `__meta_digitalocean_features`: the comma-separated list of features of the droplet
* `__meta_digitalocean_tags`: the comma-separated list of tags of the droplet
Add vpc label to docs. Signed-off-by: Andrew Starr-Bochicchio <a.starr.b@gmail.com>
2021-03-24 14:05:06 -07:00
* `__meta_digitalocean_vpc`: the id of the droplet's VPC
Add DigitalOcean service discovery (#7407) Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2020-06-18 08:04:41 -07:00
```yaml
# Authentication information used to authenticate to the API server.
Update common to support credentials type Most of the backwards compat tests is done in common. Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2021-02-18 14:14:49 -08:00
# Note that `basic_auth` and `authorization` options are
Add DigitalOcean service discovery (#7407) Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2020-06-18 08:04:41 -07:00
# mutually exclusive.
# password and password_file are mutually exclusive.
# Optional HTTP basic authentication information, not currently supported by DigitalOcean.
basic_auth:
[ username: <string> ]
[ password: <secret> ]
[ password_file: <string> ]
http_sd (#8839) Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2021-06-11 09:04:45 -07:00
# Optional `Authorization` header configuration.
Update common to support credentials type Most of the backwards compat tests is done in common. Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2021-02-18 14:14:49 -08:00
authorization:
# Sets the authentication type.
[ type: <string> | default: Bearer ]
# Sets the credentials. It is mutually exclusive with
# `credentials_file`.
[ credentials: <secret> ]
http_sd (#8839) Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2021-06-11 09:04:45 -07:00
# Sets the credentials to the credentials read from the configured file.
Update common to support credentials type Most of the backwards compat tests is done in common. Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2021-02-18 14:14:49 -08:00
# It is mutually exclusive with `credentials`.
[ credentials_file: <filename> ]
Add DigitalOcean service discovery (#7407) Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2020-06-18 08:04:41 -07:00
Add OAuth 2.0 Config (#8761) * Introduced oauth2 config into the codebase Signed-off-by: Levi Harrison <git@leviharrison.dev>
2021-04-28 05:47:52 -07:00
# Optional OAuth 2.0 configuration.
# Cannot be used at the same time as basic_auth or authorization.
oauth2:
[ <oauth2> ]
Add DigitalOcean service discovery (#7407) Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2020-06-18 08:04:41 -07:00
# Optional proxy URL.
[ proxy_url: <string> ]
Support follow_redirect This PR introduces support for follow_redirect, to enable users to disable following HTTP redirects. Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2021-02-26 13:48:06 -08:00
# Configure whether HTTP requests follow HTTP 3xx redirects.
[ follow_redirects: <bool> | default = true ]
Add DigitalOcean service discovery (#7407) Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2020-06-18 08:04:41 -07:00
# TLS configuration.
tls_config:
[ <tls_config> ]
# The port to scrape metrics from.
[ port: <int> | default = 80 ]
# The time after which the droplets are refreshed.
[ refresh_interval: <duration> | default = 60s ]
```
Implement Docker discovery (#8629) * Implement Docker discovery Signed-off-by: Robert Jacob <xperimental@solidproject.de>
2021-03-29 13:30:23 -07:00
### `<docker_sd_config>`
Docker SD configurations allow retrieving scrape targets from [Docker Engine](https://docs.docker.com/engine/) hosts.
This SD discovers "containers" and will create a target for each network IP and port the container is configured to expose.
Available meta labels:
* `__meta_docker_container_id`: the id of the container
* `__meta_docker_container_name`: the name of the container
* `__meta_docker_container_network_mode`: the network mode of the container
* `__meta_docker_container_label_<labelname>`: each label of the container
* `__meta_docker_network_id`: the ID of the network
* `__meta_docker_network_name`: the name of the network
* `__meta_docker_network_ingress`: whether the network is ingress
* `__meta_docker_network_internal`: whether the network is internal
* `__meta_docker_network_label_<labelname>`: each label of the network
* `__meta_docker_network_scope`: the scope of the network
* `__meta_docker_network_ip`: the IP of the container in this network
* `__meta_docker_port_private`: the port on the container
* `__meta_docker_port_public`: the external port if a port-mapping exists
* `__meta_docker_port_public_ip`: the public IP if a port-mapping exists
See below for the configuration options for Docker discovery:
```yaml
# Address of the Docker daemon.
host: <string>
# Optional proxy URL.
[ proxy_url: <string> ]
# TLS configuration.
tls_config:
[ <tls_config> ]
# The port to scrape metrics from, when `role` is nodes, and for discovered
# tasks and services that don't have published ports.
[ port: <int> | default = 80 ]
Added docs Signed-off-by: Levi Harrison <git@leviharrison.dev>
2021-07-27 20:33:40 -07:00
# The host to use if the container is in host networking mode.
HostNetworkHost -> HostNetworkingHost Signed-off-by: Levi Harrison <git@leviharrison.dev>
2021-08-03 04:58:49 -07:00
[ host_networking_host: <string> | default = "localhost" ]
Added docs Signed-off-by: Levi Harrison <git@leviharrison.dev>
2021-07-27 20:33:40 -07:00
Implement Docker discovery (#8629) * Implement Docker discovery Signed-off-by: Robert Jacob <xperimental@solidproject.de>
2021-03-29 13:30:23 -07:00
# Optional filters to limit the discovery process to a subset of available
# resources.
# The available filters are listed in the upstream documentation:
# Services: https://docs.docker.com/engine/api/v1.40/#operation/ServiceList
# Tasks: https://docs.docker.com/engine/api/v1.40/#operation/TaskList
# Nodes: https://docs.docker.com/engine/api/v1.40/#operation/NodeList
[ filters:
[ - name: <string>
values: <string>, [...] ]
# The time after which the containers are refreshed.
[ refresh_interval: <duration> | default = 60s ]
# Authentication information used to authenticate to the Docker daemon.
# Note that `basic_auth` and `authorization` options are
# mutually exclusive.
# password and password_file are mutually exclusive.
# Optional HTTP basic authentication information.
basic_auth:
[ username: <string> ]
[ password: <secret> ]
[ password_file: <string> ]
http_sd (#8839) Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2021-06-11 09:04:45 -07:00
# Optional `Authorization` header configuration.
Implement Docker discovery (#8629) * Implement Docker discovery Signed-off-by: Robert Jacob <xperimental@solidproject.de>
2021-03-29 13:30:23 -07:00
authorization:
# Sets the authentication type.
[ type: <string> | default: Bearer ]
# Sets the credentials. It is mutually exclusive with
# `credentials_file`.
[ credentials: <secret> ]
http_sd (#8839) Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2021-06-11 09:04:45 -07:00
# Sets the credentials to the credentials read from the configured file.
Implement Docker discovery (#8629) * Implement Docker discovery Signed-off-by: Robert Jacob <xperimental@solidproject.de>
2021-03-29 13:30:23 -07:00
# It is mutually exclusive with `credentials`.
[ credentials_file: <filename> ]
Add OAuth 2.0 Config (#8761) * Introduced oauth2 config into the codebase Signed-off-by: Levi Harrison <git@leviharrison.dev>
2021-04-28 05:47:52 -07:00
# Optional OAuth 2.0 configuration.
# Cannot be used at the same time as basic_auth or authorization.
oauth2:
[ <oauth2> ]
Implement Docker discovery (#8629) * Implement Docker discovery Signed-off-by: Robert Jacob <xperimental@solidproject.de>
2021-03-29 13:30:23 -07:00
# Configure whether HTTP requests follow HTTP 3xx redirects.
[ follow_redirects: <bool> | default = true ]
```
The [relabeling phase](#relabel_config) is the preferred and more powerful
way to filter containers. For users with thousands of containers it
can be more efficient to use the Docker API directly which has basic support for
filtering containers (using `filters`).
See [this example Prometheus configuration file](/documentation/examples/prometheus-docker.yml)
for a detailed example of configuring Prometheus for Docker Engine.
Docker Swarm service discovery (#7420) * Docker Swarm service discovery Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2020-06-26 03:25:58 -07:00
### `<dockerswarm_sd_config>`
Docker Swarm SD configurations allow retrieving scrape targets from [Docker Swarm](https://docs.docker.com/engine/swarm/)
engine.
One of the following roles can be configured to discover targets:
#### `services`
Docker Swarm SD: Support tasks and service without published ports (#7686) * Support tasks and service without published ports Mimics k8s discovery behaviour. Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2020-07-29 11:56:30 -07:00
The `services` role discovers all [Swarm services](https://docs.docker.com/engine/swarm/key-concepts/#services-and-tasks)
and exposes their ports as targets. For each published port of a service, a
single target is generated. If a service has no published ports, a target per
service is created using the `port` parameter defined in the SD configuration.
Docker Swarm service discovery (#7420) * Docker Swarm service discovery Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2020-06-26 03:25:58 -07:00
Available meta labels:
* `__meta_dockerswarm_service_id`: the id of the service
* `__meta_dockerswarm_service_name`: the name of the service
* `__meta_dockerswarm_service_mode`: the mode of the service
* `__meta_dockerswarm_service_endpoint_port_name`: the name of the endpoint port, if available
* `__meta_dockerswarm_service_endpoint_port_publish_mode`: the publish mode of the endpoint port
* `__meta_dockerswarm_service_label_<labelname>`: each label of the service
* `__meta_dockerswarm_service_task_container_hostname`: the container hostname of the target, if available
* `__meta_dockerswarm_service_task_container_image`: the container image of the target
* `__meta_dockerswarm_service_updating_status`: the status of the service, if available
* `__meta_dockerswarm_network_id`: the ID of the network
* `__meta_dockerswarm_network_name`: the name of the network
* `__meta_dockerswarm_network_ingress`: whether the network is ingress
* `__meta_dockerswarm_network_internal`: whether the network is internal
* `__meta_dockerswarm_network_label_<labelname>`: each label of the network
* `__meta_dockerswarm_network_scope`: the scope of the network
#### `tasks`
Docker Swarm SD: Support tasks and service without published ports (#7686) * Support tasks and service without published ports Mimics k8s discovery behaviour. Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2020-07-29 11:56:30 -07:00
The `tasks` role discovers all [Swarm tasks](https://docs.docker.com/engine/swarm/key-concepts/#services-and-tasks)
and exposes their ports as targets. For each published port of a task, a single
target is generated. If a task has no published ports, a target per task is
created using the `port` parameter defined in the SD configuration.
Docker Swarm service discovery (#7420) * Docker Swarm service discovery Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2020-06-26 03:25:58 -07:00
Available meta labels:
* `__meta_dockerswarm_task_id`: the id of the task
* `__meta_dockerswarm_task_container_id`: the container id of the task
* `__meta_dockerswarm_task_desired_state`: the desired state of the task
* `__meta_dockerswarm_task_label_<labelname>`: each label of the task
* `__meta_dockerswarm_task_slot`: the slot of the task
* `__meta_dockerswarm_task_state`: the state of the task
* `__meta_dockerswarm_task_port_publish_mode`: the publish mode of the task port
* `__meta_dockerswarm_service_id`: the id of the service
* `__meta_dockerswarm_service_name`: the name of the service
* `__meta_dockerswarm_service_mode`: the mode of the service
* `__meta_dockerswarm_service_label_<labelname>`: each label of the service
* `__meta_dockerswarm_network_id`: the ID of the network
* `__meta_dockerswarm_network_name`: the name of the network
* `__meta_dockerswarm_network_ingress`: whether the network is ingress
* `__meta_dockerswarm_network_internal`: whether the network is internal
* `__meta_dockerswarm_network_label_<labelname>`: each label of the network
* `__meta_dockerswarm_network_label`: each label of the network
* `__meta_dockerswarm_network_scope`: the scope of the network
* `__meta_dockerswarm_node_id`: the ID of the node
* `__meta_dockerswarm_node_hostname`: the hostname of the node
* `__meta_dockerswarm_node_address`: the address of the node
* `__meta_dockerswarm_node_availability`: the availability of the node
* `__meta_dockerswarm_node_label_<labelname>`: each label of the node
* `__meta_dockerswarm_node_platform_architecture`: the architecture of the node
* `__meta_dockerswarm_node_platform_os`: the operating system of the node
* `__meta_dockerswarm_node_role`: the role of the node
* `__meta_dockerswarm_node_status`: the status of the node
The `__meta_dockerswarm_network_*` meta labels are not populated for ports which
are published with `mode=host`.
#### `nodes`
The `nodes` role is used to discover [Swarm nodes](https://docs.docker.com/engine/swarm/key-concepts/#nodes).
Available meta labels:
* `__meta_dockerswarm_node_address`: the address of the node
* `__meta_dockerswarm_node_availability`: the availability of the node
* `__meta_dockerswarm_node_engine_version`: the version of the node engine
* `__meta_dockerswarm_node_hostname`: the hostname of the node
* `__meta_dockerswarm_node_id`: the ID of the node
* `__meta_dockerswarm_node_label_<labelname>`: each label of the node
* `__meta_dockerswarm_node_manager_address`: the address of the manager component of the node
* `__meta_dockerswarm_node_manager_leader`: the leadership status of the manager component of the node (true or false)
* `__meta_dockerswarm_node_manager_reachability`: the reachability of the manager component of the node
* `__meta_dockerswarm_node_platform_architecture`: the architecture of the node
* `__meta_dockerswarm_node_platform_os`: the operating system of the node
* `__meta_dockerswarm_node_role`: the role of the node
* `__meta_dockerswarm_node_status`: the status of the node
See below for the configuration options for Docker Swarm discovery:
```yaml
# Address of the Docker daemon.
host: <string>
# Optional proxy URL.
[ proxy_url: <string> ]
# TLS configuration.
tls_config:
[ <tls_config> ]
# Role of the targets to retrieve. Must be `services`, `tasks`, or `nodes`.
role: <string>
Docker Swarm SD: Support tasks and service without published ports (#7686) * Support tasks and service without published ports Mimics k8s discovery behaviour. Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2020-07-29 11:56:30 -07:00
# The port to scrape metrics from, when `role` is nodes, and for discovered
# tasks and services that don't have published ports.
Docker Swarm service discovery (#7420) * Docker Swarm service discovery Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2020-06-26 03:25:58 -07:00
[ port: <int> | default = 80 ]
Docker swarm: add filtering of services (#8074) * Docker swarm: add filtering of services Add filters on all docker swarm roles (nodes, tasks and services). Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2020-11-09 03:41:02 -08:00
# Optional filters to limit the discovery process to a subset of available
# resources.
# The available filters are listed in the upstream documentation:
Implement Docker discovery (#8629) * Implement Docker discovery Signed-off-by: Robert Jacob <xperimental@solidproject.de>
2021-03-29 13:30:23 -07:00
# https://docs.docker.com/engine/api/v1.40/#operation/ContainerList
Docker swarm: add filtering of services (#8074) * Docker swarm: add filtering of services Add filters on all docker swarm roles (nodes, tasks and services). Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2020-11-09 03:41:02 -08:00
[ filters:
[ - name: <string>
values: <string>, [...] ]
Implement Docker discovery (#8629) * Implement Docker discovery Signed-off-by: Robert Jacob <xperimental@solidproject.de>
2021-03-29 13:30:23 -07:00
# The time after which the service discovery data is refreshed.
Docker Swarm service discovery (#7420) * Docker Swarm service discovery Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2020-06-26 03:25:58 -07:00
[ refresh_interval: <duration> | default = 60s ]
# Authentication information used to authenticate to the Docker daemon.
Update common to support credentials type Most of the backwards compat tests is done in common. Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2021-02-18 14:14:49 -08:00
# Note that `basic_auth` and `authorization` options are
Docker Swarm service discovery (#7420) * Docker Swarm service discovery Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2020-06-26 03:25:58 -07:00
# mutually exclusive.
# password and password_file are mutually exclusive.
# Optional HTTP basic authentication information.
basic_auth:
[ username: <string> ]
[ password: <secret> ]
[ password_file: <string> ]
http_sd (#8839) Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2021-06-11 09:04:45 -07:00
# Optional `Authorization` header configuration.
Update common to support credentials type Most of the backwards compat tests is done in common. Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2021-02-18 14:14:49 -08:00
authorization:
# Sets the authentication type.
[ type: <string> | default: Bearer ]
# Sets the credentials. It is mutually exclusive with
# `credentials_file`.
[ credentials: <secret> ]
http_sd (#8839) Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2021-06-11 09:04:45 -07:00
# Sets the credentials to the credentials read from the configured file.
Update common to support credentials type Most of the backwards compat tests is done in common. Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2021-02-18 14:14:49 -08:00
# It is mutually exclusive with `credentials`.
[ credentials_file: <filename> ]
Support follow_redirect This PR introduces support for follow_redirect, to enable users to disable following HTTP redirects. Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2021-02-26 13:48:06 -08:00
Add OAuth 2.0 Config (#8761) * Introduced oauth2 config into the codebase Signed-off-by: Levi Harrison <git@leviharrison.dev>
2021-04-28 05:47:52 -07:00
# Optional OAuth 2.0 configuration.
# Cannot be used at the same time as basic_auth or authorization.
oauth2:
[ <oauth2> ]
Support follow_redirect This PR introduces support for follow_redirect, to enable users to disable following HTTP redirects. Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2021-02-26 13:48:06 -08:00
# Configure whether HTTP requests follow HTTP 3xx redirects.
[ follow_redirects: <bool> | default = true ]
Docker Swarm service discovery (#7420) * Docker Swarm service discovery Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2020-06-26 03:25:58 -07:00
```
Docker swarm: add filtering of services (#8074) * Docker swarm: add filtering of services Add filters on all docker swarm roles (nodes, tasks and services). Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2020-11-09 03:41:02 -08:00
The [relabeling phase](#relabel_config) is the preferred and more powerful
way to filter tasks, services or nodes. For users with thousands of tasks it
can be more efficient to use the Swarm API directly which has basic support for
filtering nodes (using `filters`).
Add Docker Swarm configuration example (#7542) Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2020-07-09 11:05:21 -07:00
See [this example Prometheus configuration file](/documentation/examples/prometheus-dockerswarm.yml)
for a detailed example of configuring Prometheus for Docker Swarm.
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
### `<dns_sd_config>`
A DNS-based service discovery configuration allows specifying a set of DNS
domain names which are periodically queried to discover a list of targets. The
DNS servers to be contacted are read from `/etc/resolv.conf`.
This service discovery method only supports basic DNS A, AAAA and SRV record
queries, but not the advanced DNS-SD approach specified in
[RFC6763](https://tools.ietf.org/html/rfc6763).
DNS SD: add srv record target and port meta labels (#7678) * DNS SD: add srv record target and port meta labels Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2020-07-28 13:09:01 -07:00
The following meta labels are available on targets during [relabeling](#relabel_config):
* `__meta_dns_name`: the record name that produced the discovered target.
* `__meta_dns_srv_record_target`: the target field of the SRV record
* `__meta_dns_srv_record_port`: the port field of the SRV record
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
```yaml
# A list of DNS domain names to be queried.
names:
Fix types in k8s+dns docs (#7474) Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2020-06-28 00:13:23 -07:00
[ - <string> ]
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
Fix types in k8s+dns docs (#7474) Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2020-06-28 00:13:23 -07:00
# The type of DNS query to perform. One of SRV, A, or AAAA.
[ type: <string> | default = 'SRV' ]
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
# The port number used if the query type is not SRV.
Docs: fix types (#7508) I have batched a bunch of fixes around types in the documentation. Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2020-07-02 14:27:14 -07:00
[ port: <int>]
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
# The time after which the provided names are refreshed.
[ refresh_interval: <duration> | default = 30s ]
```
### `<ec2_sd_config>`
EC2 SD configurations allow retrieving scrape targets from AWS EC2
instances. The private IP address is used by default, but may be changed to
the public IP address with relabeling.
The following meta labels are available on targets during [relabeling](#relabel_config):
Add AMI to labels scraped during service discovery. (#7386) Signed-off-by: Martin Lee <martin@martinlee.org>
2020-06-11 10:25:58 -07:00
* `__meta_ec2_ami`: the EC2 Amazon Machine Image
Fix #6999 : Add architecture meta label for EC2 (#7000) This PR adds architecture meta labels for EC2 instances Signed-off-by: Deepjyoti Mondal <djmdeveloper060796@gmail.com>
2020-03-28 13:41:37 -07:00
* `__meta_ec2_architecture`: the architecture of the instance
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
* `__meta_ec2_availability_zone`: the availability zone in which the instance is running
Merge release 2.29 in main (#9196) * PromQL: Fix start and end keywords masking label and metric names This commit fixes an issue with the "at modifier" that introduced two new keywords: `start` and `end`. In grouping options and in metric names, these keywords took precedence over metric or label names, so that those metrics and labels could no longer be referenced. Signed-off-by: Clayton Peters <clayton.peters@man.com> * Add in additional tests for metrics and/or labels called start/end. Signed-off-by: Clayton Peters <clayton.peters@man.com> * *: Cut 2.29.0-rc.0 Signed-off-by: Frederic Branczyk <fbranczyk@gmail.com> * VERSION: bump to 2.29.0-rc.0 Signed-off-by: Frederic Branczyk <fbranczyk@gmail.com> * Remove experimental wording on size-based retention Followup of #9004 Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu> * Fix PR reference in changelog Signed-off-by: George Brighton <george@gebn.co.uk> * Describe EC2 availability zone IDs at most once per refresh (#9142) Signed-off-by: George Brighton <george@gebn.co.uk> * Describe EC2 availability zones at most once per SD load Closes #9142. Signed-off-by: George Brighton <george@gebn.co.uk> * Incorporate feedback Signed-off-by: George Brighton <george@gebn.co.uk> * Integrate feedback Signed-off-by: George Brighton <george@gebn.co.uk> * Add a compatibility note for macOS users. Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu> * *: Cut v2.29.0-rc.1 Signed-off-by: Frederic Branczyk <fbranczyk@gmail.com> * Fix `kuma_sd` targetgroup reporting (#9157) * Bundle all xDS targets into a single group Signed-off-by: austin ce <austin.cawley@gmail.com> * *: cut v2.29.0-rc.2 Signed-off-by: Frederic Branczyk <fbranczyk@gmail.com> * Rename links Signed-off-by: Levi Harrison <git@leviharrison.dev> * bump codemirror-promql to 0.17.0 Signed-off-by: Augustin Husson <husson.augustin@gmail.com> * *: cut v2.29.0 Signed-off-by: Frederic Branczyk <fbranczyk@gmail.com> * tsdb: align atomically accessed int64 (#9192) This prevents a panic in 32-bit archs: https://pkg.go.dev/sync/atomic#pkg-note-BUG Fixed #9190 Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu> * Release 2.29.1 (#9193) Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu> Co-authored-by: Clayton Peters <clayton.peters@man.com> Co-authored-by: Frederic Branczyk <fbranczyk@gmail.com> Co-authored-by: George Brighton <george@gebn.co.uk> Co-authored-by: Austin Cawley-Edwards <austin.cawley@gmail.com> Co-authored-by: Levi Harrison <git@leviharrison.dev> Co-authored-by: Augustin Husson <husson.augustin@gmail.com>
2021-08-12 09:38:06 -07:00
* `__meta_ec2_availability_zone_id`: the [availability zone ID](https://docs.aws.amazon.com/ram/latest/userguide/working-with-az-ids.html) in which the instance is running (requires `ec2:DescribeAvailabilityZones`)
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
* `__meta_ec2_instance_id`: the EC2 instance ID
Expose EC2 instance lifecycle as label (#6914) Signed-off-by: Alex Gaganov <alex.gaganov@fiverr.com>
2020-03-03 00:03:16 -08:00
* `__meta_ec2_instance_lifecycle`: the lifecycle of the EC2 instance, set only for 'spot' or 'scheduled' instances, absent otherwise
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
* `__meta_ec2_instance_state`: the state of the EC2 instance
* `__meta_ec2_instance_type`: the type of the EC2 instance
Fix a typo in docs/configuration/configuration.md Signed-off-by: Hu Shuai <hus.fnst@cn.fujitsu.com>
2021-01-17 18:14:47 -08:00
* `__meta_ec2_ipv6_addresses`: comma separated list of IPv6 addresses assigned to the instance's network interfaces, if present
Expose EC2 instance owner as a discovery label. This exposes the OwnerID field of the DescribeInstances respons as . Signed-off-by: Javier Kohen <jkohen@google.com>
2018-08-17 08:30:18 -07:00
* `__meta_ec2_owner_id`: the ID of the AWS account that owns the EC2 instance
EC2 Platform meta label (#4663) Set __meta_ec2_platform label with the instance platform string. Set to 'windows' on Windows servers and absent otherwise. Signed-off-by: Silvio Gissi <silvio@gissilabs.com>
2018-11-06 06:39:48 -08:00
* `__meta_ec2_platform`: the Operating System platform, set to 'windows' on Windows servers, absent otherwise
discovery/ec2: Add primary_subnet_id label Signed-off-by: José Martínez <xosemp@gmail.com>
2018-07-25 00:38:14 -07:00
* `__meta_ec2_primary_subnet_id`: the subnet ID of the primary network interface, if available
Adding private_dns_name to the list of ec2 labels which can be used i… (#4693) * Adding private_dns_name to the list of ec2 labels which can be used in node naming for dynamic environments Signed-off-by: Serghei Anicheev <serghei@rentalcover.com>
2018-11-30 03:11:06 -08:00
* `__meta_ec2_private_dns_name`: the private DNS name of the instance, if available
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
* `__meta_ec2_private_ip`: the private IP address of the instance, if present
* `__meta_ec2_public_dns_name`: the public DNS name of the instance, if available
* `__meta_ec2_public_ip`: the public IP address of the instance, if available
* `__meta_ec2_subnet_id`: comma separated list of subnets IDs in which the instance is running, if available
* `__meta_ec2_tag_<tagkey>`: each tag value of the instance
* `__meta_ec2_vpc_id`: the ID of the VPC in which the instance is running, if available
See below for the configuration options for EC2 discovery:
```yaml
# The information to access the EC2 API.
Document behavior of empty ec2_sd_config region (#5711) Document the behavior of an empty `ec2_sd_config` `region` setting. If this is omitted or blank, the region is discovered from the instance metadata, if available. If it is blank and instance region metadata is not available, an error will result ("EC2 SD configuration requires a region"). Signed-off-by: Svend Sorensen <svend@svends.net>
2019-06-27 10:35:54 -07:00
# The AWS region. If blank, the region from the instance metadata is used.
[ region: <string> ]
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
EC2 Discovery: Allow to set a custom endpoint (#4333) Allowing to set a custom endpoint makes it easy to monitor targets on non AWS providers with EC2 compliant APIs. Signed-off-by: Jannick Fahlbusch <git@jf-projects.de>
2018-07-18 02:48:14 -07:00
# Custom endpoint to be used.
[ endpoint: <string> ]
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
# The AWS API keys. If blank, the environment variables `AWS_ACCESS_KEY_ID`
# and `AWS_SECRET_ACCESS_KEY` are used.
[ access_key: <string> ]
[ secret_key: <secret> ]
# Named AWS profile used to connect to the API.
[ profile: <string> ]
Include 1.8 changes in configuration docs
2017-10-10 10:55:29 -07:00
# AWS Role ARN, an alternative to using AWS API keys.
[ role_arn: <string> ]
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
# Refresh interval to re-read the instance list.
[ refresh_interval: <duration> | default = 60s ]
# The port to scrape metrics from. If using the public IP address, this must
# instead be specified in the relabeling rule.
[ port: <int> | default = 80 ]
discovery/ec2: Support filtering instances in discovery (#4011)
2018-03-30 23:51:11 -07:00
# Filters can be used optionally to filter the instance list by other criteria.
# Available filter criteria can be found here:
# https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances.html
# Filter API documentation: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_Filter.html
filters:
[ - name: <string>
values: <string>, [...] ]
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
```
discovery/ec2: Support filtering instances in discovery (#4011)
2018-03-30 23:51:11 -07:00
The [relabeling phase](#relabel_config) is the preferred and more powerful
way to filter targets based on arbitrary labels. For users with thousands of
instances it can be more efficient to use the EC2 API directly which has
support for filtering instances.
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
### `<openstack_sd_config>`
Add 2.0 stability guarantees (#3484) As discussed generally consider SDs as unstable, as realistically they are never going to be. Drop the words "experimental/beta" from most places in the docs, as users are getting the wrong impression from this.
2017-12-14 04:54:32 -08:00
OpenStack SD configurations allow retrieving scrape targets from OpenStack Nova
instances.
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
docs: fix OpenStack SD for the hypervisor role Signed-off-by: Simon Pasquier <spasquie@redhat.com>
2018-07-13 07:48:54 -07:00
One of the following `<openstack_role>` types can be configured to discover targets:
#### `hypervisor`
The `hypervisor` role discovers one target per Nova hypervisor node. The target
address defaults to the `host_ip` attribute of the hypervisor.
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
The following meta labels are available on targets during [relabeling](#relabel_config):
docs: fix OpenStack SD for the hypervisor role Signed-off-by: Simon Pasquier <spasquie@redhat.com>
2018-07-13 07:48:54 -07:00
* `__meta_openstack_hypervisor_host_ip`: the hypervisor node's IP address.
[OpenStack SD] Add HypervisorID meta labels about id (#6962) Add extra meta labels which will be useful in the case Prometheus discovery hypervisor . Signed-off-by: pzqu <pzqu@qq.com> Co-authored-by: pzqu <pzqu@example.com>
2020-03-11 01:38:14 -07:00
* `__meta_openstack_hypervisor_id`: the hypervisor node's ID.
docs: fix OpenStack SD for the hypervisor role Signed-off-by: Simon Pasquier <spasquie@redhat.com>
2018-07-13 07:48:54 -07:00
* `__meta_openstack_hypervisor_name`: the hypervisor node's name.
* `__meta_openstack_hypervisor_state`: the hypervisor node's state.
* `__meta_openstack_hypervisor_status`: the hypervisor node's status.
* `__meta_openstack_hypervisor_type`: the hypervisor node's type.
Update the openstack_sd_config section openstack_sd_config requires a 'role' parameter which wasn't documented.
2017-12-08 07:00:03 -08:00
#### `instance`
discovery/openstack: discover all interfaces (#4649) * discovery/openstack: discover all interfaces * Add address pool label Signed-off-by: Simon Pasquier <spasquie@redhat.com>
2018-10-09 08:17:08 -07:00
The `instance` role discovers one target per network interface of Nova
instance. The target address defaults to the private IP address of the network
interface.
Update the openstack_sd_config section openstack_sd_config requires a 'role' parameter which wasn't documented.
2017-12-08 07:00:03 -08:00
The following meta labels are available on targets during [relabeling](#relabel_config):
[OpenStack SD] Add ProjectID and UserID meta labels (#5431) Add extra meta labels which will be useful in the case Prometheus discovery instances from all projects. Signed-off-by: Kien Nguyen <kiennt2609@gmail.com>
2019-04-04 02:02:31 -07:00
* `__meta_openstack_address_pool`: the pool of the private IP.
* `__meta_openstack_instance_flavor`: the flavor of the OpenStack instance.
Update the openstack_sd_config section openstack_sd_config requires a 'role' parameter which wasn't documented.
2017-12-08 07:00:03 -08:00
* `__meta_openstack_instance_id`: the OpenStack instance ID.
* `__meta_openstack_instance_name`: the OpenStack instance name.
* `__meta_openstack_instance_status`: the status of the OpenStack instance.
* `__meta_openstack_private_ip`: the private IP of the OpenStack instance.
[OpenStack SD] Add ProjectID and UserID meta labels (#5431) Add extra meta labels which will be useful in the case Prometheus discovery instances from all projects. Signed-off-by: Kien Nguyen <kiennt2609@gmail.com>
2019-04-04 02:02:31 -07:00
* `__meta_openstack_project_id`: the project (tenant) owning this instance.
* `__meta_openstack_public_ip`: the public IP of the OpenStack instance.
Update the openstack_sd_config section openstack_sd_config requires a 'role' parameter which wasn't documented.
2017-12-08 07:00:03 -08:00
* `__meta_openstack_tag_<tagkey>`: each tag value of the instance.
[OpenStack SD] Add ProjectID and UserID meta labels (#5431) Add extra meta labels which will be useful in the case Prometheus discovery instances from all projects. Signed-off-by: Kien Nguyen <kiennt2609@gmail.com>
2019-04-04 02:02:31 -07:00
* `__meta_openstack_user_id`: the user account owning the tenant.
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
See below for the configuration options for OpenStack discovery:
```yaml
# The information to access the OpenStack API.
Update the openstack_sd_config section openstack_sd_config requires a 'role' parameter which wasn't documented.
2017-12-08 07:00:03 -08:00
# The OpenStack role of entities that should be discovered.
docs: fix OpenStack SD for the hypervisor role Signed-off-by: Simon Pasquier <spasquie@redhat.com>
2018-07-13 07:48:54 -07:00
role: <openstack_role>
Update the openstack_sd_config section openstack_sd_config requires a 'role' parameter which wasn't documented.
2017-12-08 07:00:03 -08:00
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
# The OpenStack Region.
region: <string>
# identity_endpoint specifies the HTTP endpoint that is required to work with
# the Identity API of the appropriate version. While it's ultimately needed by
# all of the identity services, it will often be populated by a provider-level
# function.
[ identity_endpoint: <string> ]
# username is required if using Identity V2 API. Consult with your provider's
# control panel to discover your account's username. In Identity V3, either
# userid or a combination of username and domain_id or domain_name are needed.
[ username: <string> ]
[ userid: <string> ]
# password for the Identity V2 and V3 APIs. Consult with your provider's
# control panel to discover your account's preferred method of authentication.
[ password: <secret> ]
# At most one of domain_id and domain_name must be provided if using username
# with Identity V3. Otherwise, either are optional.
[ domain_name: <string> ]
[ domain_id: <string> ]
# The project_id and project_name fields are optional for the Identity V2 API.
# Some providers allow you to specify a project_name instead of the project_id.
# Some require both. Your provider's authentication policies will determine
# how these fields influence authentication.
[ project_name: <string> ]
[ project_id: <string> ]
openstack_sd: Supporting application credential for authentication. (#4968) * openstack_sd: Support application credentials for authentication. Updated gophercloud Signed-off-by: Kevin Bulebush <kmbulebu@gmail.com>
2019-01-09 07:18:58 -08:00
# The application_credential_id or application_credential_name fields are
# required if using an application credential to authenticate. Some providers
# allow you to create an application credential to authenticate rather than a
# password.
[ application_credential_name: <string> ]
[ application_credential_id: <string> ]
# The application_credential_secret field is required if using an application
# credential to authenticate.
[ application_credential_secret: <secret> ]
Support discover instances from all projects (#4682) By default, OpenStack SD only queries for instances from specified project. To discover instances from other projects, users have to add more openstack_sd_configs for each project. This patch adds `all_tenants` <bool> options to openstack_sd_configs. For example: - job_name: 'openstack_all_instances' openstack_sd_configs: - role: instance region: RegionOne identity_endpoint: http://<identity_server>/identity/v3 username: <username> password: <super_secret_password> domain_name: Default all_tenants: true Co-authored-by: Kien Nguyen <kiennt2609@gmail.com> Signed-off-by: dmatosl <danielmatos.lima@gmail.com>
2018-10-17 05:01:33 -07:00
# Whether the service discovery should list all instances for all projects.
# It is only relevant for the 'instance' role and usually requires admin permissions.
[ all_tenants: <boolean> | default: false ]
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
# Refresh interval to re-read the instance list.
[ refresh_interval: <duration> | default = 60s ]
# The port to scrape metrics from. If using the public IP address, this must
# instead be specified in the relabeling rule.
[ port: <int> | default = 80 ]
discovery/openstack: support tls_config Signed-off-by: Simon Pasquier <spasquie@redhat.com>
2018-09-24 07:08:42 -07:00
OpenStack SD: Add availability config option, to choose endpoint type (#7494) * OpenStack SD: Add availability config option, to choose endpoint type In some environments Prometheus must query OpenStack via an alternative endpoint type (gophercloud calls this `availability`. This commit implements this option. Co-Authored-By: Dennis Kuhn <d.kuhn@syseleven.de> Signed-off-by: Steffen Neubauer <s.neubauer@syseleven.de>
2020-07-02 07:17:56 -07:00
# The availability of the endpoint to connect to. Must be one of public, admin or internal.
[ availability: <string> | default = "public" ]
discovery/openstack: support tls_config Signed-off-by: Simon Pasquier <spasquie@redhat.com>
2018-09-24 07:08:42 -07:00
# TLS configuration.
tls_config:
[ <tls_config> ]
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
```
Add PuppetDB service discovery We have been Puppet user for 10 years and we are users of https://github.com/camptocamp/prometheus-puppetdb-sd However, that file_sd implementation contains business logic and assumptions around e.g. the modules which you are using. This pull request adds a simple PuppetDB service discovery, which will enable more use cases than the upstream sd. Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2021-06-01 05:04:58 -07:00
### `<puppetdb_sd_config>`
PuppetDB SD configurations allow retrieving scrape targets from
[PuppetDB](https://puppet.com/docs/puppetdb/latest/index.html) resources.
This SD discovers resources and will create a target for each resource returned
by the API.
The resource address is the `certname` of the resource and can be changed during
[relabeling](#relabel_config).
The following meta labels are available on targets during [relabeling](#relabel_config):
* `__meta_puppetdb_certname`: the name of the node associated with the resource
* `__meta_puppetdb_resource`: a SHA-1 hash of the resource’s type, title, and parameters, for identification
* `__meta_puppetdb_type`: the resource type
* `__meta_puppetdb_title`: the resource title
* `__meta_puppetdb_exported`: whether the resource is exported (`"true"` or `"false"`)
* `__meta_puppetdb_tags`: comma separated list of resource tags
* `__meta_puppetdb_file`: the manifest file in which the resource was declared
* `__meta_puppetdb_environment`: the environment of the node associated with the resource
* `__meta_puppetdb_parameter_<parametername>`: the parameters of the resource
See below for the configuration options for PuppetDB discovery:
```yaml
# The URL of the PuppetDB root query endpoint.
url: <string>
# Puppet Query Language (PQL) query. Only resources are supported.
# https://puppet.com/docs/puppetdb/latest/api/query/v4/pql.html
query: <string>
# Whether to include the parameters as meta labels.
# Due to the differences between parameter types and Prometheus labels,
# some parameters might not be rendered. The format of the parameters might
# also change in future releases.
#
# Note: Enabling this exposes parameters in the Prometheus UI and API. Make sure
# that you don't have secrets exposed as parameters if you enable this.
[ include_parameters: <boolean> | default = false ]
# Refresh interval to re-read the resources list.
[ refresh_interval: <duration> | default = 60s ]
# The port to scrape metrics from.
[ port: <int> | default = 80 ]
# TLS configuration to connect to the PuppetDB.
tls_config:
[ <tls_config> ]
# basic_auth, authorization, and oauth2, are mutually exclusive.
# Optional HTTP basic authentication information.
basic_auth:
[ username: <string> ]
[ password: <secret> ]
[ password_file: <string> ]
# `Authorization` HTTP header configuration.
authorization:
# Sets the authentication type.
[ type: <string> | default: Bearer ]
# Sets the credentials. It is mutually exclusive with
# `credentials_file`.
[ credentials: <secret> ]
# Sets the credentials with the credentials read from the configured file.
# It is mutually exclusive with `credentials`.
[ credentials_file: <filename> ]
# Optional OAuth 2.0 configuration.
# Cannot be used at the same time as basic_auth or authorization.
oauth2:
[ <oauth2> ]
# Optional proxy URL.
[ proxy_url: <string> ]
# Configure whether HTTP requests follow HTTP 3xx redirects.
[ follow_redirects: <bool> | default = true ]
```
See [this example Prometheus configuration file](/documentation/examples/prometheus-puppetdb.yml)
for a detailed example of configuring Prometheus with PuppetDB.
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
### `<file_sd_config>`
File-based service discovery provides a more generic way to configure static targets
and serves as an interface to plug in custom service discovery mechanisms.
It reads a set of files containing a list of zero or more
`<static_config>`s. Changes to all defined files are detected via disk watches
and applied immediately. Files may be provided in YAML or JSON format. Only
changes resulting in well-formed target groups are applied.
Updated documentation (#5390) Updated documentation to include YAML example for file_sd_config Signed-off-by: Lars Nielsen <nellemandela@gmail.com>
2020-08-03 07:36:33 -07:00
Files must contain a list of static configs, using these formats:
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
Updated documentation (#5390) Updated documentation to include YAML example for file_sd_config Signed-off-by: Lars Nielsen <nellemandela@gmail.com>
2020-08-03 07:36:33 -07:00
**JSON**
```json
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
[
{
"targets": [ "<host>", ... ],
"labels": {
"<labelname>": "<labelvalue>", ...
}
},
...
]
```
Updated documentation (#5390) Updated documentation to include YAML example for file_sd_config Signed-off-by: Lars Nielsen <nellemandela@gmail.com>
2020-08-03 07:36:33 -07:00
**YAML**
```yaml
- targets:
[ - '<host>' ]
labels:
[ <labelname>: <labelvalue> ... ]
```
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
As a fallback, the file contents are also re-read periodically at the specified
refresh interval.
Each target has a meta label `__meta_filepath` during the
[relabeling phase](#relabel_config). Its value is set to the
filepath from which the target was extracted.
There is a list of
Add prefix to relative 3 URLs (#3551)
2017-12-06 13:16:53 -08:00
[integrations](https://prometheus.io/docs/operating/integrations/#file-service-discovery) with this
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
discovery mechanism.
```yaml
# Patterns for files from which target groups are extracted.
files:
[ - <filename_pattern> ... ]
# Refresh interval to re-read the files.
[ refresh_interval: <duration> | default = 5m ]
```
Where `<filename_pattern>` may be a path ending in `.json`, `.yml` or `.yaml`. The last path segment
may contain a single `*` that matches any character sequence, e.g. `my/path/tg_*.json`.
### `<gce_sd_config>`
[GCE](https://cloud.google.com/compute/) SD configurations allow retrieving scrape targets from GCP GCE instances.
The private IP address is used by default, but may be changed to the public IP
address with relabeling.
The following meta labels are available on targets during [relabeling](#relabel_config):
Document the new __meta_gce_instance_id discovery label. Signed-off-by: Javier Kohen <jkohen@google.com>
2018-08-10 08:59:22 -07:00
* `__meta_gce_instance_id`: the numeric id of the instance
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
* `__meta_gce_instance_name`: the name of the instance
Docker Swarm service discovery (#7420) * Docker Swarm service discovery Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2020-06-26 03:25:58 -07:00
* `__meta_gce_label_<labelname>`: each GCE label of the instance
Add a machine type label to GCE SD (#4032)
2018-03-31 01:20:19 -07:00
* `__meta_gce_machine_type`: full or partial URL of the machine type of the instance
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
* `__meta_gce_metadata_<name>`: each metadata item of the instance
* `__meta_gce_network`: the network URL of the instance
* `__meta_gce_private_ip`: the private IP address of the instance
chore: always append interface ipv4 with api interface name Signed-off-by: Joey Freeland <joey@free.land>
2021-06-27 18:03:10 -07:00
* `__meta_gce_interface_ipv4_<name>`: IPv4 address of each named interface
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
* `__meta_gce_project`: the GCP project in which the instance is running
* `__meta_gce_public_ip`: the public IP address of the instance, if present
* `__meta_gce_subnetwork`: the subnetwork URL of the instance
* `__meta_gce_tags`: comma separated list of instance tags
* `__meta_gce_zone`: the GCE zone URL in which the instance is running
See below for the configuration options for GCE discovery:
```yaml
# The information to access the GCE API.
# The GCP Project
project: <string>
# The zone of the scrape targets. If you need multiple zones use multiple
# gce_sd_configs.
zone: <string>
# Filter can be used optionally to filter the instance list by other criteria
Integrate changes from prometheus/docs
2017-10-26 06:42:07 -07:00
# Syntax of this filter string is described here in the filter query parameter section:
# https://cloud.google.com/compute/docs/reference/latest/instances/list
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
[ filter: <string> ]
# Refresh interval to re-read the instance list
[ refresh_interval: <duration> | default = 60s ]
# The port to scrape metrics from. If using the public IP address, this must
# instead be specified in the relabeling rule.
[ port: <int> | default = 80 ]
# The tag separator is used to separate the tags on concatenation
[ tag_separator: <string> | default = , ]
```
Credentials are discovered by the Google Cloud SDK default client by looking
in the following places, preferring the first location found:
1. a JSON file specified by the `GOOGLE_APPLICATION_CREDENTIALS` environment variable
2. a JSON file in the well-known path `$HOME/.config/gcloud/application_default_credentials.json`
3. fetched from the GCE metadata server
If Prometheus is running within GCE, the service account associated with the
instance it is running on should have at least read-only permissions to the
compute resources. If running outside of GCE make sure to create an appropriate
service account and place the credential file in one of the expected locations.
Add hetzner service discovery (#7822) Signed-off-by: Lukas Kämmerling <lukas.kaemmerling@hetzner-cloud.de>
2020-08-21 06:49:19 -07:00
### `<hetzner_sd_config>`
Improve hetzner documentation (#7849) * Improve hetzner documentation Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2020-08-25 11:51:54 -07:00
Hetzner SD configurations allow retrieving scrape targets from
[Hetzner](https://www.hetzner.com/) [Cloud](https://www.hetzner.cloud/) API and
[Robot](https://docs.hetzner.com/robot/) API.
Add hetzner service discovery (#7822) Signed-off-by: Lukas Kämmerling <lukas.kaemmerling@hetzner-cloud.de>
2020-08-21 06:49:19 -07:00
This service discovery uses the public IPv4 address by default, but that can be
changed with relabeling, as demonstrated in [the Prometheus hetzner-sd
configuration file](/documentation/examples/prometheus-hetzner.yml).
The following meta labels are available on all targets during [relabeling](#relabel_config):
Hetzner: fix lists in documentation (#7863) The lists are inlined without empty lines upfront. Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2020-08-28 02:38:24 -07:00
Improve hetzner documentation (#7849) * Improve hetzner documentation Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2020-08-25 11:51:54 -07:00
* `__meta_hetzner_server_id`: the ID of the server
Add hetzner service discovery (#7822) Signed-off-by: Lukas Kämmerling <lukas.kaemmerling@hetzner-cloud.de>
2020-08-21 06:49:19 -07:00
* `__meta_hetzner_server_name`: the name of the server
* `__meta_hetzner_server_status`: the status of the server
Improve hetzner documentation (#7849) * Improve hetzner documentation Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2020-08-25 11:51:54 -07:00
* `__meta_hetzner_public_ipv4`: the public ipv4 address of the server
* `__meta_hetzner_public_ipv6_network`: the public ipv6 network (/64) of the server
* `__meta_hetzner_datacenter`: the datacenter of the server
Add hetzner service discovery (#7822) Signed-off-by: Lukas Kämmerling <lukas.kaemmerling@hetzner-cloud.de>
2020-08-21 06:49:19 -07:00
The labels below are only available for targets with `role` set to `hcloud`:
Hetzner: fix lists in documentation (#7863) The lists are inlined without empty lines upfront. Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2020-08-28 02:38:24 -07:00
Add hetzner service discovery (#7822) Signed-off-by: Lukas Kämmerling <lukas.kaemmerling@hetzner-cloud.de>
2020-08-21 06:49:19 -07:00
* `__meta_hetzner_hcloud_image_name`: the image name of the server
Improve hetzner documentation (#7849) * Improve hetzner documentation Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2020-08-25 11:51:54 -07:00
* `__meta_hetzner_hcloud_image_description`: the description of the server image
* `__meta_hetzner_hcloud_image_os_flavor`: the OS flavor of the server image
* `__meta_hetzner_hcloud_image_os_version`: the OS version of the server image
* `__meta_hetzner_hcloud_image_description`: the description of the server image
* `__meta_hetzner_hcloud_datacenter_location`: the location of the server
* `__meta_hetzner_hcloud_datacenter_location_network_zone`: the network zone of the server
* `__meta_hetzner_hcloud_server_type`: the type of the server
* `__meta_hetzner_hcloud_cpu_cores`: the CPU cores count of the server
* `__meta_hetzner_hcloud_cpu_type`: the CPU type of the server (shared or dedicated)
* `__meta_hetzner_hcloud_memory_size_gb`: the amount of memory of the server (in GB)
* `__meta_hetzner_hcloud_disk_size_gb`: the disk size of the server (in GB)
* `__meta_hetzner_hcloud_private_ipv4_<networkname>`: the private ipv4 address of the server within a given network
* `__meta_hetzner_hcloud_label_<labelname>`: each label of the server
hcloud discovery: Add new labelpresent label (#9028) * Add new labelpresent label Signed-off-by: Lukas Kämmerling <lukas.kaemmerling@hetzner-cloud.de>
2021-07-02 16:51:50 -07:00
* `__meta_hetzner_hcloud_labelpresent_<labelname>`: `true` for each label of the server
Add hetzner service discovery (#7822) Signed-off-by: Lukas Kämmerling <lukas.kaemmerling@hetzner-cloud.de>
2020-08-21 06:49:19 -07:00
The labels below are only available for targets with `role` set to `robot`:
Hetzner: fix lists in documentation (#7863) The lists are inlined without empty lines upfront. Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2020-08-28 02:38:24 -07:00
Improve hetzner documentation (#7849) * Improve hetzner documentation Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2020-08-25 11:51:54 -07:00
* `__meta_hetzner_robot_product`: the product of the server
* `__meta_hetzner_robot_cancelled`: the server cancellation status
Add hetzner service discovery (#7822) Signed-off-by: Lukas Kämmerling <lukas.kaemmerling@hetzner-cloud.de>
2020-08-21 06:49:19 -07:00
```yaml
# The Hetzner role of entities that should be discovered.
# One of robot or hcloud.
role: <string>
# Authentication information used to authenticate to the API server.
Update common to support credentials type Most of the backwards compat tests is done in common. Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2021-02-18 14:14:49 -08:00
# Note that `basic_auth` and `authorization` options are
Add hetzner service discovery (#7822) Signed-off-by: Lukas Kämmerling <lukas.kaemmerling@hetzner-cloud.de>
2020-08-21 06:49:19 -07:00
# mutually exclusive.
# password and password_file are mutually exclusive.
# Optional HTTP basic authentication information, required when role is robot
# Role hcloud does not support basic auth.
basic_auth:
[ username: <string> ]
[ password: <secret> ]
[ password_file: <string> ]
http_sd (#8839) Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2021-06-11 09:04:45 -07:00
# Optional `Authorization` header configuration, required when role is
Update common to support credentials type Most of the backwards compat tests is done in common. Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2021-02-18 14:14:49 -08:00
# hcloud. Role robot does not support bearer token authentication.
authorization:
# Sets the authentication type.
[ type: <string> | default: Bearer ]
# Sets the credentials. It is mutually exclusive with
# `credentials_file`.
[ credentials: <secret> ]
http_sd (#8839) Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2021-06-11 09:04:45 -07:00
# Sets the credentials to the credentials read from the configured file.
Update common to support credentials type Most of the backwards compat tests is done in common. Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2021-02-18 14:14:49 -08:00
# It is mutually exclusive with `credentials`.
[ credentials_file: <filename> ]
Add hetzner service discovery (#7822) Signed-off-by: Lukas Kämmerling <lukas.kaemmerling@hetzner-cloud.de>
2020-08-21 06:49:19 -07:00
Add OAuth 2.0 Config (#8761) * Introduced oauth2 config into the codebase Signed-off-by: Levi Harrison <git@leviharrison.dev>
2021-04-28 05:47:52 -07:00
# Optional OAuth 2.0 configuration.
# Cannot be used at the same time as basic_auth or authorization.
oauth2:
[ <oauth2> ]
Add hetzner service discovery (#7822) Signed-off-by: Lukas Kämmerling <lukas.kaemmerling@hetzner-cloud.de>
2020-08-21 06:49:19 -07:00
# Optional proxy URL.
[ proxy_url: <string> ]
Support follow_redirect This PR introduces support for follow_redirect, to enable users to disable following HTTP redirects. Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2021-02-26 13:48:06 -08:00
# Configure whether HTTP requests follow HTTP 3xx redirects.
[ follow_redirects: <bool> | default = true ]
Add hetzner service discovery (#7822) Signed-off-by: Lukas Kämmerling <lukas.kaemmerling@hetzner-cloud.de>
2020-08-21 06:49:19 -07:00
# TLS configuration.
tls_config:
[ <tls_config> ]
# The port to scrape metrics from.
[ port: <int> | default = 80 ]
# The time after which the servers are refreshed.
[ refresh_interval: <duration> | default = 60s ]
```
http_sd (#8839) Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2021-06-11 09:04:45 -07:00
### `<http_sd_config>`
HTTP-based service discovery provides a more generic way to configure static targets
and serves as an interface to plug in custom service discovery mechanisms.
It fetches targets from an HTTP endpoint containing a list of zero or more
`<static_config>`s. The target must reply with an HTTP 200 response.
The HTTP header `Content-Type` must be `application/json`, and the body must be
valid JSON.
Example response body:
```json
[
{
"targets": [ "<host>", ... ],
"labels": {
"<labelname>": "<labelvalue>", ...
}
},
...
]
```
The endpoint is queried periodically at the specified
refresh interval.
Each target has a meta label `__meta_url` during the
[relabeling phase](#relabel_config). Its value is set to the
URL from which the target was extracted.
```yaml
Docs - fix wrong spell
2021-06-13 21:08:06 -07:00
# URL from which the targets are fetched.
http_sd (#8839) Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2021-06-11 09:04:45 -07:00
url: <string>
# Refresh interval to re-query the endpoint.
[ refresh_interval: <duration> | default = 60s ]
# Authentication information used to authenticate to the API server.
# Note that `basic_auth`, `authorization` and `oauth2` options are
# mutually exclusive.
# `password` and `password_file` are mutually exclusive.
# Optional HTTP basic authentication information.
basic_auth:
[ username: <string> ]
[ password: <secret> ]
[ password_file: <string> ]
# Optional `Authorization` header configuration.
authorization:
# Sets the authentication type.
[ type: <string> | default: Bearer ]
# Sets the credentials. It is mutually exclusive with
# `credentials_file`.
[ credentials: <secret> ]
# Sets the credentials to the credentials read from the configured file.
# It is mutually exclusive with `credentials`.
[ credentials_file: <filename> ]
# Optional OAuth 2.0 configuration.
oauth2:
[ <oauth2> ]
# Optional proxy URL.
[ proxy_url: <string> ]
# Configure whether HTTP requests follow HTTP 3xx redirects.
[ follow_redirects: <bool> | default = true ]
# TLS configuration.
tls_config:
[ <tls_config> ]
```
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
### `<kubernetes_sd_config>`
Kubernetes SD configurations allow retrieving scrape targets from
Replacing 'HTTP' by 'HTTPS' for securing links (#5252) Currently, when we access the modified pages with **HTTP**, it is redirected to **HTTPS** automatically. So this commit aims to replace **HTTP** to **HTTPs** for security. Co-Authored-By: Nguyen Phuong An <AnNP@vn.fujitsu.com> Signed-off-by: Kim Bao Long <longkb@vn.fujitsu.com>
2019-02-22 05:33:02 -08:00
[Kubernetes'](https://kubernetes.io/) REST API and always staying synchronized with
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
the cluster state.
One of the following `role` types can be configured to discover targets:
#### `node`
The `node` role discovers one target per cluster node with the address defaulting
to the Kubelet's HTTP port.
The target address defaults to the first existing address of the Kubernetes
node object in the address type order of `NodeInternalIP`, `NodeExternalIP`,
`NodeLegacyHostIP`, and `NodeHostName`.
Available meta labels:
* `__meta_kubernetes_node_name`: The name of the node object.
* `__meta_kubernetes_node_label_<labelname>`: Each label from the node object.
discovery/kubernetes: add present labels for labels/annotations (#5443) Signed-off-by: Simon Pasquier <spasquie@redhat.com>
2019-04-10 05:21:42 -07:00
* `__meta_kubernetes_node_labelpresent_<labelname>`: `true` for each label from the node object.
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
* `__meta_kubernetes_node_annotation_<annotationname>`: Each annotation from the node object.
discovery/kubernetes: add present labels for labels/annotations (#5443) Signed-off-by: Simon Pasquier <spasquie@redhat.com>
2019-04-10 05:21:42 -07:00
* `__meta_kubernetes_node_annotationpresent_<annotationname>`: `true` for each annotation from the node object.
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
* `__meta_kubernetes_node_address_<address_type>`: The first address for each node address type, if it exists.
In addition, the `instance` label for the node will be set to the node name
as retrieved from the API server.
#### `service`
The `service` role discovers a target for each service port for each service.
This is generally useful for blackbox monitoring of a service.
The address will be set to the Kubernetes DNS name of the service and respective
service port.
Available meta labels:
* `__meta_kubernetes_namespace`: The namespace of the service object.
discovery/kubernetes: add present labels for labels/annotations (#5443) Signed-off-by: Simon Pasquier <spasquie@redhat.com>
2019-04-10 05:21:42 -07:00
* `__meta_kubernetes_service_annotation_<annotationname>`: Each annotation from the service object.
* `__meta_kubernetes_service_annotationpresent_<annotationname>`: "true" for each annotation of the service object.
expose kubernetes service cluster ip (#4940) Signed-off-by: tariqibrahim <tariq.ibrahim@microsoft.com> Signed-off-by: tariqibrahim <tariq181290@gmail.com>
2018-12-18 07:17:34 -08:00
* `__meta_kubernetes_service_cluster_ip`: The cluster IP address of the service. (Does not apply to services of type ExternalName)
* `__meta_kubernetes_service_external_name`: The DNS name of the service. (Applies to services of type ExternalName)
discovery/kubernetes: add present labels for labels/annotations (#5443) Signed-off-by: Simon Pasquier <spasquie@redhat.com>
2019-04-10 05:21:42 -07:00
* `__meta_kubernetes_service_label_<labelname>`: Each label from the service object.
* `__meta_kubernetes_service_labelpresent_<labelname>`: `true` for each label of the service object.
expose kubernetes service cluster ip (#4940) Signed-off-by: tariqibrahim <tariq.ibrahim@microsoft.com> Signed-off-by: tariqibrahim <tariq181290@gmail.com>
2018-12-18 07:17:34 -08:00
* `__meta_kubernetes_service_name`: The name of the service object.
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
* `__meta_kubernetes_service_port_name`: Name of the service port for the target.
* `__meta_kubernetes_service_port_protocol`: Protocol of the service port for the target.
add service type metadata to kubernetes_sd_config service role #6496 (#6684) * [service discovery] add service type metadata to kubernetes_sd_config service role Signed-off-by: fuling <fuling.lgz@alibaba-inc.com> * [fix] ServiceType -> string Signed-off-by: fuling <fuling.lgz@alibaba-inc.com> * [fix] fix testcase Signed-off-by: fuling <fuling.lgz@alibaba-inc.com> * [style] Signed-off-by: fuling <fuling.lgz@alibaba-inc.com> * [doc] add service type Signed-off-by: fuling <fuling.lgz@alibaba-inc.com> * [doc] sort Signed-off-by: fuling <fuling.lgz@alibaba-inc.com>
2020-02-25 00:22:14 -08:00
* `__meta_kubernetes_service_type`: The type of the service.
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
#### `pod`
The `pod` role discovers all pods and exposes their containers as targets. For each declared
port of a container, a single target is generated. If a container has no specified ports,
a port-free target per container is created for manually adding a port via relabeling.
Available meta labels:
* `__meta_kubernetes_namespace`: The namespace of the pod object.
* `__meta_kubernetes_pod_name`: The name of the pod object.
* `__meta_kubernetes_pod_ip`: The pod IP of the pod object.
discovery/kubernetes: add present labels for labels/annotations (#5443) Signed-off-by: Simon Pasquier <spasquie@redhat.com>
2019-04-10 05:21:42 -07:00
* `__meta_kubernetes_pod_label_<labelname>`: Each label from the pod object.
* `__meta_kubernetes_pod_labelpresent_<labelname>`: `true`for each label from the pod object.
* `__meta_kubernetes_pod_annotation_<annotationname>`: Each annotation from the pod object.
* `__meta_kubernetes_pod_annotationpresent_<annotationname>`: `true` for each annotation from the pod object.
fix(style): container_is_init to container_init Removes 'is' keyword to comply style guide Signed-off-by: sh0rez <me@shorez.de>
2019-05-29 06:20:29 -07:00
* `__meta_kubernetes_pod_container_init`: `true` if the container is an [InitContainer](https://kubernetes.io/docs/concepts/workloads/pods/init-containers/)
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
* `__meta_kubernetes_pod_container_name`: Name of the container the target address points to.
* `__meta_kubernetes_pod_container_port_name`: Name of the container port.
* `__meta_kubernetes_pod_container_port_number`: Number of the container port.
* `__meta_kubernetes_pod_container_port_protocol`: Protocol of the container port.
* `__meta_kubernetes_pod_ready`: Set to `true` or `false` for the pod's ready state.
Add __meta_kubernetes_pod_phase label in discovery (#4824) This lets you add a relabel rule to drop scrapes for pods which are not running. Signed-off-by: Bryan Boreham <bjboreham@gmail.com>
2018-11-06 06:40:24 -08:00
* `__meta_kubernetes_pod_phase`: Set to `Pending`, `Running`, `Succeeded`, `Failed` or `Unknown`
in the [lifecycle](https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#pod-phase).
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
* `__meta_kubernetes_pod_node_name`: The name of the node the pod is scheduled onto.
* `__meta_kubernetes_pod_host_ip`: The current host IP of the pod object.
Update docs for __meta_kubernetes_pod_uid
2017-11-24 07:02:53 -08:00
* `__meta_kubernetes_pod_uid`: The UID of the pod object.
Expose controller kind and name to labelling rules Relabelling rules can use this information to attach the name of the controller that has created a pod. In turn, this can be used to slice metrics by workload at query time, ie. "Give me all metrics that have been created by the $name Deployment" Signed-off-by: Damien Lespiau <damien@weave.works>
2018-04-06 15:27:39 -07:00
* `__meta_kubernetes_pod_controller_kind`: Object kind of the pod controller.
* `__meta_kubernetes_pod_controller_name`: Name of the pod controller.
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
#### `endpoints`
The `endpoints` role discovers targets from listed endpoints of a service. For each endpoint
address one target is discovered per port. If the endpoint is backed by a pod, all
additional container ports of the pod, not bound to an endpoint port, are discovered as targets as well.
Available meta labels:
* `__meta_kubernetes_namespace`: The namespace of the endpoints object.
* `__meta_kubernetes_endpoints_name`: The names of the endpoints object.
* For all targets discovered directly from the endpoints list (those not additionally inferred
from underlying pods), the following labels are attached:
discovery/kubernetes: add node name and hostname to endpoints Signed-off-by: Simon Pasquier <spasquie@redhat.com>
2019-05-16 00:49:00 -07:00
* `__meta_kubernetes_endpoint_hostname`: Hostname of the endpoint.
* `__meta_kubernetes_endpoint_node_name`: Name of the node hosting the endpoint.
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
* `__meta_kubernetes_endpoint_ready`: Set to `true` or `false` for the endpoint's ready state.
* `__meta_kubernetes_endpoint_port_name`: Name of the endpoint port.
* `__meta_kubernetes_endpoint_port_protocol`: Protocol of the endpoint port.
Map target infos of endpoints to prometheus meta labels. (#3770)
2018-03-09 02:07:00 -08:00
* `__meta_kubernetes_endpoint_address_target_kind`: Kind of the endpoint address target.
* `__meta_kubernetes_endpoint_address_target_name`: Name of the endpoint address target.
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
* If the endpoints belong to a service, all labels of the `role: service` discovery are attached.
* For all targets backed by a pod, all labels of the `role: pod` discovery are attached.
fix/9269 add documentation for endpointslice This commits add a documentation for the kubernetes_sd_configs: endpointslice feature. Signed-off-by: la3mmchen <alex@k3wl.net>
2021-10-03 12:30:39 -07:00
#### `endpointslice`
The `endpointslice` role discovers targets from existing endpointslices. For each endpoint
address referenced in the endpointslice object one target is discovered. If the endpoint is backed by a pod, all
additional container ports of the pod, not bound to an endpoint port, are discovered as targets as well.
Available meta labels:
* `__meta_kubernetes_namespace`: The namespace of the endpoints object.
* `__meta_kubernetes_endpointslice_name`: The name of endpointslice object.
* For all targets discovered directly from the endpointslice list (those not additionally inferred
from underlying pods), the following labels are attached:
* `__meta_kubernetes_endpointslice_address_target_kind`: Kind of the referenced object.
* `__meta_kubernetes_endpointslice_address_target_name`: Name of referenced object.
* `__meta_kubernetes_endpointslice_address_type`: The ip protocol family of the adress target.
* `__meta_kubernetes_endpointslice_endpoint_conditions_ready`: Set to `true` or `false` for the referenced endpoint's ready state.
* `__meta_kubernetes_endpointslice_endpoint_topology_kubernetes_io_hostname`: Name of the node hosting the referenced endpoint.
* `__meta_kubernetes_endpointslice_endpoint_topology_present_kubernetes_io_hostname`: Flag that shows if the referenced object has a kubernetes.io/hostname annotation.
* `__meta_kubernetes_endpointslice_port`: Port of the referenced endpoint.
* `__meta_kubernetes_endpointslice_port_name`: Named port of the referenced endpoint.
* `__meta_kubernetes_endpointslice_port_protocol`: Protocol of the referenced endpoint.
* If the endpoints belong to a service, all labels of the `role: service` discovery are attached.
* For all targets backed by a pod, all labels of the `role: pod` discovery are attached.
Include 1.8 changes in configuration docs
2017-10-10 10:55:29 -07:00
#### `ingress`
The `ingress` role discovers a target for each path of each ingress.
This is generally useful for blackbox monitoring of an ingress.
The address will be set to the host specified in the ingress spec.
Available meta labels:
* `__meta_kubernetes_namespace`: The namespace of the ingress object.
* `__meta_kubernetes_ingress_name`: The name of the ingress object.
discovery/kubernetes: add present labels for labels/annotations (#5443) Signed-off-by: Simon Pasquier <spasquie@redhat.com>
2019-04-10 05:21:42 -07:00
* `__meta_kubernetes_ingress_label_<labelname>`: Each label from the ingress object.
* `__meta_kubernetes_ingress_labelpresent_<labelname>`: `true` for each label from the ingress object.
* `__meta_kubernetes_ingress_annotation_<annotationname>`: Each annotation from the ingress object.
* `__meta_kubernetes_ingress_annotationpresent_<annotationname>`: `true` for each annotation from the ingress object.
Update label from `class` to `class_name` Signed-off-by: Mike Eves <michael.eves@autotrader.co.uk>
2021-06-11 05:43:22 -07:00
* `__meta_kubernetes_ingress_class_name`: Class name from ingress spec, if present.
Include 1.8 changes in configuration docs
2017-10-10 10:55:29 -07:00
* `__meta_kubernetes_ingress_scheme`: Protocol scheme of ingress, `https` if TLS
config is set. Defaults to `http`.
* `__meta_kubernetes_ingress_path`: Path from ingress spec. Defaults to `/`.
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
See below for the configuration options for Kubernetes discovery:
```yaml
# The information to access the Kubernetes API.
# The API server addresses. If left empty, Prometheus is assumed to run inside
# of the cluster and will discover API servers automatically and use the pod's
# CA certificate and bearer token file at /var/run/secrets/kubernetes.io/serviceaccount/.
[ api_server: <host> ]
# The Kubernetes role of entities that should be discovered.
Fix types in k8s+dns docs (#7474) Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2020-06-28 00:13:23 -07:00
# One of endpoints, service, pod, node, or ingress.
role: <string>
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
fix/9269 add documentation for endpointslice This commits add a documentation for the kubernetes_sd_configs: endpointslice feature. Signed-off-by: la3mmchen <alex@k3wl.net>
2021-10-03 12:30:39 -07:00
# Optional path to a kubeconfig file.
add kubeconfig support in discovery module (#8811) Signed-off-by: 3Xpl0it3r <shouc.wang@hotmail.com>
2021-06-17 03:41:50 -07:00
# Note that api_server and kube_config are mutually exclusive.
[ kubeconfig_file: <filename> ]
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
# Optional authentication information used to authenticate to the API server.
add kubeconfig support in discovery module (#8811) Signed-off-by: 3Xpl0it3r <shouc.wang@hotmail.com>
2021-06-17 03:41:50 -07:00
# Note that `basic_auth` and `authorization` options are mutually exclusive.
support reading basic_auth password_file for HTTP basic auth (#4077) Issue: https://github.com/prometheus/prometheus/issues/4076 Signed-off-by: Adam Shannon <adamkshannon@gmail.com>
2018-04-25 10:19:06 -07:00
# password and password_file are mutually exclusive.
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
# Optional HTTP basic authentication information.
basic_auth:
[ username: <string> ]
[ password: <secret> ]
support reading basic_auth password_file for HTTP basic auth (#4077) Issue: https://github.com/prometheus/prometheus/issues/4076 Signed-off-by: Adam Shannon <adamkshannon@gmail.com>
2018-04-25 10:19:06 -07:00
[ password_file: <string> ]
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
http_sd (#8839) Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2021-06-11 09:04:45 -07:00
# Optional `Authorization` header configuration.
Update common to support credentials type Most of the backwards compat tests is done in common. Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2021-02-18 14:14:49 -08:00
authorization:
# Sets the authentication type.
[ type: <string> | default: Bearer ]
# Sets the credentials. It is mutually exclusive with
# `credentials_file`.
[ credentials: <secret> ]
http_sd (#8839) Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2021-06-11 09:04:45 -07:00
# Sets the credentials to the credentials read from the configured file.
Update common to support credentials type Most of the backwards compat tests is done in common. Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2021-02-18 14:14:49 -08:00
# It is mutually exclusive with `credentials`.
[ credentials_file: <filename> ]
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
Add OAuth 2.0 Config (#8761) * Introduced oauth2 config into the codebase Signed-off-by: Levi Harrison <git@leviharrison.dev>
2021-04-28 05:47:52 -07:00
# Optional OAuth 2.0 configuration.
# Cannot be used at the same time as basic_auth or authorization.
oauth2:
[ <oauth2> ]
discovery/kubernetes: fix support for password_file and bearer_token_file (#5211) * discovery/kubernetes: fix support for password_file Signed-off-by: Simon Pasquier <spasquie@redhat.com> * Create and pass custom RoundTripper to Kubernetes client Signed-off-by: Simon Pasquier <spasquie@redhat.com> * Use inline HTTPClientConfig Signed-off-by: Simon Pasquier <spasquie@redhat.com>
2019-02-20 02:22:34 -08:00
# Optional proxy URL.
[ proxy_url: <string> ]
Support follow_redirect This PR introduces support for follow_redirect, to enable users to disable following HTTP redirects. Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2021-02-26 13:48:06 -08:00
# Configure whether HTTP requests follow HTTP 3xx redirects.
[ follow_redirects: <bool> | default = true ]
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
# TLS configuration.
tls_config:
[ <tls_config> ]
# Optional namespace discovery. If omitted, all namespaces are used.
namespaces:
names:
[ - <string> ]
discovery/kubernetes: expose label_selector and field_selector Closes #6096 Signed-off-by: Grebennikov Roman <grv@dfdx.me>
2019-10-03 04:55:42 -07:00
Contribute grafana/agent sigv4 code (#8509) * Contribute grafana/agent sigv4 code * address review feedback - move validation logic for RemoteWrite into unmarshal - copy configuration fields from ec2 SD config - remove enabled field, use pointer for enabling sigv4 * Update config/config.go * Don't provide credentials if secret key / access key left blank * Add SigV4 headers to the list of unchangeable headers. * sigv4: don't include all headers in signature * only test for equality in the authorization header, not the signed date * address review feedback 1. s/httpClientConfigEnabled/httpClientConfigAuthEnabled 2. bearer_token tuples to "authorization" 3. Un-export NewSigV4RoundTripper * add x-amz-content-sha256 to list of unchangeable headers * Document sigv4 configuration * add suggestion for using default AWS SDK credentials Signed-off-by: Robert Fratto <robertfratto@gmail.com> Co-authored-by: Julien Pivotto <roidelapluie@gmail.com>
2021-03-08 11:20:09 -08:00
# Optional label and field selectors to limit the discovery process to a subset of available resources.
discovery/kubernetes: expose label_selector and field_selector Closes #6096 Signed-off-by: Grebennikov Roman <grv@dfdx.me>
2019-10-03 04:55:42 -07:00
# See https://kubernetes.io/docs/concepts/overview/working-with-objects/field-selectors/
Contribute grafana/agent sigv4 code (#8509) * Contribute grafana/agent sigv4 code * address review feedback - move validation logic for RemoteWrite into unmarshal - copy configuration fields from ec2 SD config - remove enabled field, use pointer for enabling sigv4 * Update config/config.go * Don't provide credentials if secret key / access key left blank * Add SigV4 headers to the list of unchangeable headers. * sigv4: don't include all headers in signature * only test for equality in the authorization header, not the signed date * address review feedback 1. s/httpClientConfigEnabled/httpClientConfigAuthEnabled 2. bearer_token tuples to "authorization" 3. Un-export NewSigV4RoundTripper * add x-amz-content-sha256 to list of unchangeable headers * Document sigv4 configuration * add suggestion for using default AWS SDK credentials Signed-off-by: Robert Fratto <robertfratto@gmail.com> Co-authored-by: Julien Pivotto <roidelapluie@gmail.com>
2021-03-08 11:20:09 -08:00
# and https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ to learn more about the possible
discovery/kubernetes: expose label_selector and field_selector Closes #6096 Signed-off-by: Grebennikov Roman <grv@dfdx.me>
2019-10-03 04:55:42 -07:00
# filters that can be used. Endpoints role supports pod, service and endpoints selectors, other roles
# only support selectors matching the role itself (e.g. node role can only contain node selectors).
discovery/kubernetes: expose label_selector and field_selector Close #6807 Co-authored-by @shuttie Signed-off-by: Aleksandra Gacek <algacek@google.com>
2020-02-07 06:13:44 -08:00
Contribute grafana/agent sigv4 code (#8509) * Contribute grafana/agent sigv4 code * address review feedback - move validation logic for RemoteWrite into unmarshal - copy configuration fields from ec2 SD config - remove enabled field, use pointer for enabling sigv4 * Update config/config.go * Don't provide credentials if secret key / access key left blank * Add SigV4 headers to the list of unchangeable headers. * sigv4: don't include all headers in signature * only test for equality in the authorization header, not the signed date * address review feedback 1. s/httpClientConfigEnabled/httpClientConfigAuthEnabled 2. bearer_token tuples to "authorization" 3. Un-export NewSigV4RoundTripper * add x-amz-content-sha256 to list of unchangeable headers * Document sigv4 configuration * add suggestion for using default AWS SDK credentials Signed-off-by: Robert Fratto <robertfratto@gmail.com> Co-authored-by: Julien Pivotto <roidelapluie@gmail.com>
2021-03-08 11:20:09 -08:00
# Note: When making decision about using field/label selector make sure that this
discovery/kubernetes: expose label_selector and field_selector Close #6807 Co-authored-by @shuttie Signed-off-by: Aleksandra Gacek <algacek@google.com>
2020-02-07 06:13:44 -08:00
# is the best approach - it will prevent Prometheus from reusing single list/watch
# for all scrape configs. This might result in a bigger load on the Kubernetes API,
# because per each selector combination there will be additional LIST/WATCH. On the other hand,
# if you just want to monitor small subset of pods in large cluster it's recommended to use selectors.
# Decision, if selectors should be used or not depends on the particular situation.
[ selectors:
Fix types in k8s+dns docs (#7474) Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2020-06-28 00:13:23 -07:00
[ - role: <string>
discovery/kubernetes: expose label_selector and field_selector Closes #6096 Signed-off-by: Grebennikov Roman <grv@dfdx.me>
2019-10-03 04:55:42 -07:00
[ label: <string> ]
discovery/kubernetes: expose label_selector and field_selector Close #6807 Co-authored-by @shuttie Signed-off-by: Aleksandra Gacek <algacek@google.com>
2020-02-07 06:13:44 -08:00
[ field: <string> ] ]]
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
```
See [this example Prometheus configuration file](/documentation/examples/prometheus-kubernetes.yml)
for a detailed example of configuring Prometheus for Kubernetes.
You may wish to check out the 3rd party [Prometheus Operator](https://github.com/coreos/prometheus-operator),
which automates the Prometheus setup on top of Kubernetes.
Add documentation for kuma_sd configuration Signed-off-by: austin ce <austin.cawley@gmail.com>
2021-05-04 12:47:53 -07:00
### `<kuma_sd_config>`
Kuma SD configurations allow retrieving scrape target from the [Kuma](https://kuma.io) control plane.
This SD discovers "monitoring assignments" based on Kuma [Dataplane Proxies](https://kuma.io/docs/latest/documentation/dps-and-data-model),
via the MADS v1 (Monitoring Assignment Discovery Service) xDS API, and will create a target for each proxy
inside a Prometheus-enabled mesh.
The following meta labels are available for each target:
fix/9269 add documentation for endpointslice This commits add a documentation for the kubernetes_sd_configs: endpointslice feature. Signed-off-by: la3mmchen <alex@k3wl.net>
2021-10-03 12:30:39 -07:00
* `__meta_kuma_mesh`: the name of the proxy's Mesh
Add documentation for kuma_sd configuration Signed-off-by: austin ce <austin.cawley@gmail.com>
2021-05-04 12:47:53 -07:00
* `__meta_kuma_dataplane`: the name of the proxy
* `__meta_kuma_service`: the name of the proxy's associated Service
* `__meta_kuma_label_<tagname>`: each tag of the proxy
See below for the configuration options for Kuma MonitoringAssignment discovery:
```yaml
# Address of the Kuma Control Plane's MADS xDS server.
server: <string>
# The time to wait between polling update requests.
[ refresh_interval: <duration> | default = 30s ]
# The time after which the monitoring assignments are refreshed.
[ fetch_timeout: <duration> | default = 2m ]
# Optional proxy URL.
[ proxy_url: <string> ]
# TLS configuration.
tls_config:
[ <tls_config> ]
# Authentication information used to authenticate to the Docker daemon.
# Note that `basic_auth` and `authorization` options are
# mutually exclusive.
# password and password_file are mutually exclusive.
# Optional HTTP basic authentication information.
basic_auth:
[ username: <string> ]
[ password: <secret> ]
[ password_file: <string> ]
# Optional the `Authorization` header configuration.
authorization:
# Sets the authentication type.
[ type: <string> | default: Bearer ]
# Sets the credentials. It is mutually exclusive with
# `credentials_file`.
[ credentials: <secret> ]
# Sets the credentials with the credentials read from the configured file.
# It is mutually exclusive with `credentials`.
[ credentials_file: <filename> ]
# Optional OAuth 2.0 configuration.
# Cannot be used at the same time as basic_auth or authorization.
oauth2:
[ <oauth2> ]
# Configure whether HTTP requests follow HTTP 3xx redirects.
[ follow_redirects: <bool> | default = true ]
```
The [relabeling phase](#relabel_config) is the preferred and more powerful way
to filter proxies and user-defined tags.
Add lightsail service discovery (#8693) Signed-off-by: N888 <drifto@gmail.com>
2021-04-28 02:29:12 -07:00
### `<lightsail_sd_config>`
Lightsail SD configurations allow retrieving scrape targets from [AWS Lightsail](https://aws.amazon.com/lightsail/)
instances. The private IP address is used by default, but may be changed to
the public IP address with relabeling.
The following meta labels are available on targets during [relabeling](#relabel_config):
* `__meta_lightsail_availability_zone`: the availability zone in which the instance is running
* `__meta_lightsail_blueprint_id`: the Lightsail blueprint ID
* `__meta_lightsail_bundle_id`: the Lightsail bundle ID
* `__meta_lightsail_instance_name`: the name of the Lightsail instance
* `__meta_lightsail_instance_state`: the state of the Lightsail instance
* `__meta_lightsail_instance_support_code`: the support code of the Lightsail instance
* `__meta_lightsail_ipv6_addresses`: comma separated list of IPv6 addresses assigned to the instance's network interfaces, if present
* `__meta_lightsail_private_ip`: the private IP address of the instance
* `__meta_lightsail_public_ip`: the public IP address of the instance, if available
* `__meta_lightsail_tag_<tagkey>`: each tag value of the instance
See below for the configuration options for Lightsail discovery:
```yaml
# The information to access the Lightsail API.
# The AWS region. If blank, the region from the instance metadata is used.
[ region: <string> ]
# Custom endpoint to be used.
[ endpoint: <string> ]
# The AWS API keys. If blank, the environment variables `AWS_ACCESS_KEY_ID`
# and `AWS_SECRET_ACCESS_KEY` are used.
[ access_key: <string> ]
[ secret_key: <secret> ]
# Named AWS profile used to connect to the API.
[ profile: <string> ]
# AWS Role ARN, an alternative to using AWS API keys.
[ role_arn: <string> ]
# Refresh interval to re-read the instance list.
[ refresh_interval: <duration> | default = 60s ]
# The port to scrape metrics from. If using the public IP address, this must
# instead be specified in the relabeling rule.
[ port: <int> | default = 80 ]
```
Add Linode Service Discovery (#8846) * Add Linode Service Discovery Signed-off-by: TJ Hoplock <t.hoplock@gmail.com>
2021-06-01 11:32:36 -07:00
### `<linode_sd_config>`
Linode SD configurations allow retrieving scrape targets from [Linode's](https://www.linode.com/)
Linode APIv4.
This service discovery uses the public IPv4 address by default, by that can be
changed with relabelling, as demonstrated in [the Prometheus linode-sd
configuration file](/documentation/examples/prometheus-linode.yml).
The following meta labels are available on targets during [relabeling](#relabel_config):
* `__meta_linode_instance_id`: the id of the linode instance
* `__meta_linode_instance_label`: the label of the linode instance
* `__meta_linode_image`: the slug of the linode instance's image
* `__meta_linode_private_ipv4`: the private IPv4 of the linode instance
* `__meta_linode_public_ipv4`: the public IPv4 of the linode instance
* `__meta_linode_public_ipv6`: the public IPv6 of the linode instance
* `__meta_linode_region`: the region of the linode instance
* `__meta_linode_type`: the type of the linode instance
* `__meta_linode_status`: the status of the linode instance
* `__meta_linode_tags`: a list of tags of the linode instance joined by the tag separator
* `__meta_linode_group`: the display group a linode instance is a member of
* `__meta_linode_hypervisor`: the virtualization software powering the linode instance
* `__meta_linode_backups`: the backup service status of the linode instance
* `__meta_linode_specs_disk_bytes`: the amount of storage space the linode instance has access to
* `__meta_linode_specs_memory_bytes`: the amount of RAM the linode instance has access to
* `__meta_linode_specs_vcpus`: the number of VCPUS this linode has access to
* `__meta_linode_specs_transfer_bytes`: the amount of network transfer the linode instance is allotted each month
* `__meta_linode_extra_ips`: a list of all extra IPv4 addresses assigned to the linode instance joined by the tag separator
```yaml
# Authentication information used to authenticate to the API server.
# Note that `basic_auth` and `authorization` options are
# mutually exclusive.
# password and password_file are mutually exclusive.
optimize Linode SD by polling for event changes during refresh (#8980) * optimize Linode SD by polling for event changes during refresh Most accounts are fairly "static", in the sense that they're not cycling through instances constantly. So rather than do a full refresh every interval and potentially make several behind-the-scenes paginated API calls, this will now poll the `/account/events/` endpoint every minute with a list of events that we care about. If a matching event is found, we then do a full refresh. Co-authored-by: William Smith <wsmith@linode.com> Signed-off-by: TJ Hoplock <t.hoplock@gmail.com> Signed-off-by: William Smith <wsmith@linode.com>
2021-08-04 03:05:49 -07:00
# Note: Linode APIv4 Token must be created with scopes: 'linodes:read_only', 'ips:read_only', and 'events:read_only'
Add Linode Service Discovery (#8846) * Add Linode Service Discovery Signed-off-by: TJ Hoplock <t.hoplock@gmail.com>
2021-06-01 11:32:36 -07:00
# Optional HTTP basic authentication information, not currently supported by Linode APIv4.
basic_auth:
[ username: <string> ]
[ password: <secret> ]
[ password_file: <string> ]
# Optional the `Authorization` header configuration.
authorization:
# Sets the authentication type.
[ type: <string> | default: Bearer ]
# Sets the credentials. It is mutually exclusive with
# `credentials_file`.
[ credentials: <secret> ]
# Sets the credentials with the credentials read from the configured file.
# It is mutually exclusive with `credentials`.
[ credentials_file: <filename> ]
# Optional OAuth 2.0 configuration.
# Cannot be used at the same time as basic_auth or authorization.
oauth2:
[ <oauth2> ]
# Optional proxy URL.
[ proxy_url: <string> ]
# Configure whether HTTP requests follow HTTP 3xx redirects.
[ follow_redirects: <bool> | default = true ]
# TLS configuration.
tls_config:
[ <tls_config> ]
# The port to scrape metrics from.
[ port: <int> | default = 80 ]
# The string by which Linode Instance tags are joined into the tag label.
[ tag_separator: <string> | default = , ]
# The time after which the linode instances are refreshed.
[ refresh_interval: <duration> | default = 60s ]
```
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
### `<marathon_sd_config>`
Marathon SD configurations allow retrieving scrape targets using the
[Marathon](https://mesosphere.github.io/marathon/) REST API. Prometheus
will periodically check the REST endpoint for currently running tasks and
create a target group for every app that has at least one healthy task.
The following meta labels are available on targets during [relabeling](#relabel_config):
* `__meta_marathon_app`: the name of the app (with slashes replaced by dashes)
* `__meta_marathon_image`: the name of the Docker image used (if available)
* `__meta_marathon_task`: the ID of the Mesos task
* `__meta_marathon_app_label_<labelname>`: any Marathon labels attached to the app
* `__meta_marathon_port_definition_label_<labelname>`: the port definition labels
* `__meta_marathon_port_mapping_label_<labelname>`: the port mapping labels
Include 1.8 changes in configuration docs
2017-10-10 10:55:29 -07:00
* `__meta_marathon_port_index`: the port index number (e.g. `1` for `PORT1`)
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
See below for the configuration options for Marathon discovery:
```yaml
# List of URLs to be used to contact Marathon servers.
Tweak marathon wording around clustering.
2017-11-02 06:03:19 -07:00
# You need to provide at least one server URL.
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
servers:
- <string>
# Polling interval
[ refresh_interval: <duration> | default = 30s ]
Use common HTTPClientConfig for marathon_sd configuration (#4009) This adds support for basic authentication which closes #3090 The support for specifying the client timeout was removed as discussed in https://github.com/prometheus/common/pull/123. Marathon was the only sd mechanism doing this and configuring the timeout is done through `Context`. DC/OS uses a custom `Authorization` header for authenticating. This adds 2 new configuration properties to reflect this. Existing configuration files that use the bearer token will no longer work. More work is required to make this backwards compatible.
2018-04-05 01:08:18 -07:00
# Optional authentication information for token-based authentication
# https://docs.mesosphere.com/1.11/security/ent/iam-api/#passing-an-authentication-token
# It is mutually exclusive with `auth_token_file` and other authentication mechanisms.
[ auth_token: <secret> ]
# Optional authentication information for token-based authentication
# https://docs.mesosphere.com/1.11/security/ent/iam-api/#passing-an-authentication-token
# It is mutually exclusive with `auth_token` and other authentication mechanisms.
[ auth_token_file: <filename> ]
# Sets the `Authorization` header on every request with the
# configured username and password.
# This is mutually exclusive with other authentication mechanisms.
support reading basic_auth password_file for HTTP basic auth (#4077) Issue: https://github.com/prometheus/prometheus/issues/4076 Signed-off-by: Adam Shannon <adamkshannon@gmail.com>
2018-04-25 10:19:06 -07:00
# password and password_file are mutually exclusive.
Use common HTTPClientConfig for marathon_sd configuration (#4009) This adds support for basic authentication which closes #3090 The support for specifying the client timeout was removed as discussed in https://github.com/prometheus/common/pull/123. Marathon was the only sd mechanism doing this and configuring the timeout is done through `Context`. DC/OS uses a custom `Authorization` header for authenticating. This adds 2 new configuration properties to reflect this. Existing configuration files that use the bearer token will no longer work. More work is required to make this backwards compatible.
2018-04-05 01:08:18 -07:00
basic_auth:
[ username: <string> ]
Docs: fix types (#7508) I have batched a bunch of fixes around types in the documentation. Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2020-07-02 14:27:14 -07:00
[ password: <secret> ]
support reading basic_auth password_file for HTTP basic auth (#4077) Issue: https://github.com/prometheus/prometheus/issues/4076 Signed-off-by: Adam Shannon <adamkshannon@gmail.com>
2018-04-25 10:19:06 -07:00
[ password_file: <string> ]
Use common HTTPClientConfig for marathon_sd configuration (#4009) This adds support for basic authentication which closes #3090 The support for specifying the client timeout was removed as discussed in https://github.com/prometheus/common/pull/123. Marathon was the only sd mechanism doing this and configuring the timeout is done through `Context`. DC/OS uses a custom `Authorization` header for authenticating. This adds 2 new configuration properties to reflect this. Existing configuration files that use the bearer token will no longer work. More work is required to make this backwards compatible.
2018-04-05 01:08:18 -07:00
http_sd (#8839) Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2021-06-11 09:04:45 -07:00
# Optional `Authorization` header configuration.
Update common to support credentials type Most of the backwards compat tests is done in common. Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2021-02-18 14:14:49 -08:00
# NOTE: The current version of DC/OS marathon (v1.11.0) does not support
# standard `Authentication` header, use `auth_token` or `auth_token_file`
# instead.
authorization:
# Sets the authentication type.
[ type: <string> | default: Bearer ]
# Sets the credentials. It is mutually exclusive with
# `credentials_file`.
[ credentials: <secret> ]
http_sd (#8839) Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2021-06-11 09:04:45 -07:00
# Sets the credentials to the credentials read from the configured file.
Update common to support credentials type Most of the backwards compat tests is done in common. Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2021-02-18 14:14:49 -08:00
# It is mutually exclusive with `credentials`.
[ credentials_file: <filename> ]
Use common HTTPClientConfig for marathon_sd configuration (#4009) This adds support for basic authentication which closes #3090 The support for specifying the client timeout was removed as discussed in https://github.com/prometheus/common/pull/123. Marathon was the only sd mechanism doing this and configuring the timeout is done through `Context`. DC/OS uses a custom `Authorization` header for authenticating. This adds 2 new configuration properties to reflect this. Existing configuration files that use the bearer token will no longer work. More work is required to make this backwards compatible.
2018-04-05 01:08:18 -07:00
Add OAuth 2.0 Config (#8761) * Introduced oauth2 config into the codebase Signed-off-by: Levi Harrison <git@leviharrison.dev>
2021-04-28 05:47:52 -07:00
# Optional OAuth 2.0 configuration.
# Cannot be used at the same time as basic_auth or authorization.
oauth2:
[ <oauth2> ]
Support follow_redirect This PR introduces support for follow_redirect, to enable users to disable following HTTP redirects. Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2021-02-26 13:48:06 -08:00
# Configure whether HTTP requests follow HTTP 3xx redirects.
[ follow_redirects: <bool> | default = true ]
Use common HTTPClientConfig for marathon_sd configuration (#4009) This adds support for basic authentication which closes #3090 The support for specifying the client timeout was removed as discussed in https://github.com/prometheus/common/pull/123. Marathon was the only sd mechanism doing this and configuring the timeout is done through `Context`. DC/OS uses a custom `Authorization` header for authenticating. This adds 2 new configuration properties to reflect this. Existing configuration files that use the bearer token will no longer work. More work is required to make this backwards compatible.
2018-04-05 01:08:18 -07:00
# TLS configuration for connecting to marathon servers
tls_config:
[ <tls_config> ]
# Optional proxy URL.
[ proxy_url: <string> ]
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
```
By default every app listed in Marathon will be scraped by Prometheus. If not all
of your services provide Prometheus metrics, you can use a Marathon label and
docs - refer to documentation/examples/prometheus-marathon.yml Signed-off-by: Timo Beckers <timo@incline.eu>
2018-10-25 08:56:19 -07:00
Prometheus relabeling to control which instances will actually be scraped.
See [the Prometheus marathon-sd configuration file](/documentation/examples/prometheus-marathon.yml)
for a practical example on how to set up your Marathon app and your Prometheus
configuration.
By default, all apps will show up as a single job in Prometheus (the one specified
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
in the configuration file), which can also be changed using relabeling.
### `<nerve_sd_config>`
Integrate changes from prometheus/docs
2017-10-26 06:42:07 -07:00
Nerve SD configurations allow retrieving scrape targets from [AirBnB's Nerve]
(https://github.com/airbnb/nerve) which are stored in
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
[Zookeeper](https://zookeeper.apache.org/).
The following meta labels are available on targets during [relabeling](#relabel_config):
* `__meta_nerve_path`: the full path to the endpoint node in Zookeeper
* `__meta_nerve_endpoint_host`: the host of the endpoint
* `__meta_nerve_endpoint_port`: the port of the endpoint
* `__meta_nerve_endpoint_name`: the name of the endpoint
```yaml
# The Zookeeper servers.
servers:
- <host>
# Paths can point to a single service, or the root of a tree of services.
paths:
- <string>
[ timeout: <duration> | default = 10s ]
```
### `<serverset_sd_config>`
Integrate changes from prometheus/docs
2017-10-26 06:42:07 -07:00
Serverset SD configurations allow retrieving scrape targets from [Serversets]
(https://github.com/twitter/finagle/tree/master/finagle-serversets) which are
stored in [Zookeeper](https://zookeeper.apache.org/). Serversets are commonly
used by [Finagle](https://twitter.github.io/finagle/) and
Update remaining deprecated links in docs (#5271) Signed-off-by: Vu Cong Tuan <tuanvc@vn.fujitsu.com>
2019-02-26 02:16:38 -08:00
[Aurora](https://aurora.apache.org/).
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
add relabeling link to be consistent with other section (#7851) Signed-off-by: Luke Chen <showuon@gmail.com>
2020-08-26 00:39:31 -07:00
The following meta labels are available on targets during [relabeling](#relabel_config):
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
* `__meta_serverset_path`: the full path to the serverset member node in Zookeeper
* `__meta_serverset_endpoint_host`: the host of the default endpoint
* `__meta_serverset_endpoint_port`: the port of the default endpoint
* `__meta_serverset_endpoint_host_<endpoint>`: the host of the given endpoint
* `__meta_serverset_endpoint_port_<endpoint>`: the port of the given endpoint
* `__meta_serverset_shard`: the shard number of the member
* `__meta_serverset_status`: the status of the member
```yaml
# The Zookeeper servers.
servers:
- <host>
# Paths can point to a single serverset, or the root of a tree of serversets.
paths:
- <string>
[ timeout: <duration> | default = 10s ]
```
Serverset data must be in the JSON format, the Thrift format is not currently supported.
### `<triton_sd_config>`
[Triton](https://github.com/joyent/triton) SD configurations allow retrieving
scrape targets from [Container Monitor](https://github.com/joyent/rfd/blob/master/rfd/0027/README.md)
discovery endpoints.
Add discovery support for triton compute nodes (#7250) Added optional configuration item role, defaults to 'container' (backwards-compatible). Setting role to 'cn' will discover compute nodes instead. Human-friendly compute node hostname discovery depends on cmon 1.7.0: https://github.com/joyent/triton-cmon/commit/c1a2aeca36cc3c4e8b081a35a01a0b770d30e4ef Adjust testcases to use discovery config per case as two different types are now supported. Updated documentation: * new role setting * clarify what the name 'container' covers as triton uses different names in different locations Signed-off-by: jzinkweg <jzinkweg@gmail.com>
2020-05-22 08:19:21 -07:00
One of the following `<triton_role>` types can be configured to discover targets:
#### `container`
The `container` role discovers one target per "virtual machine" owned by the `account`.
These are SmartOS zones or lx/KVM/bhyve branded zones.
The following meta labels are available on targets during [relabeling](#relabel_config):
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
Add ability to filter triton_sd targets by pre-defined groups (#4701) Additionally, add triton groups metadata to the discovery reponse and correct a documentation error regarding the triton server id metadata. Signed-off-by: Richard Kiene <richard.kiene@joyent.com>
2018-10-10 02:03:34 -07:00
* `__meta_triton_groups`: the list of groups belonging to the target joined by a comma separator
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
* `__meta_triton_machine_alias`: the alias of the target container
Add ability to filter triton_sd targets by pre-defined groups (#4701) Additionally, add triton groups metadata to the discovery reponse and correct a documentation error regarding the triton server id metadata. Signed-off-by: Richard Kiene <richard.kiene@joyent.com>
2018-10-10 02:03:34 -07:00
* `__meta_triton_machine_brand`: the brand of the target container
* `__meta_triton_machine_id`: the UUID of the target container
Add discovery support for triton compute nodes (#7250) Added optional configuration item role, defaults to 'container' (backwards-compatible). Setting role to 'cn' will discover compute nodes instead. Human-friendly compute node hostname discovery depends on cmon 1.7.0: https://github.com/joyent/triton-cmon/commit/c1a2aeca36cc3c4e8b081a35a01a0b770d30e4ef Adjust testcases to use discovery config per case as two different types are now supported. Updated documentation: * new role setting * clarify what the name 'container' covers as triton uses different names in different locations Signed-off-by: jzinkweg <jzinkweg@gmail.com>
2020-05-22 08:19:21 -07:00
* `__meta_triton_machine_image`: the target container's image type
* `__meta_triton_server_id`: the server UUID the target container is running on
#### `cn`
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
Add discovery support for triton compute nodes (#7250) Added optional configuration item role, defaults to 'container' (backwards-compatible). Setting role to 'cn' will discover compute nodes instead. Human-friendly compute node hostname discovery depends on cmon 1.7.0: https://github.com/joyent/triton-cmon/commit/c1a2aeca36cc3c4e8b081a35a01a0b770d30e4ef Adjust testcases to use discovery config per case as two different types are now supported. Updated documentation: * new role setting * clarify what the name 'container' covers as triton uses different names in different locations Signed-off-by: jzinkweg <jzinkweg@gmail.com>
2020-05-22 08:19:21 -07:00
The `cn` role discovers one target for per compute node (also known as "server" or "global zone") making up the Triton infrastructure.
The `account` must be a Triton operator and is currently required to own at least one `container`.
The following meta labels are available on targets during [relabeling](#relabel_config):
* `__meta_triton_machine_alias`: the hostname of the target (requires triton-cmon 1.7.0 or newer)
* `__meta_triton_machine_id`: the UUID of the target
See below for the configuration options for Triton discovery:
Add missing newline before inline-code block (#7401) Sections with three backticks require a blank line before them. Signed-off-by: Alex Vandiver <alex@chmrr.net>
2020-06-15 22:13:27 -07:00
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
```yaml
# The information to access the Triton discovery API.
Add discovery support for triton compute nodes (#7250) Added optional configuration item role, defaults to 'container' (backwards-compatible). Setting role to 'cn' will discover compute nodes instead. Human-friendly compute node hostname discovery depends on cmon 1.7.0: https://github.com/joyent/triton-cmon/commit/c1a2aeca36cc3c4e8b081a35a01a0b770d30e4ef Adjust testcases to use discovery config per case as two different types are now supported. Updated documentation: * new role setting * clarify what the name 'container' covers as triton uses different names in different locations Signed-off-by: jzinkweg <jzinkweg@gmail.com>
2020-05-22 08:19:21 -07:00
# The account to use for discovering new targets.
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
account: <string>
Add discovery support for triton compute nodes (#7250) Added optional configuration item role, defaults to 'container' (backwards-compatible). Setting role to 'cn' will discover compute nodes instead. Human-friendly compute node hostname discovery depends on cmon 1.7.0: https://github.com/joyent/triton-cmon/commit/c1a2aeca36cc3c4e8b081a35a01a0b770d30e4ef Adjust testcases to use discovery config per case as two different types are now supported. Updated documentation: * new role setting * clarify what the name 'container' covers as triton uses different names in different locations Signed-off-by: jzinkweg <jzinkweg@gmail.com>
2020-05-22 08:19:21 -07:00
# The type of targets to discover, can be set to:
# * "container" to discover virtual machines (SmartOS zones, lx/KVM/bhyve branded zones) running on Triton
# * "cn" to discover compute nodes (servers/global zones) making up the Triton infrastructure
[ role : <string> | default = "container" ]
# The DNS suffix which should be applied to target.
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
dns_suffix: <string>
# The Triton discovery endpoint (e.g. 'cmon.us-east-3b.triton.zone'). This is
# often the same value as dns_suffix.
endpoint: <string>
Add discovery support for triton compute nodes (#7250) Added optional configuration item role, defaults to 'container' (backwards-compatible). Setting role to 'cn' will discover compute nodes instead. Human-friendly compute node hostname discovery depends on cmon 1.7.0: https://github.com/joyent/triton-cmon/commit/c1a2aeca36cc3c4e8b081a35a01a0b770d30e4ef Adjust testcases to use discovery config per case as two different types are now supported. Updated documentation: * new role setting * clarify what the name 'container' covers as triton uses different names in different locations Signed-off-by: jzinkweg <jzinkweg@gmail.com>
2020-05-22 08:19:21 -07:00
# A list of groups for which targets are retrieved, only supported when `role` == `container`.
# If omitted all containers owned by the requesting account are scraped.
openstack_sd: Supporting application credential for authentication. (#4968) * openstack_sd: Support application credentials for authentication. Updated gophercloud Signed-off-by: Kevin Bulebush <kmbulebu@gmail.com>
2019-01-09 07:18:58 -08:00
groups:
Add ability to filter triton_sd targets by pre-defined groups (#4701) Additionally, add triton groups metadata to the discovery reponse and correct a documentation error regarding the triton server id metadata. Signed-off-by: Richard Kiene <richard.kiene@joyent.com>
2018-10-10 02:03:34 -07:00
[ - <string> ... ]
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
# The port to use for discovery and metric scraping.
[ port: <int> | default = 9163 ]
Add discovery support for triton compute nodes (#7250) Added optional configuration item role, defaults to 'container' (backwards-compatible). Setting role to 'cn' will discover compute nodes instead. Human-friendly compute node hostname discovery depends on cmon 1.7.0: https://github.com/joyent/triton-cmon/commit/c1a2aeca36cc3c4e8b081a35a01a0b770d30e4ef Adjust testcases to use discovery config per case as two different types are now supported. Updated documentation: * new role setting * clarify what the name 'container' covers as triton uses different names in different locations Signed-off-by: jzinkweg <jzinkweg@gmail.com>
2020-05-22 08:19:21 -07:00
# The interval which should be used for refreshing targets.
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
[ refresh_interval: <duration> | default = 60s ]
# The Triton discovery API version.
[ version: <int> | default = 1 ]
# TLS configuration.
tls_config:
[ <tls_config> ]
```
Add Eureka Service Discovery (#3369) Signed-off-by: kangwoo <kangwoo@gmail.com>
2020-08-26 08:36:59 -07:00
### `<eureka_sd_config>`
Eureka SD configurations allow retrieving scrape targets using the
[Eureka](https://github.com/Netflix/eureka) REST API. Prometheus
will periodically check the REST endpoint and
create a target for every app instance.
The following meta labels are available on targets during [relabeling](#relabel_config):
* `__meta_eureka_app_name`: the name of the app
* `__meta_eureka_app_instance_id`: the ID of the app instance
* `__meta_eureka_app_instance_hostname`: the hostname of the instance
* `__meta_eureka_app_instance_homepage_url`: the homepage url of the app instance
* `__meta_eureka_app_instance_statuspage_url`: the status page url of the app instance
* `__meta_eureka_app_instance_healthcheck_url`: the health check url of the app instance
* `__meta_eureka_app_instance_ip_addr`: the IP address of the app instance
* `__meta_eureka_app_instance_vip_address`: the VIP address of the app instance
* `__meta_eureka_app_instance_secure_vip_address`: the secure VIP address of the app instance
* `__meta_eureka_app_instance_status`: the status of the app instance
* `__meta_eureka_app_instance_port`: the port of the app instance
* `__meta_eureka_app_instance_port_enabled`: the port enabled of the app instance
* `__meta_eureka_app_instance_secure_port`: the secure port address of the app instance
* `__meta_eureka_app_instance_secure_port_enabled`: the secure port of the app instance
* `__meta_eureka_app_instance_country_id`: the country ID of the app instance
* `__meta_eureka_app_instance_metadata_<metadataname>`: app instance metadata
* `__meta_eureka_app_instance_datacenterinfo_name`: the datacenter name of the app instance
* `__meta_eureka_app_instance_datacenterinfo_<metadataname>`: the datacenter metadata
See below for the configuration options for Eureka discovery:
```yaml
# The URL to connect to the Eureka server.
server: <string>
# Sets the `Authorization` header on every request with the
# configured username and password.
# password and password_file are mutually exclusive.
basic_auth:
[ username: <string> ]
[ password: <secret> ]
[ password_file: <string> ]
http_sd (#8839) Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2021-06-11 09:04:45 -07:00
# Optional `Authorization` header configuration.
Update common to support credentials type Most of the backwards compat tests is done in common. Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2021-02-18 14:14:49 -08:00
authorization:
# Sets the authentication type.
[ type: <string> | default: Bearer ]
# Sets the credentials. It is mutually exclusive with
# `credentials_file`.
[ credentials: <secret> ]
http_sd (#8839) Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2021-06-11 09:04:45 -07:00
# Sets the credentials to the credentials read from the configured file.
Update common to support credentials type Most of the backwards compat tests is done in common. Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2021-02-18 14:14:49 -08:00
# It is mutually exclusive with `credentials`.
[ credentials_file: <filename> ]
Add Eureka Service Discovery (#3369) Signed-off-by: kangwoo <kangwoo@gmail.com>
2020-08-26 08:36:59 -07:00
Add OAuth 2.0 Config (#8761) * Introduced oauth2 config into the codebase Signed-off-by: Levi Harrison <git@leviharrison.dev>
2021-04-28 05:47:52 -07:00
# Optional OAuth 2.0 configuration.
# Cannot be used at the same time as basic_auth or authorization.
oauth2:
[ <oauth2> ]
Add Eureka Service Discovery (#3369) Signed-off-by: kangwoo <kangwoo@gmail.com>
2020-08-26 08:36:59 -07:00
# Configures the scrape request's TLS settings.
tls_config:
[ <tls_config> ]
# Optional proxy URL.
[ proxy_url: <string> ]
Support follow_redirect This PR introduces support for follow_redirect, to enable users to disable following HTTP redirects. Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2021-02-26 13:48:06 -08:00
# Configure whether HTTP requests follow HTTP 3xx redirects.
[ follow_redirects: <bool> | default = true ]
Add Eureka Service Discovery (#3369) Signed-off-by: kangwoo <kangwoo@gmail.com>
2020-08-26 08:36:59 -07:00
# Refresh interval to re-read the app instance list.
[ refresh_interval: <duration> | default = 30s ]
```
See [the Prometheus eureka-sd configuration file](/documentation/examples/prometheus-eureka.yml)
for a practical example on how to set up your Eureka app and your Prometheus
configuration.
add support for scaleway service discovery (#8555) Co-authored-by: Patrik <patrik@ptrk.io> Co-authored-by: Julien Pivotto <roidelapluie@inuits.eu> Signed-off-by: Rémy Léone <rleone@scaleway.com>
2021-03-10 06:10:17 -08:00
### `<scaleway_sd_config>`
Scaleway SD configurations allow retrieving scrape targets from [Scaleway instances](https://www.scaleway.com/en/virtual-instances/) and [baremetal services](https://www.scaleway.com/en/bare-metal-servers/).
The following meta labels are available on targets during [relabeling](#relabel_config):
#### Instance role
Scaleway SD: Add more labels to the instance role Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2021-03-11 16:03:27 -08:00
* `__meta_scaleway_instance_boot_type`: the boot type of the server
* `__meta_scaleway_instance_hostname`: the hostname of the server
* `__meta_scaleway_instance_id`: the ID of the server
* `__meta_scaleway_instance_image_arch`: the arch of the server image
* `__meta_scaleway_instance_image_id`: the ID of the server image
* `__meta_scaleway_instance_image_name`: the name of the server image
* `__meta_scaleway_instance_location_cluster_id`: the cluster ID of the server location
* `__meta_scaleway_instance_location_hypervisor_id`: the hypervisor ID of the server location
* `__meta_scaleway_instance_location_node_id`: the node ID of the server location
add support for scaleway service discovery (#8555) Co-authored-by: Patrik <patrik@ptrk.io> Co-authored-by: Julien Pivotto <roidelapluie@inuits.eu> Signed-off-by: Rémy Léone <rleone@scaleway.com>
2021-03-10 06:10:17 -08:00
* `__meta_scaleway_instance_name`: name of the server
Rename to or ID Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2021-03-12 14:53:08 -08:00
* `__meta_scaleway_instance_organization_id`: the organization of the server
Scaleway SD: Add more labels to the instance role Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2021-03-11 16:03:27 -08:00
* `__meta_scaleway_instance_private_ipv4`: the private IPv4 address of the server
add support for scaleway service discovery (#8555) Co-authored-by: Patrik <patrik@ptrk.io> Co-authored-by: Julien Pivotto <roidelapluie@inuits.eu> Signed-off-by: Rémy Léone <rleone@scaleway.com>
2021-03-10 06:10:17 -08:00
* `__meta_scaleway_instance_project_id`: project id of the server
Scaleway SD: Add more labels to the instance role Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2021-03-11 16:03:27 -08:00
* `__meta_scaleway_instance_public_ipv4`: the public IPv4 address of the server
* `__meta_scaleway_instance_public_ipv6`: the public IPv6 address of the server
* `__meta_scaleway_instance_region`: the region of the server
* `__meta_scaleway_instance_security_group_id`: the ID of the security group of the server
* `__meta_scaleway_instance_security_group_name`: the name of the security group of the server
add support for scaleway service discovery (#8555) Co-authored-by: Patrik <patrik@ptrk.io> Co-authored-by: Julien Pivotto <roidelapluie@inuits.eu> Signed-off-by: Rémy Léone <rleone@scaleway.com>
2021-03-10 06:10:17 -08:00
* `__meta_scaleway_instance_status`: status of the server
Scaleway SD: Add more labels to the instance role Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2021-03-11 16:03:27 -08:00
* `__meta_scaleway_instance_tags`: the list of tags of the server joined by the tag separator
add support for scaleway service discovery (#8555) Co-authored-by: Patrik <patrik@ptrk.io> Co-authored-by: Julien Pivotto <roidelapluie@inuits.eu> Signed-off-by: Rémy Léone <rleone@scaleway.com>
2021-03-10 06:10:17 -08:00
* `__meta_scaleway_instance_type`: commercial type of the server
Scaleway SD: Add more labels to the instance role Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2021-03-11 16:03:27 -08:00
* `__meta_scaleway_instance_zone`: the zone of the server (ex: `fr-par-1`, complete list [here](https://developers.scaleway.com/en/products/instance/api/#introduction))
add support for scaleway service discovery (#8555) Co-authored-by: Patrik <patrik@ptrk.io> Co-authored-by: Julien Pivotto <roidelapluie@inuits.eu> Signed-off-by: Rémy Léone <rleone@scaleway.com>
2021-03-10 06:10:17 -08:00
This role uses the private IPv4 address by default. This can be
changed with relabelling, as demonstrated in [the Prometheus scaleway-sd
configuration file](/documentation/examples/prometheus-scaleway.yml).
#### Baremetal role
Scaleway SD: Add more labels to the instance role Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2021-03-11 16:03:27 -08:00
* `__meta_scaleway_baremetal_id`: the ID of the server
* `__meta_scaleway_baremetal_public_ipv4`: the public IPv4 address of the server
* `__meta_scaleway_baremetal_public_ipv6`: the public IPv6 address of the server
* `__meta_scaleway_baremetal_name`: the name of the server
* `__meta_scaleway_baremetal_os_name`: the name of the operating system of the server
* `__meta_scaleway_baremetal_os_version`: the version of the operating system of the server
* `__meta_scaleway_baremetal_project_id`: the project ID of the server
* `__meta_scaleway_baremetal_status`: the status of the server
* `__meta_scaleway_baremetal_tags`: the list of tags of the server joined by the tag separator
* `__meta_scaleway_baremetal_type`: the commercial type of the server
* `__meta_scaleway_baremetal_zone`: the zone of the server (ex: `fr-par-1`, complete list [here](https://developers.scaleway.com/en/products/instance/api/#introduction))
add support for scaleway service discovery (#8555) Co-authored-by: Patrik <patrik@ptrk.io> Co-authored-by: Julien Pivotto <roidelapluie@inuits.eu> Signed-off-by: Rémy Léone <rleone@scaleway.com>
2021-03-10 06:10:17 -08:00
This role uses the public IPv4 address by default. This can be
changed with relabelling, as demonstrated in [the Prometheus scaleway-sd
configuration file](/documentation/examples/prometheus-scaleway.yml).
See below for the configuration options for Scaleway discovery:
```yaml
# Access key to use. https://console.scaleway.com/project/credentials
access_key: <string>
# Secret key to use when listing targets. https://console.scaleway.com/project/credentials
Scaleway SD: Add the ability to read token from file Prometheus adds the ability to read secrets from files. This add this feature for the scaleway service discovery. Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2021-03-24 16:33:21 -07:00
# It is mutually exclusive with `secret_key_file`.
[ secret_key: <secret> ]
# Sets the secret key with the credentials read from the configured file.
# It is mutually exclusive with `secret_key`.
[ secret_key_file: <filename> ]
add support for scaleway service discovery (#8555) Co-authored-by: Patrik <patrik@ptrk.io> Co-authored-by: Julien Pivotto <roidelapluie@inuits.eu> Signed-off-by: Rémy Léone <rleone@scaleway.com>
2021-03-10 06:10:17 -08:00
# Project ID of the targets.
project_id: <string>
# Role of the targets to retrieve. Must be `instance` or `baremetal`.
role: <string>
# The port to scrape metrics from.
[ port: <int> | default = 80 ]
# API URL to use when doing the server listing requests.
[ api_url: <string> | default = "https://api.scaleway.com" ]
# Zone is the availability zone of your targets (e.g. fr-par-1).
[ zone: <string> | default = fr-par-1 ]
# NameFilter specify a name filter (works as a LIKE) to apply on the server listing request.
[ name_filter: <string> ]
# TagsFilter specify a tag filter (a server needs to have all defined tags to be listed) to apply on the server listing request.
tags_filter:
[ - <string> ]
# Refresh interval to re-read the targets list.
[ refresh_interval: <duration> | default = 60s ]
# Configure whether HTTP requests follow HTTP 3xx redirects.
[ follow_redirects: <bool> | default = true ]
# Optional proxy URL.
[ proxy_url: <string> ]
# TLS configuration.
tls_config:
[ <tls_config> ]
```
Add Eureka Service Discovery (#3369) Signed-off-by: kangwoo <kangwoo@gmail.com>
2020-08-26 08:36:59 -07:00
Add Uyuni service discovery (#8190) * Add Uyuni service discovery Signed-off-by: Witek Bedyk <witold.bedyk@suse.com> Co-authored-by: Joao Cavalheiro <jcavalheiro@suse.de> Co-authored-by: Marcelo Chiaradia <mchiaradia@suse.com> Co-authored-by: Stefano Torresi <stefano@torresi.io> Co-authored-by: Julien Pivotto <roidelapluie@gmail.com>
2021-10-18 16:00:44 -07:00
### `<uyuni_sd_config>`
Uyuni SD configurations allow retrieving scrape targets from managed systems
via [Uyuni](https://www.uyuni-project.org/) API.
The following meta labels are available on targets during [relabeling](#relabel_config):
* `__meta_uyuni_endpoint_name`: the name of the application endpoint
* `__meta_uyuni_exporter`: the exporter exposing metrics for the target
* `__meta_uyuni_groups`: the system groups of the target
* `__meta_uyuni_metrics_path`: metrics path for the target
* `__meta_uyuni_minion_hostname`: hostname of the Uyuni client
* `__meta_uyuni_primary_fqdn`: primary FQDN of the Uyuni client
* `__meta_uyuni_proxy_module`: the module name if _Exporter Exporter_ proxy is
configured for the target
* `__meta_uyuni_scheme`: the protocol scheme used for requests
* `__meta_uyuni_system_id`: the system ID of the client
See below for the configuration options for Uyuni discovery:
```yaml
# The URL to connect to the Uyuni server.
server: <string>
# Credentials are used to authenticate the requests to Uyuni API.
username: <string>
password: <secret>
# The entitlement string to filter eligible systems.
[ entitlement: <string> | default = monitoring_entitled ]
# The string by which Uyuni group names are joined into the groups label.
[ separator: <string> | default = , ]
# Refresh interval to re-read the managed targets list.
[ refresh_interval: <duration> | default = 60s ]
# Optional HTTP basic authentication information, currently not supported by Uyuni.
basic_auth:
[ username: <string> ]
[ password: <secret> ]
[ password_file: <string> ]
# Optional `Authorization` header configuration, currently not supported by Uyuni.
authorization:
# Sets the authentication type.
[ type: <string> | default: Bearer ]
# Sets the credentials. It is mutually exclusive with
# `credentials_file`.
[ credentials: <secret> ]
# Sets the credentials to the credentials read from the configured file.
# It is mutually exclusive with `credentials`.
[ credentials_file: <filename> ]
# Optional OAuth 2.0 configuration, currently not supported by Uyuni.
# Cannot be used at the same time as basic_auth or authorization.
oauth2:
[ <oauth2> ]
# Optional proxy URL.
[ proxy_url: <string> ]
# Configure whether HTTP requests follow HTTP 3xx redirects.
[ follow_redirects: <bool> | default = true ]
# TLS configuration.
tls_config:
[ <tls_config> ]
```
See [the Prometheus uyuni-sd configuration file](/documentation/examples/prometheus-uyuni.yml)
for a practical example on how to set up Uyuni Prometheus configuration.
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
### `<static_config>`
A `static_config` allows specifying a list of targets and a common label set
for them. It is the canonical way to specify static targets in a scrape
configuration.
```yaml
# The targets specified by the static config.
targets:
[ - '<host>' ]
# Labels assigned to all metrics scraped from the targets.
labels:
[ <labelname>: <labelvalue> ... ]
```
### `<relabel_config>`
Relabeling is a powerful tool to dynamically rewrite the label set of a target before
it gets scraped. Multiple relabeling steps can be configured per scrape configuration.
They are applied to the label set of each target in order of their appearance
in the configuration file.
Initially, aside from the configured per-target labels, a target's `job`
label is set to the `job_name` value of the respective scrape configuration.
The `__address__` label is set to the `<host>:<port>` address of the target.
After relabeling, the `instance` label is set to the value of `__address__` by default if
it was not set during relabeling. The `__scheme__` and `__metrics_path__` labels
are set to the scheme and metrics path of the target respectively. The `__param_<name>`
label is set to the value of the first passed URL parameter called `<name>`.
Configure Scrape Interval and Timeout Via Relabeling (#8911) * Configure scrape interval and timeout with labels Signed-off-by: Levi Harrison <git@leviharrison.dev>
2021-08-31 08:37:32 -07:00
The `__scrape_interval__` and `__scrape_timeout__` labels are set to the target's
interval and timeout. This is **experimental** and could change in the future.
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
Additional labels prefixed with `__meta_` may be available during the
relabeling phase. They are set by the service discovery mechanism that provided
the target and vary between mechanisms.
Niptick about relabel config (#4994) Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2018-12-21 02:42:18 -08:00
Labels starting with `__` will be removed from the label set after target
relabeling is completed.
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
If a relabeling step needs to store a label value only temporarily (as the
input to a subsequent relabeling step), use the `__tmp` label name prefix. This
prefix is guaranteed to never be used by Prometheus itself.
```yaml
# The source labels select values from existing labels. Their content is concatenated
# using the configured separator and matched against the configured regular expression
# for the replace, keep, and drop actions.
[ source_labels: '[' <labelname> [, ...] ']' ]
# Separator placed between concatenated source label values.
[ separator: <string> | default = ; ]
# Label to which the resulting value is written in a replace action.
# It is mandatory for replace actions. Regex capture groups are available.
[ target_label: <labelname> ]
# Regular expression against which the extracted value is matched.
[ regex: <regex> | default = (.*) ]
# Modulus to take of the hash of the source label values.
Docs: fix types (#7508) I have batched a bunch of fixes around types in the documentation. Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2020-07-02 14:27:14 -07:00
[ modulus: <int> ]
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
# Replacement value against which a regex replace is performed if the
# regular expression matches. Regex capture groups are available.
[ replacement: <string> | default = $1 ]
# Action to perform based on regex matching.
[ action: <relabel_action> | default = replace ]
```
`<regex>` is any valid
[RE2 regular expression](https://github.com/google/re2/wiki/Syntax). It is
required for the `replace`, `keep`, `drop`, `labelmap`,`labeldrop` and `labelkeep` actions. The regex is
anchored on both ends. To un-anchor the regex, use `.*<regex>.*`.
`<relabel_action>` determines the relabeling action to take:
* `replace`: Match `regex` against the concatenated `source_labels`. Then, set
`target_label` to `replacement`, with match group references
(`${1}`, `${2}`, ...) in `replacement` substituted by their value. If `regex`
does not match, no replacement takes place.
* `keep`: Drop targets for which `regex` does not match the concatenated `source_labels`.
* `drop`: Drop targets for which `regex` matches the concatenated `source_labels`.
* `hashmod`: Set `target_label` to the `modulus` of a hash of the concatenated `source_labels`.
* `labelmap`: Match `regex` against all label names. Then copy the values of the matching labels
to label names given by `replacement` with match group references
(`${1}`, `${2}`, ...) in `replacement` substituted by their value.
* `labeldrop`: Match `regex` against all label names. Any label that matches will be
removed from the set of labels.
* `labelkeep`: Match `regex` against all label names. Any label that does not match will be
removed from the set of labels.
config&notifier: Add option to use Alertmanager API v2 With v0.16.0 Alertmanager introduced a new API (v2). This patch adds a configuration option for Prometheus to send alerts to the v2 endpoint instead of the defautl v1 endpoint. Signed-off-by: Max Leonard Inden <IndenML@gmail.com>
2019-04-18 05:17:03 -07:00
Care must be taken with `labeldrop` and `labelkeep` to ensure that metrics are
still uniquely labeled once the labels are removed.
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
### `<metric_relabel_configs>`
Metric relabeling is applied to samples as the last step before ingestion. It
has the same configuration format and actions as target relabeling. Metric
relabeling does not apply to automatically generated timeseries such as `up`.
Change metrics relabel terminology (#7362) Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2020-06-08 21:40:45 -07:00
One use for this is to exclude time series that are too expensive to ingest.
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
### `<alert_relabel_configs>`
Alert relabeling is applied to alerts before they are sent to the Alertmanager.
It has the same configuration format and actions as target relabeling. Alert
relabeling is applied after external labels.
One use for this is ensuring a HA pair of Prometheus servers with different
external labels send identical alerts.
### `<alertmanager_config>`
config&notifier: Add option to use Alertmanager API v2 With v0.16.0 Alertmanager introduced a new API (v2). This patch adds a configuration option for Prometheus to send alerts to the v2 endpoint instead of the defautl v1 endpoint. Signed-off-by: Max Leonard Inden <IndenML@gmail.com>
2019-04-18 05:17:03 -07:00
An `alertmanager_config` section specifies Alertmanager instances the Prometheus
server sends alerts to. It also provides parameters to configure how to
communicate with these Alertmanagers.
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
Alertmanagers may be statically configured via the `static_configs` parameter or
dynamically discovered using one of the supported service-discovery mechanisms.
Additionally, `relabel_configs` allow selecting Alertmanagers from discovered
entities and provide advanced modifications to the used API path, which is exposed
through the `__alerts_path__` label.
```yaml
# Per-target Alertmanager timeout when pushing alerts.
[ timeout: <duration> | default = 10s ]
config&notifier: Add option to use Alertmanager API v2 With v0.16.0 Alertmanager introduced a new API (v2). This patch adds a configuration option for Prometheus to send alerts to the v2 endpoint instead of the defautl v1 endpoint. Signed-off-by: Max Leonard Inden <IndenML@gmail.com>
2019-04-18 05:17:03 -07:00
# The api version of Alertmanager.
Switch to alertmanager api v2 According to the 2.25 release notes, 2.26 should switch to alertmanager api v2 by default. Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2021-03-19 10:19:12 -07:00
[ api_version: <string> | default = v2 ]
config&notifier: Add option to use Alertmanager API v2 With v0.16.0 Alertmanager introduced a new API (v2). This patch adds a configuration option for Prometheus to send alerts to the v2 endpoint instead of the defautl v1 endpoint. Signed-off-by: Max Leonard Inden <IndenML@gmail.com>
2019-04-18 05:17:03 -07:00
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
# Prefix for the HTTP path alerts are pushed to.
[ path_prefix: <path> | default = / ]
# Configures the protocol scheme used for requests.
[ scheme: <scheme> | default = http ]
# Sets the `Authorization` header on every request with the
# configured username and password.
support reading basic_auth password_file for HTTP basic auth (#4077) Issue: https://github.com/prometheus/prometheus/issues/4076 Signed-off-by: Adam Shannon <adamkshannon@gmail.com>
2018-04-25 10:19:06 -07:00
# password and password_file are mutually exclusive.
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
basic_auth:
[ username: <string> ]
Docs: fix types (#7508) I have batched a bunch of fixes around types in the documentation. Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2020-07-02 14:27:14 -07:00
[ password: <secret> ]
support reading basic_auth password_file for HTTP basic auth (#4077) Issue: https://github.com/prometheus/prometheus/issues/4076 Signed-off-by: Adam Shannon <adamkshannon@gmail.com>
2018-04-25 10:19:06 -07:00
[ password_file: <string> ]
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
http_sd (#8839) Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2021-06-11 09:04:45 -07:00
# Optional `Authorization` header configuration.
Update common to support credentials type Most of the backwards compat tests is done in common. Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2021-02-18 14:14:49 -08:00
authorization:
# Sets the authentication type.
[ type: <string> | default: Bearer ]
# Sets the credentials. It is mutually exclusive with
# `credentials_file`.
[ credentials: <secret> ]
http_sd (#8839) Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2021-06-11 09:04:45 -07:00
# Sets the credentials to the credentials read from the configured file.
Update common to support credentials type Most of the backwards compat tests is done in common. Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2021-02-18 14:14:49 -08:00
# It is mutually exclusive with `credentials`.
[ credentials_file: <filename> ]
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
Add OAuth 2.0 Config (#8761) * Introduced oauth2 config into the codebase Signed-off-by: Levi Harrison <git@leviharrison.dev>
2021-04-28 05:47:52 -07:00
# Optional OAuth 2.0 configuration.
# Cannot be used at the same time as basic_auth or authorization.
oauth2:
[ <oauth2> ]
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
# Configures the scrape request's TLS settings.
tls_config:
[ <tls_config> ]
# Optional proxy URL.
[ proxy_url: <string> ]
Support follow_redirect This PR introduces support for follow_redirect, to enable users to disable following HTTP redirects. Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2021-02-26 13:48:06 -08:00
# Configure whether HTTP requests follow HTTP 3xx redirects.
[ follow_redirects: <bool> | default = true ]
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
# List of Azure service discovery configurations.
azure_sd_configs:
[ - <azure_sd_config> ... ]
# List of Consul service discovery configurations.
consul_sd_configs:
[ - <consul_sd_config> ... ]
# List of DNS service discovery configurations.
dns_sd_configs:
[ - <dns_sd_config> ... ]
# List of EC2 service discovery configurations.
ec2_sd_configs:
[ - <ec2_sd_config> ... ]
Add Eureka Service Discovery (#3369) Signed-off-by: kangwoo <kangwoo@gmail.com>
2020-08-26 08:36:59 -07:00
# List of Eureka service discovery configurations.
eureka_sd_configs:
[ - <eureka_sd_config> ... ]
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
# List of file service discovery configurations.
file_sd_configs:
[ - <file_sd_config> ... ]
Add new SD's to alertmanager config (#7584) Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2020-07-15 11:51:14 -07:00
# List of DigitalOcean service discovery configurations.
digitalocean_sd_configs:
[ - <digitalocean_sd_config> ... ]
Implement Docker discovery (#8629) * Implement Docker discovery Signed-off-by: Robert Jacob <xperimental@solidproject.de>
2021-03-29 13:30:23 -07:00
# List of Docker service discovery configurations.
docker_sd_configs:
[ - <docker_sd_config> ... ]
Add new SD's to alertmanager config (#7584) Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2020-07-15 11:51:14 -07:00
# List of Docker Swarm service discovery configurations.
dockerswarm_sd_configs:
[ - <dockerswarm_sd_config> ... ]
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
# List of GCE service discovery configurations.
gce_sd_configs:
[ - <gce_sd_config> ... ]
Add hetzner service discovery (#7822) Signed-off-by: Lukas Kämmerling <lukas.kaemmerling@hetzner-cloud.de>
2020-08-21 06:49:19 -07:00
# List of Hetzner service discovery configurations.
hetzner_sd_configs:
[ - <hetzner_sd_config> ... ]
http_sd (#8839) Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2021-06-11 09:04:45 -07:00
# List of HTTP service discovery configurations.
http_sd_configs:
[ - <http_sd_config> ... ]
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
# List of Kubernetes service discovery configurations.
kubernetes_sd_configs:
[ - <kubernetes_sd_config> ... ]
Add lightsail service discovery (#8693) Signed-off-by: N888 <drifto@gmail.com>
2021-04-28 02:29:12 -07:00
# List of Lightsail service discovery configurations.
lightsail_sd_configs:
Fix indentation Signed-off-by: Sandro Jäckel <sandro.jaeckel@gmail.com>
2021-05-15 20:22:50 -07:00
[ - <lightsail_sd_config> ... ]
Add lightsail service discovery (#8693) Signed-off-by: N888 <drifto@gmail.com>
2021-04-28 02:29:12 -07:00
Add Linode Service Discovery (#8846) * Add Linode Service Discovery Signed-off-by: TJ Hoplock <t.hoplock@gmail.com>
2021-06-01 11:32:36 -07:00
# List of Linode service discovery configurations.
linode_sd_configs:
[ - <linode_sd_config> ... ]
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
# List of Marathon service discovery configurations.
marathon_sd_configs:
[ - <marathon_sd_config> ... ]
# List of AirBnB's Nerve service discovery configurations.
nerve_sd_configs:
[ - <nerve_sd_config> ... ]
Add new SD's to alertmanager config (#7584) Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2020-07-15 11:51:14 -07:00
# List of OpenStack service discovery configurations.
openstack_sd_configs:
[ - <openstack_sd_config> ... ]
Add PuppetDB service discovery We have been Puppet user for 10 years and we are users of https://github.com/camptocamp/prometheus-puppetdb-sd However, that file_sd implementation contains business logic and assumptions around e.g. the modules which you are using. This pull request adds a simple PuppetDB service discovery, which will enable more use cases than the upstream sd. Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2021-06-01 05:04:58 -07:00
# List of PuppetDB service discovery configurations.
puppetdb_sd_configs:
[ - <puppetdb_sd_config> ... ]
add support for scaleway service discovery (#8555) Co-authored-by: Patrik <patrik@ptrk.io> Co-authored-by: Julien Pivotto <roidelapluie@inuits.eu> Signed-off-by: Rémy Léone <rleone@scaleway.com>
2021-03-10 06:10:17 -08:00
# List of Scaleway service discovery configurations.
scaleway_sd_configs:
[ - <scaleway_sd_config> ... ]
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
# List of Zookeeper Serverset service discovery configurations.
serverset_sd_configs:
[ - <serverset_sd_config> ... ]
# List of Triton service discovery configurations.
triton_sd_configs:
[ - <triton_sd_config> ... ]
Add Uyuni service discovery (#8190) * Add Uyuni service discovery Signed-off-by: Witek Bedyk <witold.bedyk@suse.com> Co-authored-by: Joao Cavalheiro <jcavalheiro@suse.de> Co-authored-by: Marcelo Chiaradia <mchiaradia@suse.com> Co-authored-by: Stefano Torresi <stefano@torresi.io> Co-authored-by: Julien Pivotto <roidelapluie@gmail.com>
2021-10-18 16:00:44 -07:00
# List of Uyuni service discovery configurations.
uyuni_sd_configs:
[ - <uyuni_sd_config> ... ]
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
# List of labeled statically configured Alertmanagers.
static_configs:
[ - <static_config> ... ]
# List of Alertmanager relabel configurations.
relabel_configs:
[ - <relabel_config> ... ]
```
### `<remote_write>`
`write_relabel_configs` is relabeling applied to samples before sending them
to the remote endpoint. Write relabeling is applied after external labels. This
could be used to limit which samples are sent.
There is a [small demo](/documentation/examples/remote_storage) of how to use
this functionality.
```yaml
# The URL of the endpoint to send samples to.
url: <string>
# Timeout for requests to the remote write endpoint.
[ remote_timeout: <duration> | default = 30s ]
remote_write: allow passing along custom HTTP headers (#8416) * remote_write: allow passing along custom HTTP headers Signed-off-by: Nandor Kracser <bonifaido@gmail.com> * add warning Signed-off-by: Nandor Kracser <bonifaido@gmail.com> * remote_write: add header valadtion Signed-off-by: Nandor Kracser <bonifaido@gmail.com> * extend tests for bad remote write headers Signed-off-by: Nandor Kracser <bonifaido@gmail.com> * remote_write: add note about the authorization header Signed-off-by: Nandor Kracser <bonifaido@gmail.com>
2021-02-04 13:18:13 -08:00
# Custom HTTP headers to be sent along with each remote write request.
# Be aware that headers that are set by Prometheus itself can't be overwritten.
headers:
[ <string>: <string> ... ]
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
# List of remote write relabel configurations.
write_relabel_configs:
[ - <relabel_config> ... ]
Contribute grafana/agent sigv4 code (#8509) * Contribute grafana/agent sigv4 code * address review feedback - move validation logic for RemoteWrite into unmarshal - copy configuration fields from ec2 SD config - remove enabled field, use pointer for enabling sigv4 * Update config/config.go * Don't provide credentials if secret key / access key left blank * Add SigV4 headers to the list of unchangeable headers. * sigv4: don't include all headers in signature * only test for equality in the authorization header, not the signed date * address review feedback 1. s/httpClientConfigEnabled/httpClientConfigAuthEnabled 2. bearer_token tuples to "authorization" 3. Un-export NewSigV4RoundTripper * add x-amz-content-sha256 to list of unchangeable headers * Document sigv4 configuration * add suggestion for using default AWS SDK credentials Signed-off-by: Robert Fratto <robertfratto@gmail.com> Co-authored-by: Julien Pivotto <roidelapluie@gmail.com>
2021-03-08 11:20:09 -08:00
# Name of the remote write config, which if specified must be unique among remote write configs.
Add missing remote write/read config name to docs. (#7105) Signed-off-by: Callum Styan <callumstyan@gmail.com>
2020-04-14 09:27:33 -07:00
# The name will be used in metrics and logging in place of a generated value to help users distinguish between
# remote write configs.
[ name: <string> ]
Add Exemplar Remote Write support (#8296) * Write exemplars to the WAL and send them over remote write. Signed-off-by: Callum Styan <callumstyan@gmail.com> * Update example for exemplars, print data in a more obvious format. Signed-off-by: Callum Styan <callumstyan@gmail.com> * Add metrics for remote write of exemplars. Signed-off-by: Callum Styan <callumstyan@gmail.com> * Fix incorrect slices passed to send in remote write. Signed-off-by: Callum Styan <callumstyan@gmail.com> * We need to unregister the new metrics. Signed-off-by: Callum Styan <callumstyan@gmail.com> * Address review comments Signed-off-by: Callum Styan <callumstyan@gmail.com> * Order of exemplar append vs write exemplar to WAL needs to change. Signed-off-by: Callum Styan <callumstyan@gmail.com> * Several fixes to prevent sending uninitialized or incorrect samples with an exemplar. Fix dropping exemplar for missing series. Add tests for queue_manager sending exemplars Signed-off-by: Martin Disibio <mdisibio@gmail.com> * Store both samples and exemplars in the same timeseries buffer to remove the alloc when building final request, keep sub-slices in separate buffers for re-use Signed-off-by: Martin Disibio <mdisibio@gmail.com> * Condense sample/exemplar delivery tests to parameterized sub-tests Signed-off-by: Martin Disibio <mdisibio@gmail.com> * Rename test methods for clarity now that they also handle exemplars Signed-off-by: Martin Disibio <mdisibio@gmail.com> * Rename counter variable. Fix instances where metrics were not updated correctly Signed-off-by: Martin Disibio <mdisibio@gmail.com> * Add exemplars to LoadWAL benchmark Signed-off-by: Callum Styan <callumstyan@gmail.com> * last exemplars timestamp metric needs to convert value to seconds with ms precision Signed-off-by: Callum Styan <callumstyan@gmail.com> * Process exemplar records in a separate go routine when loading the WAL. Signed-off-by: Callum Styan <callumstyan@gmail.com> * Address review comments related to clarifying comments and variable names. Also refactor sample/exemplar to enqueue prompb types. Signed-off-by: Callum Styan <callumstyan@gmail.com> * Regenerate types proto with comments, update protoc version again. Signed-off-by: Callum Styan <callumstyan@gmail.com> * Put remote write of exemplars behind a feature flag. Signed-off-by: Callum Styan <callumstyan@gmail.com> * Address some of Ganesh's review comments. Signed-off-by: Callum Styan <callumstyan@gmail.com> * Move exemplar remote write feature flag to a config file field. Signed-off-by: Callum Styan <callumstyan@gmail.com> * Address Bartek's review comments. Signed-off-by: Callum Styan <callumstyan@gmail.com> * Don't allocate exemplar buffers in queue_manager if we're not going to send exemplars over remote write. Signed-off-by: Callum Styan <callumstyan@gmail.com> * Add ValidateExemplar function, validate exemplars when appending to head and log them all to WAL before adding them to exemplar storage. Signed-off-by: Callum Styan <callumstyan@gmail.com> * Address more reivew comments from Ganesh. Signed-off-by: Callum Styan <callumstyan@gmail.com> * Add exemplar total label length check. Signed-off-by: Callum Styan <callumstyan@gmail.com> * Address a few last review comments Signed-off-by: Callum Styan <callumstyan@gmail.com> Co-authored-by: Martin Disibio <mdisibio@gmail.com>
2021-05-06 13:53:52 -07:00
# Enables sending of exemplars over remote write. Note that exemplar storage itself must be enabled for exemplars to be scraped in the first place.
[ send_exemplars: <boolean> | default = false ]
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
# Sets the `Authorization` header on every remote write request with the
# configured username and password.
support reading basic_auth password_file for HTTP basic auth (#4077) Issue: https://github.com/prometheus/prometheus/issues/4076 Signed-off-by: Adam Shannon <adamkshannon@gmail.com>
2018-04-25 10:19:06 -07:00
# password and password_file are mutually exclusive.
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
basic_auth:
[ username: <string> ]
Docs: fix types (#7508) I have batched a bunch of fixes around types in the documentation. Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2020-07-02 14:27:14 -07:00
[ password: <secret> ]
support reading basic_auth password_file for HTTP basic auth (#4077) Issue: https://github.com/prometheus/prometheus/issues/4076 Signed-off-by: Adam Shannon <adamkshannon@gmail.com>
2018-04-25 10:19:06 -07:00
[ password_file: <string> ]
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
http_sd (#8839) Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2021-06-11 09:04:45 -07:00
# Optional `Authorization` header configuration.
Update common to support credentials type Most of the backwards compat tests is done in common. Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2021-02-18 14:14:49 -08:00
authorization:
# Sets the authentication type.
[ type: <string> | default: Bearer ]
# Sets the credentials. It is mutually exclusive with
# `credentials_file`.
[ credentials: <secret> ]
http_sd (#8839) Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2021-06-11 09:04:45 -07:00
# Sets the credentials to the credentials read from the configured file.
Update common to support credentials type Most of the backwards compat tests is done in common. Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2021-02-18 14:14:49 -08:00
# It is mutually exclusive with `credentials`.
[ credentials_file: <filename> ]
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
Contribute grafana/agent sigv4 code (#8509) * Contribute grafana/agent sigv4 code * address review feedback - move validation logic for RemoteWrite into unmarshal - copy configuration fields from ec2 SD config - remove enabled field, use pointer for enabling sigv4 * Update config/config.go * Don't provide credentials if secret key / access key left blank * Add SigV4 headers to the list of unchangeable headers. * sigv4: don't include all headers in signature * only test for equality in the authorization header, not the signed date * address review feedback 1. s/httpClientConfigEnabled/httpClientConfigAuthEnabled 2. bearer_token tuples to "authorization" 3. Un-export NewSigV4RoundTripper * add x-amz-content-sha256 to list of unchangeable headers * Document sigv4 configuration * add suggestion for using default AWS SDK credentials Signed-off-by: Robert Fratto <robertfratto@gmail.com> Co-authored-by: Julien Pivotto <roidelapluie@gmail.com>
2021-03-08 11:20:09 -08:00
# Optionally configures AWS's Signature Verification 4 signing process to
Add OAuth 2.0 Config (#8761) * Introduced oauth2 config into the codebase Signed-off-by: Levi Harrison <git@leviharrison.dev>
2021-04-28 05:47:52 -07:00
# sign requests. Cannot be set at the same time as basic_auth, authorization, or oauth2.
Contribute grafana/agent sigv4 code (#8509) * Contribute grafana/agent sigv4 code * address review feedback - move validation logic for RemoteWrite into unmarshal - copy configuration fields from ec2 SD config - remove enabled field, use pointer for enabling sigv4 * Update config/config.go * Don't provide credentials if secret key / access key left blank * Add SigV4 headers to the list of unchangeable headers. * sigv4: don't include all headers in signature * only test for equality in the authorization header, not the signed date * address review feedback 1. s/httpClientConfigEnabled/httpClientConfigAuthEnabled 2. bearer_token tuples to "authorization" 3. Un-export NewSigV4RoundTripper * add x-amz-content-sha256 to list of unchangeable headers * Document sigv4 configuration * add suggestion for using default AWS SDK credentials Signed-off-by: Robert Fratto <robertfratto@gmail.com> Co-authored-by: Julien Pivotto <roidelapluie@gmail.com>
2021-03-08 11:20:09 -08:00
# To use the default credentials from the AWS SDK, use `sigv4: {}`.
sigv4:
# The AWS region. If blank, the region from the default credentials chain
# is used.
[ region: <string> ]
# The AWS API keys. If blank, the environment variables `AWS_ACCESS_KEY_ID`
# and `AWS_SECRET_ACCESS_KEY` are used.
[ access_key: <string> ]
[ secret_key: <secret> ]
# Named AWS profile used to authenticate.
[ profile: <string> ]
# AWS Role ARN, an alternative to using AWS API keys.
[ role_arn: <string> ]
Add OAuth 2.0 Config (#8761) * Introduced oauth2 config into the codebase Signed-off-by: Levi Harrison <git@leviharrison.dev>
2021-04-28 05:47:52 -07:00
# Optional OAuth 2.0 configuration.
# Cannot be used at the same time as basic_auth, authorization, or sigv4.
oauth2:
[ <oauth2> ]
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
# Configures the remote write request's TLS settings.
tls_config:
[ <tls_config> ]
# Optional proxy URL.
[ proxy_url: <string> ]
document remote write queue parameters (#4126)
2018-04-30 11:08:45 -07:00
Support follow_redirect This PR introduces support for follow_redirect, to enable users to disable following HTTP redirects. Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2021-02-26 13:48:06 -08:00
# Configure whether HTTP requests follow HTTP 3xx redirects.
[ follow_redirects: <bool> | default = true ]
document remote write queue parameters (#4126)
2018-04-30 11:08:45 -07:00
# Configures the queue used to write to remote storage.
queue_config:
Improve desired shards calculation (#5763) The desired shards calculation now properly keeps track of the rate of pending samples, and uses the previously unused integralAccumulator to adjust for missing information in the desired shards calculation. Also, configure more capacity for each shard. The default 10 capacity causes shards to block on each other while sending remote requests. Default to a 500 sample capacity and explain in the documentation that having more capacity will help throughput. Signed-off-by: Chris Marchbanks <csmarchbanks@gmail.com>
2019-08-13 02:10:21 -07:00
# Number of samples to buffer per shard before we block reading of more
# samples from the WAL. It is recommended to have enough capacity in each
# shard to buffer several requests to keep throughput up while processing
fix spelling mistakes in docs (#5952) Signed-off-by: hwdef <hwdef97@gmail.com>
2019-08-27 10:33:40 -07:00
# occasional slow remote requests.
Update remote_write default values in docs (#8103) Signed-off-by: Harkishen-Singh <harkishensingh@hotmail.com>
2020-10-23 04:12:14 -07:00
[ capacity: <int> | default = 2500 ]
document remote write queue parameters (#4126)
2018-04-30 11:08:45 -07:00
# Maximum number of shards, i.e. amount of concurrency.
Update remote_write default values in docs (#8103) Signed-off-by: Harkishen-Singh <harkishensingh@hotmail.com>
2020-10-23 04:12:14 -07:00
[ max_shards: <int> | default = 200 ]
Introduce min_shards for remote write to set minimum number of shards. (#4924) Signed-off-by: Ryota Arai <ryota.arai@gmail.com>
2018-12-04 09:32:14 -08:00
# Minimum number of shards, i.e. amount of concurrency.
[ min_shards: <int> | default = 1 ]
document remote write queue parameters (#4126)
2018-04-30 11:08:45 -07:00
# Maximum number of samples per send.
Update remote_write default values in docs (#8103) Signed-off-by: Harkishen-Singh <harkishensingh@hotmail.com>
2020-10-23 04:12:14 -07:00
[ max_samples_per_send: <int> | default = 500]
document remote write queue parameters (#4126)
2018-04-30 11:08:45 -07:00
# Maximum time a sample will wait in buffer.
[ batch_send_deadline: <duration> | default = 5s ]
# Initial retry delay. Gets doubled for every retry.
[ min_backoff: <duration> | default = 30ms ]
# Maximum retry delay.
[ max_backoff: <duration> | default = 100ms ]
Adds support to configure retry on Rate-Limiting from remote-write config. Signed-off-by: Harkishen-Singh <harkishensingh@hotmail.com>
2021-02-11 09:24:49 -08:00
# Retry upon receiving a 429 status code from the remote-write storage.
# This is experimental and might change in the future.
[ retry_on_http_429: <boolean> | default = false ]
remote_write documentation: fix blank lines (#8264) The blank line is not efficiently placed in the remote_write config, affecting readability. Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2020-12-08 05:27:50 -08:00
Allow metric metadata to be propagated via Remote Write. (#6815) * Introduce a metadata watcher Similarly to the WAL watcher, its purpose is to observe the scrape manager and pull metadata. Then, send it to a remote storage. Signed-off-by: gotjosh <josue@grafana.com> * Additional fixes after rebasing. Signed-off-by: Callum Styan <callumstyan@gmail.com> * Rework samples/metadata metrics. Signed-off-by: Callum Styan <callumstyan@gmail.com> * Use more descriptive variable names in MetadataWatcher collect. Signed-off-by: Callum Styan <callumstyan@gmail.com> * Fix issues caused during rebasing. Signed-off-by: Callum Styan <callumstyan@gmail.com> * Fix missing metric add and unneeded config code. Signed-off-by: Callum Styan <callumstyan@gmail.com> * Address some review comments. Signed-off-by: Callum Styan <callumstyan@gmail.com> * Fix metrics and docs Signed-off-by: Ganesh Vernekar <cs15btech11018@iith.ac.in> * Replace assert with require Signed-off-by: Ganesh Vernekar <cs15btech11018@iith.ac.in> * Bring back max_samples_per_send metric Signed-off-by: Ganesh Vernekar <cs15btech11018@iith.ac.in> * Fix tests Signed-off-by: Ganesh Vernekar <cs15btech11018@iith.ac.in> Co-authored-by: Callum Styan <callumstyan@gmail.com> Co-authored-by: Ganesh Vernekar <cs15btech11018@iith.ac.in>
2020-11-19 07:23:03 -08:00
# Configures the sending of series metadata to remote storage.
# Metadata configuration is subject to change at any point
# or be removed in future releases.
metadata_config:
# Whether metric metadata is sent to remote storage or not.
[ send: <boolean> | default = true ]
# How frequently metric metadata is sent to remote storage.
[ send_interval: <duration> | default = 1m ]
Remote Write: Add max samples per metadata send (#8959) * Added MaxSamplesPerSend Signed-off-by: Levi Harrison <git@leviharrison.dev> * Added tests Signed-off-by: Levi Harrison <git@leviharrison.dev> * Fixed order of require Signed-off-by: Levi Harrison <git@leviharrison.dev> * Added docs Signed-off-by: Levi Harrison <git@leviharrison.dev> * writes -> writesReceived Signed-off-by: Levi Harrison <git@leviharrison.dev> * Improved send loop Signed-off-by: Levi Harrison <git@leviharrison.dev>
2021-06-24 15:39:50 -07:00
# Maximum number of samples per send.
[ max_samples_per_send: <int> | default = 500]
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
```
There is a list of
Add prefix to relative 3 URLs (#3551)
2017-12-06 13:16:53 -08:00
[integrations](https://prometheus.io/docs/operating/integrations/#remote-endpoints-and-storage)
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
with this feature.
### `<remote_read>`
```yaml
# The URL of the endpoint to query from.
url: <string>
Contribute grafana/agent sigv4 code (#8509) * Contribute grafana/agent sigv4 code * address review feedback - move validation logic for RemoteWrite into unmarshal - copy configuration fields from ec2 SD config - remove enabled field, use pointer for enabling sigv4 * Update config/config.go * Don't provide credentials if secret key / access key left blank * Add SigV4 headers to the list of unchangeable headers. * sigv4: don't include all headers in signature * only test for equality in the authorization header, not the signed date * address review feedback 1. s/httpClientConfigEnabled/httpClientConfigAuthEnabled 2. bearer_token tuples to "authorization" 3. Un-export NewSigV4RoundTripper * add x-amz-content-sha256 to list of unchangeable headers * Document sigv4 configuration * add suggestion for using default AWS SDK credentials Signed-off-by: Robert Fratto <robertfratto@gmail.com> Co-authored-by: Julien Pivotto <roidelapluie@gmail.com>
2021-03-08 11:20:09 -08:00
# Name of the remote read config, which if specified must be unique among remote read configs.
Fix spelling (#7512) Signed-off-by: John Bampton <jbampton@users.noreply.github.com>
2020-07-04 05:54:26 -07:00
# The name will be used in metrics and logging in place of a generated value to help users distinguish between
Add missing remote write/read config name to docs. (#7105) Signed-off-by: Callum Styan <callumstyan@gmail.com>
2020-04-14 09:27:33 -07:00
# remote read configs.
[ name: <string> ]
Add remote read filter option For special remote read endpoints which have only data for specific queries, it is desired to limit the number of queries sent to the configured remote read endpoint to reduce latency and performance overhead.
2017-11-11 17:23:20 -08:00
# An optional list of equality matchers which have to be
# present in a selector to query the remote read endpoint.
required_matchers:
[ <labelname>: <labelvalue> ... ]
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
# Timeout for requests to the remote read endpoint.
docs: Fix remote_read/remote_timeout default (#3829)
2018-02-12 04:52:33 -08:00
[ remote_timeout: <duration> | default = 1m ]
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
Custom headers on remote-read and refactor implementation to roundtripper. Signed-off-by: Harkishen-Singh <harkishensingh@hotmail.com>
2021-02-18 04:12:21 -08:00
# Custom HTTP headers to be sent along with each remote read request.
# Be aware that headers that are set by Prometheus itself can't be overwritten.
headers:
[ <string>: <string> ... ]
Fix default of read_recent to be false. (#3617) This is what is documented in the migration guide, and the default settings should make sense for a true long term storage. Document the setting.
2017-12-23 09:21:38 -08:00
# Whether reads should be made for queries for time ranges that
# the local storage should have complete data for.
[ read_recent: <boolean> | default = false ]
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
# Sets the `Authorization` header on every remote read request with the
# configured username and password.
support reading basic_auth password_file for HTTP basic auth (#4077) Issue: https://github.com/prometheus/prometheus/issues/4076 Signed-off-by: Adam Shannon <adamkshannon@gmail.com>
2018-04-25 10:19:06 -07:00
# password and password_file are mutually exclusive.
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
basic_auth:
[ username: <string> ]
Docs: fix types (#7508) I have batched a bunch of fixes around types in the documentation. Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2020-07-02 14:27:14 -07:00
[ password: <secret> ]
support reading basic_auth password_file for HTTP basic auth (#4077) Issue: https://github.com/prometheus/prometheus/issues/4076 Signed-off-by: Adam Shannon <adamkshannon@gmail.com>
2018-04-25 10:19:06 -07:00
[ password_file: <string> ]
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
http_sd (#8839) Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2021-06-11 09:04:45 -07:00
# Optional `Authorization` header configuration.
Update common to support credentials type Most of the backwards compat tests is done in common. Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2021-02-18 14:14:49 -08:00
authorization:
# Sets the authentication type.
[ type: <string> | default: Bearer ]
# Sets the credentials. It is mutually exclusive with
# `credentials_file`.
[ credentials: <secret> ]
http_sd (#8839) Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2021-06-11 09:04:45 -07:00
# Sets the credentials to the credentials read from the configured file.
Update common to support credentials type Most of the backwards compat tests is done in common. Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2021-02-18 14:14:49 -08:00
# It is mutually exclusive with `credentials`.
[ credentials_file: <filename> ]
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
Add OAuth 2.0 Config (#8761) * Introduced oauth2 config into the codebase Signed-off-by: Levi Harrison <git@leviharrison.dev>
2021-04-28 05:47:52 -07:00
# Optional OAuth 2.0 configuration.
# Cannot be used at the same time as basic_auth or authorization.
oauth2:
[ <oauth2> ]
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
# Configures the remote read request's TLS settings.
tls_config:
[ <tls_config> ]
# Optional proxy URL.
[ proxy_url: <string> ]
Support follow_redirect This PR introduces support for follow_redirect, to enable users to disable following HTTP redirects. Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2021-02-26 13:48:06 -08:00
# Configure whether HTTP requests follow HTTP 3xx redirects.
[ follow_redirects: <bool> | default = true ]
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
```
There is a list of
Add prefix to relative 3 URLs (#3551)
2017-12-06 13:16:53 -08:00
[integrations](https://prometheus.io/docs/operating/integrations/#remote-endpoints-and-storage)
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 05:58:52 -07:00
with this feature.
Reference in a new issue Copy permalink