CAUTION: This page documents an old version of Prometheus. Check out the latest stable version.

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 instances, as well as which rule files to load.

To view all available command-line flags, run ./prometheus -h.

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 sending a HTTP POST request to the /-/reload endpoint (when the --web.enable-lifecycle flag is enabled). This will also reload any configured rule files.

Configuration file

To specify which configuration file to load, use the --config.file flag.

The file is written in YAML format, 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
  • <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
  • <filename>: a valid path in the current working directory
  • <float>: a floating-point number
  • <host>: a valid string consisting of a hostname or IP followed by an optional port number
  • <int>: an integer value
  • <labelname>: a string matching the regular expression [a-zA-Z_][a-zA-Z0-9_]*
  • <labelvalue>: a string of unicode characters
  • <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
  • <string>: a regular string
  • <size>: a size in bytes, e.g. 512MB. A unit is required. Supported units: B, KB, MB, GB, TB, PB, EB.
  • <tmpl_string>: a string which is template-expanded before usage

The other placeholders are specified separately.

A valid example file can be found here.

The global configuration specifies parameters that are valid in all other configuration contexts. They also serve as defaults for other configuration sections.

  1. global:
  2.   # How frequently to scrape targets by default.
  3.   [ scrape_interval: <duration> | default = 1m ]
  5.   # How long until a scrape request times out.
  6.   [ scrape_timeout: <duration> | default = 10s ]
  8.   # How frequently to evaluate rules.
  9.   [ evaluation_interval: <duration> | default = 1m ]
  11.   # The labels to add to any time series or alerts when communicating with
  12.   # external systems (federation, remote storage, Alertmanager).
  13.   external_labels:
  14.     [ <labelname>: <labelvalue> ... ]
  16.   # File to which PromQL queries are logged.
  17.   # Reloading the configuration will reopen the file.
  18.   [ query_log_file: <string> ]
  20. # Rule files specifies a list of globs. Rules and alerts are read from
  21. # all matching files.
  22. rule_files:
  23.   [ - <filepath_glob> ... ]
  25. # A list of scrape configurations.
  26. scrape_configs:
  27.   [ - <scrape_config> ... ]
  29. # Alerting specifies settings related to the Alertmanager.
  30. alerting:
  31.   alert_relabel_configs:
  32.     [ - <relabel_config> ... ]
  33.   alertmanagers:
  34.     [ - <alertmanager_config> ... ]
  36. # Settings related to the remote write feature.
  37. remote_write:
  38.   [ - <remote_write> ... ]
  40. # Settings related to the remote read feature.
  41. remote_read:
  42.   [ - <remote_read> ... ]
  44. # Storage related settings that are runtime reloadable.
  45. storage:
  46.   [ tsdb: <tsdb> ]
  47.   [ exemplars: <exemplars> ]
  49. # Configures exporting traces.
  50. tracing:
  51.   [ <tracing_config> ]

<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.

  1. # The job name assigned to scraped metrics by default.
  2. job_name: <job_name>
  4. # How frequently to scrape targets from this job.
  5. [ scrape_interval: <duration> | default = <global_config.scrape_interval> ]
  7. # Per-scrape timeout when scraping this job.
  8. [ scrape_timeout: <duration> | default = <global_config.scrape_timeout> ]
  10. # The HTTP resource path on which to fetch metrics from targets.
  11. [ metrics_path: <path> | default = /metrics ]
  13. # honor_labels controls how Prometheus handles conflicts between labels that are
  14. # already present in scraped data and labels that Prometheus would attach
  15. # server-side ("job" and "instance" labels, manually configured target
  16. # labels, and labels generated by service discovery implementations).
  17. #
  18. # If honor_labels is set to "true", label conflicts are resolved by keeping label
  19. # values from the scraped data and ignoring the conflicting server-side labels.
  20. #
  21. # If honor_labels is set to "false", label conflicts are resolved by renaming
  22. # conflicting labels in the scraped data to "exported_<original-label>" (for
  23. # example "exported_instance", "exported_job") and then attaching server-side
  24. # labels.
  25. #
  26. # Setting honor_labels to "true" is useful for use cases such as federation and
  27. # scraping the Pushgateway, where all labels specified in the target should be
  28. # preserved.
  29. #
  30. # Note that any globally configured "external_labels" are unaffected by this
  31. # setting. In communication with external systems, they are always applied only
  32. # when a time series does not have a given label yet and are ignored otherwise.
  33. [ honor_labels: <boolean> | default = false ]
  35. # honor_timestamps controls whether Prometheus respects the timestamps present
  36. # in scraped data.
  37. #
  38. # If honor_timestamps is set to "true", the timestamps of the metrics exposed
  39. # by the target will be used.
  40. #
  41. # If honor_timestamps is set to "false", the timestamps of the metrics exposed
  42. # by the target will be ignored.
  43. [ honor_timestamps: <boolean> | default = true ]
  45. # Configures the protocol scheme used for requests.
  46. [ scheme: <scheme> | default = http ]
  48. # Optional HTTP URL parameters.
  49. params:
  50.   [ <string>: [<string>, ...] ]
  52. # Sets the `Authorization` header on every scrape request with the
  53. # configured username and password.
  54. # password and password_file are mutually exclusive.
  55. basic_auth:
  56.   [ username: <string> ]
  57.   [ password: <secret> ]
  58.   [ password_file: <string> ]
  60. # Sets the `Authorization` header on every scrape request with
  61. # the configured credentials.
  62. authorization:
  63.   # Sets the authentication type of the request.
  64.   [ type: <string> | default: Bearer ]
  65.   # Sets the credentials of the request. It is mutually exclusive with
  66.   # `credentials_file`.
  67.   [ credentials: <secret> ]
  68.   # Sets the credentials of the request with the credentials read from the
  69.   # configured file. It is mutually exclusive with `credentials`.
  70.   [ credentials_file: <filename> ]
  72. # Optional OAuth 2.0 configuration.
  73. # Cannot be used at the same time as basic_auth or authorization.
  74. oauth2:
  75.   [ <oauth2> ]
  77. # Configure whether scrape requests follow HTTP 3xx redirects.
  78. [ follow_redirects: <boolean> | default = true ]
  80. # Whether to enable HTTP2.
  81. [ enable_http2: <bool> | default: true ]
  83. # Configures the scrape request's TLS settings.
  84. tls_config:
  85.   [ <tls_config> ]
  87. # Optional proxy URL.
  88. [ proxy_url: <string> ]
  89. # Specifies headers to send to proxies during CONNECT requests.
  90. [ proxy_connect_headers:
  91.   [ <string>: [<secret>, ...] ] ]
  94. # List of Azure service discovery configurations.
  95. azure_sd_configs:
  96.   [ - <azure_sd_config> ... ]
  98. # List of Consul service discovery configurations.
  99. consul_sd_configs:
  100.   [ - <consul_sd_config> ... ]
  102. # List of DigitalOcean service discovery configurations.
  103. digitalocean_sd_configs:
  104.   [ - <digitalocean_sd_config> ... ]
  106. # List of Docker service discovery configurations.
  107. docker_sd_configs:
  108.   [ - <docker_sd_config> ... ]
  110. # List of Docker Swarm service discovery configurations.
  111. dockerswarm_sd_configs:
  112.   [ - <dockerswarm_sd_config> ... ]
  114. # List of DNS service discovery configurations.
  115. dns_sd_configs:
  116.   [ - <dns_sd_config> ... ]
  118. # List of EC2 service discovery configurations.
  119. ec2_sd_configs:
  120.   [ - <ec2_sd_config> ... ]
  122. # List of Eureka service discovery configurations.
  123. eureka_sd_configs:
  124.   [ - <eureka_sd_config> ... ]
  126. # List of file service discovery configurations.
  127. file_sd_configs:
  128.   [ - <file_sd_config> ... ]
  130. # List of GCE service discovery configurations.
  131. gce_sd_configs:
  132.   [ - <gce_sd_config> ... ]
  134. # List of Hetzner service discovery configurations.
  135. hetzner_sd_configs:
  136.   [ - <hetzner_sd_config> ... ]
  138. # List of HTTP service discovery configurations.
  139. http_sd_configs:
  140.   [ - <http_sd_config> ... ]
  143. # List of IONOS service discovery configurations.
  144. ionos_sd_configs:
  145.   [ - <ionos_sd_config> ... ]
  147. # List of Kubernetes service discovery configurations.
  148. kubernetes_sd_configs:
  149.   [ - <kubernetes_sd_config> ... ]
  151. # List of Kuma service discovery configurations.
  152. kuma_sd_configs:
  153.   [ - <kuma_sd_config> ... ]
  155. # List of Lightsail service discovery configurations.
  156. lightsail_sd_configs:
  157.   [ - <lightsail_sd_config> ... ]
  159. # List of Linode service discovery configurations.
  160. linode_sd_configs:
  161.   [ - <linode_sd_config> ... ]
  163. # List of Marathon service discovery configurations.
  164. marathon_sd_configs:
  165.   [ - <marathon_sd_config> ... ]
  167. # List of AirBnB's Nerve service discovery configurations.
  168. nerve_sd_configs:
  169.   [ - <nerve_sd_config> ... ]
  171. # List of Nomad service discovery configurations.
  172. nomad_sd_configs:
  173.   [ - <nomad_sd_config> ... ]
  175. # List of OpenStack service discovery configurations.
  176. openstack_sd_configs:
  177.   [ - <openstack_sd_config> ... ]
  179. # List of OVHcloud service discovery configurations.
  180. ovhcloud_sd_configs:
  181.   [ - <ovhcloud_sd_config> ... ]
  183. # List of PuppetDB service discovery configurations.
  184. puppetdb_sd_configs:
  185.   [ - <puppetdb_sd_config> ... ]
  187. # List of Scaleway service discovery configurations.
  188. scaleway_sd_configs:
  189.   [ - <scaleway_sd_config> ... ]
  191. # List of Zookeeper Serverset service discovery configurations.
  192. serverset_sd_configs:
  193.   [ - <serverset_sd_config> ... ]
  195. # List of Triton service discovery configurations.
  196. triton_sd_configs:
  197.   [ - <triton_sd_config> ... ]
  199. # List of Uyuni service discovery configurations.
  200. uyuni_sd_configs:
  201.   [ - <uyuni_sd_config> ... ]
  203. # List of labeled statically configured targets for this job.
  204. static_configs:
  205.   [ - <static_config> ... ]
  207. # List of target relabel configurations.
  208. relabel_configs:
  209.   [ - <relabel_config> ... ]
  211. # List of metric relabel configurations.
  212. metric_relabel_configs:
  213.   [ - <relabel_config> ... ]
  215. # An uncompressed response body larger than this many bytes will cause the
  216. # scrape to fail. 0 means no limit. Example: 100MB.
  217. # This is an experimental feature, this behaviour could
  218. # change or be removed in the future.
  219. [ body_size_limit: <size> | default = 0 ]
  220. # Per-scrape limit on number of scraped samples that will be accepted.
  221. # If more than this number of samples are present after metric relabeling
  222. # the entire scrape will be treated as failed. 0 means no limit.
  223. [ sample_limit: <int> | default = 0 ]
  225. # Per-scrape limit on number of labels that will be accepted for a sample. If
  226. # more than this number of labels are present post metric-relabeling, the
  227. # entire scrape will be treated as failed. 0 means no limit.
  228. [ label_limit: <int> | default = 0 ]
  230. # Per-scrape limit on length of labels name that will be accepted for a sample.
  231. # If a label name is longer than this number post metric-relabeling, the entire
  232. # scrape will be treated as failed. 0 means no limit.
  233. [ label_name_length_limit: <int> | default = 0 ]
  235. # Per-scrape limit on length of labels value that will be accepted for a sample.
  236. # If a label value is longer than this number post metric-relabeling, the
  237. # entire scrape will be treated as failed. 0 means no limit.
  238. [ label_value_length_limit: <int> | default = 0 ]
  240. # Per-scrape config limit on number of unique targets that will be
  241. # accepted. If more than this number of targets are present after target
  242. # relabeling, Prometheus will mark the targets as failed without scraping them.
  243. # 0 means no limit. This is an experimental feature, this behaviour could
  244. # change in the future.
  245. [ target_limit: <int> | default = 0 ]

Where <job_name> must be unique across all scrape configurations.

<tls_config>

A tls_config allows configuring TLS connections.

  1. # CA certificate to validate API server certificate with.
  2. [ ca_file: <filename> ]
  4. # Certificate and key files for client cert authentication to the server.
  5. [ cert_file: <filename> ]
  6. [ key_file: <filename> ]
  8. # ServerName extension to indicate the name of the server.
  9. # https://tools.ietf.org/html/rfc4366#section-3.1
  10. [ server_name: <string> ]
  12. # Disable validation of the server certificate.
  13. [ insecure_skip_verify: <boolean> ]
  15. # Minimum acceptable TLS version. Accepted values: TLS10 (TLS 1.0), TLS11 (TLS
  16. # 1.1), TLS12 (TLS 1.2), TLS13 (TLS 1.3).
  17. # If unset, Prometheus will use Go default minimum version, which is TLS 1.2.
  18. # See MinVersion in https://pkg.go.dev/crypto/tls#Config.
  19. [ min_version: <string> ]
  20. # Maximum acceptable TLS version. Accepted values: TLS10 (TLS 1.0), TLS11 (TLS
  21. # 1.1), TLS12 (TLS 1.2), TLS13 (TLS 1.3).
  22. # If unset, Prometheus will use Go default maximum version, which is TLS 1.3.
  23. # See MaxVersion in https://pkg.go.dev/crypto/tls#Config.
  24. [ max_version: <string> ]

<oauth2>

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.

  1. client_id: <string>
  2. [ client_secret: <secret> ]
  4. # Read the client secret from a file.
  5. # It is mutually exclusive with `client_secret`.
  6. [ client_secret_file: <filename> ]
  8. # Scopes for the token request.
  9. scopes:
  10.   [ - <string> ... ]
  12. # The URL to fetch the token from.
  13. token_url: <string>
  15. # Optional parameters to append to the token URL.
  16. endpoint_params:
  17.   [ <string>: <string> ... ]
  19. # Configures the token request's TLS settings.
  20. tls_config:
  21.   [ <tls_config> ]
  23. # Optional proxy URL.
  24. [ proxy_url: <string> ]
  25. # Specifies headers to send to proxies during CONNECT requests.
  26. [ proxy_connect_headers:
  27.   [ <string>: [<secret>, ...] ] ]

<azure_sd_config>

Azure SD configurations allow retrieving scrape targets from Azure VMs.

The following meta labels are available on targets during relabeling:

  • __meta_azure_machine_id: the machine ID
  • __meta_azure_machine_location: the location the machine runs in
  • __meta_azure_machine_name: the machine name
  • __meta_azure_machine_computer_name: the machine computer name
  • __meta_azure_machine_os_type: the machine operating system
  • __meta_azure_machine_private_ip: the machine’s private IP
  • __meta_azure_machine_public_ip: the machine’s public IP if it exists
  • __meta_azure_machine_resource_group: the machine’s resource group
  • __meta_azure_machine_tag_<tagname>: each tag value of the machine
  • __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)
  • __meta_azure_subscription_id: the subscription ID
  • __meta_azure_tenant_id: the tenant ID

See below for the configuration options for Azure discovery:

  1. # The information to access the Azure API.
  2. # The Azure environment.
  3. [ environment: <string> | default = AzurePublicCloud ]
  5. # The authentication method, either OAuth or ManagedIdentity.
  6. # See https://docs.microsoft.com/en-us/azure/active-directory/managed-identities-azure-resources/overview
  7. [ authentication_method: <string> | default = OAuth]
  8. # The subscription ID. Always required.
  9. subscription_id: <string>
  10. # Optional tenant ID. Only required with authentication_method OAuth.
  11. [ tenant_id: <string> ]
  12. # Optional client ID. Only required with authentication_method OAuth.
  13. [ client_id: <string> ]
  14. # Optional client secret. Only required with authentication_method OAuth.
  15. [ client_secret: <secret> ]
  17. # Optional resource group name. Limits discovery to this resource group.
  18. [ resource_group: <string> ]
  20. # Refresh interval to re-read the instance list.
  21. [ refresh_interval: <duration> | default = 300s ]
  23. # The port to scrape metrics from. If using the public IP address, this must
  24. # instead be specified in the relabeling rule.
  25. [ port: <int> | default = 80 ]
  27. # Authentication information used to authenticate to the Azure API.
  28. # Note that `basic_auth`, `authorization` and `oauth2` options are
  29. # mutually exclusive.
  30. # `password` and `password_file` are mutually exclusive.
  32. # Optional HTTP basic authentication information, currently not support by Azure.
  33. basic_auth:
  34.   [ username: <string> ]
  35.   [ password: <secret> ]
  36.   [ password_file: <string> ]
  38. # Optional `Authorization` header configuration, currently not supported by Azure.
  39. authorization:
  40.   # Sets the authentication type.
  41.   [ type: <string> | default: Bearer ]
  42.   # Sets the credentials. It is mutually exclusive with
  43.   # `credentials_file`.
  44.   [ credentials: <secret> ]
  45.   # Sets the credentials to the credentials read from the configured file.
  46.   # It is mutually exclusive with `credentials`.
  47.   [ credentials_file: <filename> ]
  49. # Optional OAuth 2.0 configuration, currently not supported by Azure.
  50. oauth2:
  51.   [ <oauth2> ]
  53. # Optional proxy URL.
  54. [ proxy_url: <string> ]
  55. # Specifies headers to send to proxies during CONNECT requests.
  56. [ proxy_connect_headers:
  57.   [ <string>: [<secret>, ...] ] ]
  59. # Configure whether HTTP requests follow HTTP 3xx redirects.
  60. [ follow_redirects: <boolean> | default = true ]
  62. # Whether to enable HTTP2.
  63. [ enable_http2: <bool> | default: true ]
  65. # TLS configuration.
  66. tls_config:
  67.   [ <tls_config> ]

<consul_sd_config>

Consul SD configurations allow retrieving scrape targets from Consul’s Catalog API.

The following meta labels are available on targets during relabeling:

  • __meta_consul_address: the address of the target
  • __meta_consul_dc: the datacenter name for the target
  • __meta_consul_health: the health status of the service
  • __meta_consul_partition: the admin partition name where the service is registered
  • __meta_consul_metadata_<key>: each node metadata key value of the target
  • __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
  • __meta_consul_service_metadata_<key>: each service metadata key value of the target
  • __meta_consul_service_port: the service port of the target
  • __meta_consul_service: the name of the service the target belongs to
  • __meta_consul_tagged_address_<key>: each node tagged address key value of the target
  • __meta_consul_tags: the list of tags of the target joined by the tag separator
  1. # The information to access the Consul API. It is to be defined
  2. # as the Consul documentation requires.
  3. [ server: <host> | default = "localhost:8500" ]
  4. [ token: <secret> ]
  5. [ datacenter: <string> ]
  6. # Namespaces are only supported in Consul Enterprise.
  7. [ namespace: <string> ]
  8. # Admin Partitions are only supported in Consul Enterprise.
  9. [ partition: <string> ]
  10. [ scheme: <string> | default = "http" ]
  11. # The username and password fields are deprecated in favor of the basic_auth configuration.
  12. [ username: <string> ]
  13. [ password: <secret> ]
  15. # A list of services for which targets are retrieved. If omitted, all services
  16. # are scraped.
  17. services:
  18.   [ - <string> ]
  20. # See https://www.consul.io/api/catalog.html#list-nodes-for-service to know more
  21. # about the possible filters that can be used.
  23. # An optional list of tags used to filter nodes for a given service. Services must contain all tags in the list.
  24. tags:
  25.   [ - <string> ]
  27. # Node metadata key/value pairs to filter nodes for a given service.
  28. [ node_meta:
  29.   [ <string>: <string> ... ] ]
  31. # The string by which Consul tags are joined into the tag label.
  32. [ tag_separator: <string> | default = , ]
  34. # Allow stale Consul results (see https://www.consul.io/api/features/consistency.html). Will reduce load on Consul.
  35. [ allow_stale: <boolean> | default = true ]
  37. # The time after which the provided names are refreshed.
  38. # On large setup it might be a good idea to increase this value because the catalog will change all the time.
  39. [ refresh_interval: <duration> | default = 30s ]
  41. # Authentication information used to authenticate to the consul server.
  42. # Note that `basic_auth`, `authorization` and `oauth2` options are
  43. # mutually exclusive.
  44. # `password` and `password_file` are mutually exclusive.
  46. # Optional HTTP basic authentication information.
  47. basic_auth:
  48.   [ username: <string> ]
  49.   [ password: <secret> ]
  50.   [ password_file: <string> ]
  52. # Optional `Authorization` header configuration.
  53. authorization:
  54.   # Sets the authentication type.
  55.   [ type: <string> | default: Bearer ]
  56.   # Sets the credentials. It is mutually exclusive with
  57.   # `credentials_file`.
  58.   [ credentials: <secret> ]
  59.   # Sets the credentials to the credentials read from the configured file.
  60.   # It is mutually exclusive with `credentials`.
  61.   [ credentials_file: <filename> ]
  63. # Optional OAuth 2.0 configuration.
  64. oauth2:
  65.   [ <oauth2> ]
  67. # Optional proxy URL.
  68. [ proxy_url: <string> ]
  69. # Specifies headers to send to proxies during CONNECT requests.
  70. [ proxy_connect_headers:
  71.   [ <string>: [<secret>, ...] ] ]
  73. # Configure whether HTTP requests follow HTTP 3xx redirects.
  74. [ follow_redirects: <boolean> | default = true ]
  76. # Whether to enable HTTP2.
  77. [ enable_http2: <bool> | default: true ]
  79. # TLS configuration.
  80. tls_config:
  81.   [ <tls_config> ]

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 feature to replace the special __address__ label.

The relabeling phase 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).

<digitalocean_sd_config>

DigitalOcean SD configurations allow retrieving scrape targets from DigitalOcean’s Droplets API. This service discovery uses the public IPv4 address by default, by that can be changed with relabeling, as demonstrated in the Prometheus digitalocean-sd configuration file.

The following meta labels are available on targets during relabeling:

  • __meta_digitalocean_droplet_id: the id of the droplet
  • __meta_digitalocean_droplet_name: the name of the droplet
  • __meta_digitalocean_image: the slug of the droplet’s image
  • __meta_digitalocean_image_name: the display name of the droplet’s image
  • __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
  • __meta_digitalocean_vpc: the id of the droplet’s VPC
  1. # Authentication information used to authenticate to the API server.
  2. # Note that `basic_auth` and `authorization` options are
  3. # mutually exclusive.
  4. # password and password_file are mutually exclusive.
  6. # Optional HTTP basic authentication information, not currently supported by DigitalOcean.
  7. basic_auth:
  8.   [ username: <string> ]
  9.   [ password: <secret> ]
  10.   [ password_file: <string> ]
  12. # Optional `Authorization` header configuration.
  13. authorization:
  14.   # Sets the authentication type.
  15.   [ type: <string> | default: Bearer ]
  16.   # Sets the credentials. It is mutually exclusive with
  17.   # `credentials_file`.
  18.   [ credentials: <secret> ]
  19.   # Sets the credentials to the credentials read from the configured file.
  20.   # It is mutually exclusive with `credentials`.
  21.   [ credentials_file: <filename> ]
  23. # Optional OAuth 2.0 configuration.
  24. # Cannot be used at the same time as basic_auth or authorization.
  25. oauth2:
  26.   [ <oauth2> ]
  28. # Optional proxy URL.
  29. [ proxy_url: <string> ]
  30. # Specifies headers to send to proxies during CONNECT requests.
  31. [ proxy_connect_headers:
  32.   [ <string>: [<secret>, ...] ] ]
  34. # Configure whether HTTP requests follow HTTP 3xx redirects.
  35. [ follow_redirects: <boolean> | default = true ]
  37. # Whether to enable HTTP2.
  38. [ enable_http2: <bool> | default: true ]
  40. # TLS configuration.
  41. tls_config:
  42.   [ <tls_config> ]
  44. # The port to scrape metrics from.
  45. [ port: <int> | default = 80 ]
  47. # The time after which the droplets are refreshed.
  48. [ refresh_interval: <duration> | default = 60s ]

<docker_sd_config>

Docker SD configurations allow retrieving scrape targets from Docker 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:

  1. # Address of the Docker daemon.
  2. host: <string>
  4. # Optional proxy URL.
  5. [ proxy_url: <string> ]
  6. # Specifies headers to send to proxies during CONNECT requests.
  7. [ proxy_connect_headers:
  8.   [ <string>: [<secret>, ...] ] ]
  10. # TLS configuration.
  11. tls_config:
  12.   [ <tls_config> ]
  14. # The port to scrape metrics from, when `role` is nodes, and for discovered
  15. # tasks and services that don't have published ports.
  16. [ port: <int> | default = 80 ]
  18. # The host to use if the container is in host networking mode.
  19. [ host_networking_host: <string> | default = "localhost" ]
  21. # Optional filters to limit the discovery process to a subset of available
  22. # resources.
  23. # The available filters are listed in the upstream documentation:
  24. # https://docs.docker.com/engine/api/v1.40/#operation/ContainerList
  25. [ filters:
  26.   [ - name: <string>
  27.       values: <string>, [...] ]
  29. # The time after which the containers are refreshed.
  30. [ refresh_interval: <duration> | default = 60s ]
  32. # Authentication information used to authenticate to the Docker daemon.
  33. # Note that `basic_auth` and `authorization` options are
  34. # mutually exclusive.
  35. # password and password_file are mutually exclusive.
  37. # Optional HTTP basic authentication information.
  38. basic_auth:
  39.   [ username: <string> ]
  40.   [ password: <secret> ]
  41.   [ password_file: <string> ]
  43. # Optional `Authorization` header configuration.
  44. authorization:
  45.   # Sets the authentication type.
  46.   [ type: <string> | default: Bearer ]
  47.   # Sets the credentials. It is mutually exclusive with
  48.   # `credentials_file`.
  49.   [ credentials: <secret> ]
  50.   # Sets the credentials to the credentials read from the configured file.
  51.   # It is mutually exclusive with `credentials`.
  52.   [ credentials_file: <filename> ]
  54. # Optional OAuth 2.0 configuration.
  55. # Cannot be used at the same time as basic_auth or authorization.
  56. oauth2:
  57.   [ <oauth2> ]
  59. # Configure whether HTTP requests follow HTTP 3xx redirects.
  60. [ follow_redirects: <boolean> | default = true ]
  62. # Whether to enable HTTP2.
  63. [ enable_http2: <bool> | default: true ]

The relabeling phase 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 for a detailed example of configuring Prometheus for Docker Engine.

<dockerswarm_sd_config>

Docker Swarm SD configurations allow retrieving scrape targets from Docker Swarm engine.

One of the following roles can be configured to discover targets:

services

The services role discovers all Swarm services 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.

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

The tasks role discovers all Swarm 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.

Available meta labels:

  • __meta_dockerswarm_container_label_<labelname>: each label of the container
  • __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_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.

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:

  1. # Address of the Docker daemon.
  2. host: <string>
  4. # Optional proxy URL.
  5. [ proxy_url: <string> ]
  6. # Specifies headers to send to proxies during CONNECT requests.
  7. [ proxy_connect_headers:
  8.   [ <string>: [<secret>, ...] ] ]
  10. # TLS configuration.
  11. tls_config:
  12.   [ <tls_config> ]
  14. # Role of the targets to retrieve. Must be `services`, `tasks`, or `nodes`.
  15. role: <string>
  17. # The port to scrape metrics from, when `role` is nodes, and for discovered
  18. # tasks and services that don't have published ports.
  19. [ port: <int> | default = 80 ]
  21. # Optional filters to limit the discovery process to a subset of available
  22. # resources.
  23. # The available filters are listed in the upstream documentation:
  24. # Services: https://docs.docker.com/engine/api/v1.40/#operation/ServiceList
  25. # Tasks: https://docs.docker.com/engine/api/v1.40/#operation/TaskList
  26. # Nodes: https://docs.docker.com/engine/api/v1.40/#operation/NodeList
  27. [ filters:
  28.   [ - name: <string>
  29.       values: <string>, [...] ]
  31. # The time after which the service discovery data is refreshed.
  32. [ refresh_interval: <duration> | default = 60s ]
  34. # Authentication information used to authenticate to the Docker daemon.
  35. # Note that `basic_auth` and `authorization` options are
  36. # mutually exclusive.
  37. # password and password_file are mutually exclusive.
  39. # Optional HTTP basic authentication information.
  40. basic_auth:
  41.   [ username: <string> ]
  42.   [ password: <secret> ]
  43.   [ password_file: <string> ]
  45. # Optional `Authorization` header configuration.
  46. authorization:
  47.   # Sets the authentication type.
  48.   [ type: <string> | default: Bearer ]
  49.   # Sets the credentials. It is mutually exclusive with
  50.   # `credentials_file`.
  51.   [ credentials: <secret> ]
  52.   # Sets the credentials to the credentials read from the configured file.
  53.   # It is mutually exclusive with `credentials`.
  54.   [ credentials_file: <filename> ]
  56. # Optional OAuth 2.0 configuration.
  57. # Cannot be used at the same time as basic_auth or authorization.
  58. oauth2:
  59.   [ <oauth2> ]
  61. # Configure whether HTTP requests follow HTTP 3xx redirects.
  62. [ follow_redirects: <boolean> | default = true ]
  64. # Whether to enable HTTP2.
  65. [ enable_http2: <bool> | default: true ]

The relabeling phase 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).

See this example Prometheus configuration file for a detailed example of configuring Prometheus for Docker Swarm.

<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, MX and SRV record queries, but not the advanced DNS-SD approach specified in RFC6763.

The following meta labels are available on targets during relabeling:

  • __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
  • __meta_dns_mx_record_target: the target field of the MX record
  1. # A list of DNS domain names to be queried.
  2. names:
  3.   [ - <string> ]
  5. # The type of DNS query to perform. One of SRV, A, AAAA or MX.
  6. [ type: <string> | default = 'SRV' ]
  8. # The port number used if the query type is not SRV.
  9. [ port: <int>]
  11. # The time after which the provided names are refreshed.
  12. [ 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 IAM credentials used must have the ec2:DescribeInstances permission to discover scrape targets, and may optionally have the ec2:DescribeAvailabilityZones permission if you want the availability zone ID available as a label (see below).

The following meta labels are available on targets during relabeling:

  • __meta_ec2_ami: the EC2 Amazon Machine Image
  • __meta_ec2_architecture: the architecture of the instance
  • __meta_ec2_availability_zone: the availability zone in which the instance is running
  • __meta_ec2_availability_zone_id: the availability zone ID in which the instance is running (requires ec2:DescribeAvailabilityZones)
  • __meta_ec2_instance_id: the EC2 instance ID
  • __meta_ec2_instance_lifecycle: the lifecycle of the EC2 instance, set only for ‘spot’ or ‘scheduled’ instances, absent otherwise
  • __meta_ec2_instance_state: the state of the EC2 instance
  • __meta_ec2_instance_type: the type of the EC2 instance
  • __meta_ec2_ipv6_addresses: comma separated list of IPv6 addresses assigned to the instance’s network interfaces, if present
  • __meta_ec2_owner_id: the ID of the AWS account that owns the EC2 instance
  • __meta_ec2_platform: the Operating System platform, set to ‘windows’ on Windows servers, absent otherwise
  • __meta_ec2_primary_subnet_id: the subnet ID of the primary network interface, if available
  • __meta_ec2_private_dns_name: the private DNS name of the instance, if available
  • __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_region: the region of the instance
  • __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:

  1. # The information to access the EC2 API.
  3. # The AWS region. If blank, the region from the instance metadata is used.
  4. [ region: <string> ]
  6. # Custom endpoint to be used.
  7. [ endpoint: <string> ]
  9. # The AWS API keys. If blank, the environment variables `AWS_ACCESS_KEY_ID`
  10. # and `AWS_SECRET_ACCESS_KEY` are used.
  11. [ access_key: <string> ]
  12. [ secret_key: <secret> ]
  13. # Named AWS profile used to connect to the API.
  14. [ profile: <string> ]
  16. # AWS Role ARN, an alternative to using AWS API keys.
  17. [ role_arn: <string> ]
  19. # Refresh interval to re-read the instance list.
  20. [ refresh_interval: <duration> | default = 60s ]
  22. # The port to scrape metrics from. If using the public IP address, this must
  23. # instead be specified in the relabeling rule.
  24. [ port: <int> | default = 80 ]
  26. # Filters can be used optionally to filter the instance list by other criteria.
  27. # Available filter criteria can be found here:
  28. # https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances.html
  29. # Filter API documentation: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_Filter.html
  30. filters:
  31.   [ - name: <string>
  32.       values: <string>, [...] ]
  34. # Authentication information used to authenticate to the EC2 API.
  35. # Note that `basic_auth`, `authorization` and `oauth2` options are
  36. # mutually exclusive.
  37. # `password` and `password_file` are mutually exclusive.
  39. # Optional HTTP basic authentication information, currently not supported by AWS.
  40. basic_auth:
  41.   [ username: <string> ]
  42.   [ password: <secret> ]
  43.   [ password_file: <string> ]
  45. # Optional `Authorization` header configuration, currently not supported by AWS.
  46. authorization:
  47.   # Sets the authentication type.
  48.   [ type: <string> | default: Bearer ]
  49.   # Sets the credentials. It is mutually exclusive with
  50.   # `credentials_file`.
  51.   [ credentials: <secret> ]
  52.   # Sets the credentials to the credentials read from the configured file.
  53.   # It is mutuall exclusive with `credentials`.
  54.   [ credentials_file: <filename> ]
  56. # Optional OAuth 2.0 configuration, currently not supported by AWS.
  57. oauth2:
  58.   [ <oauth2> ]
  60. # Optional proxy URL.
  61. [ proxy_url: <string> ]
  62. # Specifies headers to send to proxies during CONNECT requests.
  63. [ proxy_connect_headers:
  64.   [ <string>: [<secret>, ...] ] ]
  66. # Configure whether HTTP requests follow HTTP 3xx redirects.
  67. [ follow_redirects: <boolean> | default = true ]
  69. # Whether to enable HTTP2.
  70. [ enable_http2: <bool> | default: true ]
  72. # TLS configuration.
  73. tls_config:
  74.   [ <tls_config> ]

The relabeling phase 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.

<openstack_sd_config>

OpenStack SD configurations allow retrieving scrape targets from OpenStack Nova instances.

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.

The following meta labels are available on targets during relabeling:

  • __meta_openstack_hypervisor_host_ip: the hypervisor node’s IP address.
  • __meta_openstack_hypervisor_hostname: the hypervisor node’s name.
  • __meta_openstack_hypervisor_id: the hypervisor node’s ID.
  • __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.

instance

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.

The following meta labels are available on targets during relabeling:

  • __meta_openstack_address_pool: the pool of the private IP.
  • __meta_openstack_instance_flavor: the flavor of the OpenStack instance.
  • __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.
  • __meta_openstack_project_id: the project (tenant) owning this instance.
  • __meta_openstack_public_ip: the public IP of the OpenStack instance.
  • __meta_openstack_tag_<tagkey>: each tag value of the instance.
  • __meta_openstack_user_id: the user account owning the tenant.

See below for the configuration options for OpenStack discovery:

  1. # The information to access the OpenStack API.
  3. # The OpenStack role of entities that should be discovered.
  4. role: <openstack_role>
  6. # The OpenStack Region.
  7. region: <string>
  9. # identity_endpoint specifies the HTTP endpoint that is required to work with
  10. # the Identity API of the appropriate version. While it's ultimately needed by
  11. # all of the identity services, it will often be populated by a provider-level
  12. # function.
  13. [ identity_endpoint: <string> ]
  15. # username is required if using Identity V2 API. Consult with your provider's
  16. # control panel to discover your account's username. In Identity V3, either
  17. # userid or a combination of username and domain_id or domain_name are needed.
  18. [ username: <string> ]
  19. [ userid: <string> ]
  21. # password for the Identity V2 and V3 APIs. Consult with your provider's
  22. # control panel to discover your account's preferred method of authentication.
  23. [ password: <secret> ]
  25. # At most one of domain_id and domain_name must be provided if using username
  26. # with Identity V3. Otherwise, either are optional.
  27. [ domain_name: <string> ]
  28. [ domain_id: <string> ]
  30. # The project_id and project_name fields are optional for the Identity V2 API.
  31. # Some providers allow you to specify a project_name instead of the project_id.
  32. # Some require both. Your provider's authentication policies will determine
  33. # how these fields influence authentication.
  34. [ project_name: <string> ]
  35. [ project_id: <string> ]
  37. # The application_credential_id or application_credential_name fields are
  38. # required if using an application credential to authenticate. Some providers
  39. # allow you to create an application credential to authenticate rather than a
  40. # password.
  41. [ application_credential_name: <string> ]
  42. [ application_credential_id: <string> ]
  44. # The application_credential_secret field is required if using an application
  45. # credential to authenticate.
  46. [ application_credential_secret: <secret> ]
  48. # Whether the service discovery should list all instances for all projects.
  49. # It is only relevant for the 'instance' role and usually requires admin permissions.
  50. [ all_tenants: <boolean> | default: false ]
  52. # Refresh interval to re-read the instance list.
  53. [ refresh_interval: <duration> | default = 60s ]
  55. # The port to scrape metrics from. If using the public IP address, this must
  56. # instead be specified in the relabeling rule.
  57. [ port: <int> | default = 80 ]
  59. # The availability of the endpoint to connect to. Must be one of public, admin or internal.
  60. [ availability: <string> | default = "public" ]
  62. # TLS configuration.
  63. tls_config:
  64.   [ <tls_config> ]

<ovhcloud_sd_config>

OVHcloud SD configurations allow retrieving scrape targets from OVHcloud’s dedicated servers and VPS using their API. Prometheus will periodically check the REST endpoint and create a target for every discovered server. The role will try to use the public IPv4 address as default address, if there’s none it will try to use the IPv6 one. This may be changed with relabeling. For OVHcloud’s public cloud instances you can use the openstacksdconfig.

VPS

  • __meta_ovhcloud_vps_cluster: the cluster of the server
  • __meta_ovhcloud_vps_datacenter: the datacenter of the server
  • __meta_ovhcloud_vps_disk: the disk of the server
  • __meta_ovhcloud_vps_display_name: the display name of the server
  • __meta_ovhcloud_vps_ipv4: the IPv4 of the server
  • __meta_ovhcloud_vps_ipv6: the IPv6 of the server
  • __meta_ovhcloud_vps_keymap: the KVM keyboard layout of the server
  • __meta_ovhcloud_vps_maximum_additional_ip: the maximum additional IPs of the server
  • __meta_ovhcloud_vps_memory_limit: the memory limit of the server
  • __meta_ovhcloud_vps_memory: the memory of the server
  • __meta_ovhcloud_vps_monitoring_ip_blocks: the monitoring IP blocks of the server
  • __meta_ovhcloud_vps_name: the name of the server
  • __meta_ovhcloud_vps_netboot_mode: the netboot mode of the server
  • __meta_ovhcloud_vps_offer_type: the offer type of the server
  • __meta_ovhcloud_vps_offer: the offer of the server
  • __meta_ovhcloud_vps_state: the state of the server
  • __meta_ovhcloud_vps_vcore: the number of virtual cores of the server
  • __meta_ovhcloud_vps_version: the version of the server
  • __meta_ovhcloud_vps_zone: the zone of the server

Dedicated servers

  • __meta_ovhcloud_dedicated_server_commercial_range: the commercial range of the server
  • __meta_ovhcloud_dedicated_server_datacenter: the datacenter of the server
  • __meta_ovhcloud_dedicated_server_ipv4: the IPv4 of the server
  • __meta_ovhcloud_dedicated_server_ipv6: the IPv6 of the server
  • __meta_ovhcloud_dedicated_server_link_speed: the link speed of the server
  • __meta_ovhcloud_dedicated_server_name: the name of the server
  • __meta_ovhcloud_dedicated_server_os: the operating system of the server
  • __meta_ovhcloud_dedicated_server_rack: the rack of the server
  • __meta_ovhcloud_dedicated_server_reverse: the reverse DNS name of the server
  • __meta_ovhcloud_dedicated_server_server_id: the ID of the server
  • __meta_ovhcloud_dedicated_server_state: the state of the server
  • __meta_ovhcloud_dedicated_server_support_level: the support level of the server

See below for the configuration options for OVHcloud discovery:

  1. # Access key to use. https://api.ovh.com
  2. application_key: <string>
  3. application_secret: <secret>
  4. consumer_key: <secret>
  5. # Service of the targets to retrieve. Must be `vps` or `dedicated_server`.
  6. service: <string>
  7. # API endpoint. https://github.com/ovh/go-ovh#supported-apis
  8. [ endpoint: <string> | default = "ovh-eu" ]
  9. # Refresh interval to re-read the resources list.
  10. [ refresh_interval: <duration> | default = 60s ]

<puppetdb_sd_config>

PuppetDB SD configurations allow retrieving scrape targets from PuppetDB 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.

The following meta labels are available on targets during relabeling:

  • __meta_puppetdb_query: the Puppet Query Language (PQL) query
  • __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:

  1. # The URL of the PuppetDB root query endpoint.
  2. url: <string>
  4. # Puppet Query Language (PQL) query. Only resources are supported.
  5. # https://puppet.com/docs/puppetdb/latest/api/query/v4/pql.html
  6. query: <string>
  8. # Whether to include the parameters as meta labels.
  9. # Due to the differences between parameter types and Prometheus labels,
  10. # some parameters might not be rendered. The format of the parameters might
  11. # also change in future releases.
  12. #
  13. # Note: Enabling this exposes parameters in the Prometheus UI and API. Make sure
  14. # that you don't have secrets exposed as parameters if you enable this.
  15. [ include_parameters: <boolean> | default = false ]
  17. # Refresh interval to re-read the resources list.
  18. [ refresh_interval: <duration> | default = 60s ]
  20. # The port to scrape metrics from.
  21. [ port: <int> | default = 80 ]
  23. # TLS configuration to connect to the PuppetDB.
  24. tls_config:
  25.   [ <tls_config> ]
  27. # basic_auth, authorization, and oauth2, are mutually exclusive.
  29. # Optional HTTP basic authentication information.
  30. basic_auth:
  31.   [ username: <string> ]
  32.   [ password: <secret> ]
  33.   [ password_file: <string> ]
  35. # `Authorization` HTTP header configuration.
  36. authorization:
  37.   # Sets the authentication type.
  38.   [ type: <string> | default: Bearer ]
  39.   # Sets the credentials. It is mutually exclusive with
  40.   # `credentials_file`.
  41.   [ credentials: <secret> ]
  42.   # Sets the credentials with the credentials read from the configured file.
  43.   # It is mutually exclusive with `credentials`.
  44.   [ credentials_file: <filename> ]
  46. # Optional OAuth 2.0 configuration.
  47. # Cannot be used at the same time as basic_auth or authorization.
  48. oauth2:
  49.   [ <oauth2> ]
  51. # Optional proxy URL.
  52. [ proxy_url: <string> ]
  53. # Specifies headers to send to proxies during CONNECT requests.
  54. [ proxy_connect_headers:
  55.   [ <string>: [<secret>, ...] ] ]
  57. # Configure whether HTTP requests follow HTTP 3xx redirects.
  58. [ follow_redirects: <boolean> | default = true ]
  60. # Whether to enable HTTP2.
  61. [ enable_http2: <bool> | default: true ]

See this example Prometheus configuration file for a detailed example of configuring Prometheus with PuppetDB.

<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.

Files must contain a list of static configs, using these formats:

JSON

  1. [
  2.   {
  3.     "targets": [ "<host>", ... ],
  4.     "labels": {
  5.       "<labelname>": "<labelvalue>", ...
  6.     }
  7.   },
  8.   ...
  9. ]

YAML

  1. - targets:
  2.   [ - '<host>' ]
  3.   labels:
  4.     [ <labelname>: <labelvalue> ... ]

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. Its value is set to the filepath from which the target was extracted.

There is a list of integrations with this discovery mechanism.

  1. # Patterns for files from which target groups are extracted.
  2. files:
  3.   [ - <filename_pattern> ... ]
  5. # Refresh interval to re-read the files.
  6. [ 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 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:

  • __meta_gce_instance_id: the numeric id of the instance
  • __meta_gce_instance_name: the name of the instance
  • __meta_gce_label_<labelname>: each GCE label of the instance
  • __meta_gce_machine_type: full or partial URL of the machine type of the instance
  • __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
  • __meta_gce_interface_ipv4_<name>: IPv4 address of each named interface
  • __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:

  1. # The information to access the GCE API.
  3. # The GCP Project
  4. project: <string>
  6. # The zone of the scrape targets. If you need multiple zones use multiple
  7. # gce_sd_configs.
  8. zone: <string>
  10. # Filter can be used optionally to filter the instance list by other criteria
  11. # Syntax of this filter string is described here in the filter query parameter section:
  12. # https://cloud.google.com/compute/docs/reference/latest/instances/list
  13. [ filter: <string> ]
  15. # Refresh interval to re-read the instance list
  16. [ refresh_interval: <duration> | default = 60s ]
  18. # The port to scrape metrics from. If using the public IP address, this must
  19. # instead be specified in the relabeling rule.
  20. [ port: <int> | default = 80 ]
  22. # The tag separator is used to separate the tags on concatenation
  23. [ 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.

<hetzner_sd_config>

Hetzner SD configurations allow retrieving scrape targets from Hetzner Cloud API and Robot API. 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.

The following meta labels are available on all targets during relabeling:

  • __meta_hetzner_server_id: the ID of the server
  • __meta_hetzner_server_name: the name of the server
  • __meta_hetzner_server_status: the status of the server
  • __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

The labels below are only available for targets with role set to hcloud:

  • __meta_hetzner_hcloud_image_name: the image name of the server
  • __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_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
  • __meta_hetzner_hcloud_labelpresent_<labelname>: true for each label of the server

The labels below are only available for targets with role set to robot:

  • __meta_hetzner_robot_product: the product of the server
  • __meta_hetzner_robot_cancelled: the server cancellation status
  1. # The Hetzner role of entities that should be discovered.
  2. # One of robot or hcloud.
  3. role: <string>
  5. # Authentication information used to authenticate to the API server.
  6. # Note that `basic_auth` and `authorization` options are
  7. # mutually exclusive.
  8. # password and password_file are mutually exclusive.
  10. # Optional HTTP basic authentication information, required when role is robot
  11. # Role hcloud does not support basic auth.
  12. basic_auth:
  13.   [ username: <string> ]
  14.   [ password: <secret> ]
  15.   [ password_file: <string> ]
  17. # Optional `Authorization` header configuration, required when role is
  18. # hcloud. Role robot does not support bearer token authentication.
  19. authorization:
  20.   # Sets the authentication type.
  21.   [ type: <string> | default: Bearer ]
  22.   # Sets the credentials. It is mutually exclusive with
  23.   # `credentials_file`.
  24.   [ credentials: <secret> ]
  25.   # Sets the credentials to the credentials read from the configured file.
  26.   # It is mutually exclusive with `credentials`.
  27.   [ credentials_file: <filename> ]
  29. # Optional OAuth 2.0 configuration.
  30. # Cannot be used at the same time as basic_auth or authorization.
  31. oauth2:
  32.   [ <oauth2> ]
  34. # Optional proxy URL.
  35. [ proxy_url: <string> ]
  36. # Specifies headers to send to proxies during CONNECT requests.
  37. [ proxy_connect_headers:
  38.   [ <string>: [<secret>, ...] ] ]
  40. # Configure whether HTTP requests follow HTTP 3xx redirects.
  41. [ follow_redirects: <boolean> | default = true ]
  43. # Whether to enable HTTP2.
  44. [ enable_http2: <bool> | default: true ]
  46. # TLS configuration.
  47. tls_config:
  48.   [ <tls_config> ]
  50. # The port to scrape metrics from.
  51. [ port: <int> | default = 80 ]
  53. # The time after which the servers are refreshed.
  54. [ refresh_interval: <duration> | default = 60s ]

<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:

  1. [
  2.   {
  3.     "targets": [ "<host>", ... ],
  4.     "labels": {
  5.       "<labelname>": "<labelvalue>", ...
  6.     }
  7.   },
  8.   ...
  9. ]

The endpoint is queried periodically at the specified refresh interval. The prometheus_sd_http_failures_total counter metric tracks the number of refresh failures.

Each target has a meta label __meta_url during the relabeling phase. Its value is set to the URL from which the target was extracted.

  1. # URL from which the targets are fetched.
  2. url: <string>
  4. # Refresh interval to re-query the endpoint.
  5. [ refresh_interval: <duration> | default = 60s ]
  7. # Authentication information used to authenticate to the API server.
  8. # Note that `basic_auth`, `authorization` and `oauth2` options are
  9. # mutually exclusive.
  10. # `password` and `password_file` are mutually exclusive.
  12. # Optional HTTP basic authentication information.
  13. basic_auth:
  14.   [ username: <string> ]
  15.   [ password: <secret> ]
  16.   [ password_file: <string> ]
  18. # Optional `Authorization` header configuration.
  19. authorization:
  20.   # Sets the authentication type.
  21.   [ type: <string> | default: Bearer ]
  22.   # Sets the credentials. It is mutually exclusive with
  23.   # `credentials_file`.
  24.   [ credentials: <secret> ]
  25.   # Sets the credentials to the credentials read from the configured file.
  26.   # It is mutually exclusive with `credentials`.
  27.   [ credentials_file: <filename> ]
  29. # Optional OAuth 2.0 configuration.
  30. oauth2:
  31.   [ <oauth2> ]
  33. # Optional proxy URL.
  34. [ proxy_url: <string> ]
  35. # Specifies headers to send to proxies during CONNECT requests.
  36. [ proxy_connect_headers:
  37.   [ <string>: [<secret>, ...] ] ]
  39. # Configure whether HTTP requests follow HTTP 3xx redirects.
  40. [ follow_redirects: <boolean> | default = true ]
  42. # Whether to enable HTTP2.
  43. [ enable_http2: <bool> | default: true ]
  45. # TLS configuration.
  46. tls_config:
  47.   [ <tls_config> ]

<ionos_sd_config>

IONOS SD configurations allows retrieving scrape targets from IONOS Cloud API. This service discovery uses the first NICs IP address by default, but that can be changed with relabeling. The following meta labels are available on all targets during relabeling:

  • __meta_ionos_server_availability_zone: the availability zone of the server
  • __meta_ionos_server_boot_cdrom_id: the ID of the CD-ROM the server is booted from
  • __meta_ionos_server_boot_image_id: the ID of the boot image or snapshot the server is booted from
  • __meta_ionos_server_boot_volume_id: the ID of the boot volume
  • __meta_ionos_server_cpu_family: the CPU family of the server to
  • __meta_ionos_server_id: the ID of the server
  • __meta_ionos_server_ip: comma separated list of all IPs assigned to the server
  • __meta_ionos_server_lifecycle: the lifecycle state of the server resource
  • __meta_ionos_server_name: the name of the server
  • __meta_ionos_server_nic_ip_<nic_name>: comma separated list of IPs, grouped by the name of each NIC attached to the server
  • __meta_ionos_server_servers_id: the ID of the servers the server belongs to
  • __meta_ionos_server_state: the execution state of the server
  • __meta_ionos_server_type: the type of the server
  1. # The unique ID of the data center.
  2. datacenter_id: <string>
  4. # Authentication information used to authenticate to the API server.
  5. # Note that `basic_auth` and `authorization` options are
  6. # mutually exclusive.
  7. # password and password_file are mutually exclusive.
  9. # Optional HTTP basic authentication information, required when using IONOS
  10. # Cloud username and password as authentication method.
  11. basic_auth:
  12.   [ username: <string> ]
  13.   [ password: <secret> ]
  14.   [ password_file: <string> ]
  16. # Optional `Authorization` header configuration, required when using IONOS
  17. # Cloud token as authentication method.
  18. authorization:
  19.   # Sets the authentication type.
  20.   [ type: <string> | default: Bearer ]
  21.   # Sets the credentials. It is mutually exclusive with
  22.   # `credentials_file`.
  23.   [ credentials: <secret> ]
  24.   # Sets the credentials to the credentials read from the configured file.
  25.   # It is mutually exclusive with `credentials`.
  26.   [ credentials_file: <filename> ]
  28. # Optional OAuth 2.0 configuration.
  29. # Cannot be used at the same time as basic_auth or authorization.
  30. oauth2:
  31.   [ <oauth2> ]
  33. # Optional proxy URL.
  34. [ proxy_url: <string> ]
  35. # Specifies headers to send to proxies during CONNECT requests.
  36. [ proxy_connect_headers:
  37.   [ <string>: [<secret>, ...] ] ]
  39. # Configure whether HTTP requests follow HTTP 3xx redirects.
  40. [ follow_redirects: <boolean> | default = true ]
  42. # Whether to enable HTTP2.
  43. [ enable_http2: <bool> | default: true ]
  45. # TLS configuration.
  46. tls_config:
  47.   [ <tls_config> ]
  49. # The port to scrape metrics from.
  50. [ port: <int> | default = 80 ]
  52. # The time after which the servers are refreshed.
  53. [ refresh_interval: <duration> | default = 60s ]

<kubernetes_sd_config>

Kubernetes SD configurations allow retrieving scrape targets from Kubernetes’ REST API and always staying synchronized with 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_provider_id: The cloud provider’s name for the node object.
  • __meta_kubernetes_node_label_<labelname>: Each label from the node object.
  • __meta_kubernetes_node_labelpresent_<labelname>: true for each label from the node object.
  • __meta_kubernetes_node_annotation_<annotationname>: Each annotation from the node object.
  • __meta_kubernetes_node_annotationpresent_<annotationname>: true for each annotation from the node object.
  • __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.
  • __meta_kubernetes_service_annotation_<annotationname>: Each annotation from the service object.
  • __meta_kubernetes_service_annotationpresent_<annotationname>: “true” for each annotation of the service object.
  • __meta_kubernetes_service_cluster_ip: The cluster IP address of the service. (Does not apply to services of type ExternalName)
  • __meta_kubernetes_service_loadbalancer_ip: The IP address of the loadbalancer. (Applies to services of type LoadBalancer)
  • __meta_kubernetes_service_external_name: The DNS name of the service. (Applies to services of type ExternalName)
  • __meta_kubernetes_service_label_<labelname>: Each label from the service object.
  • __meta_kubernetes_service_labelpresent_<labelname>: true for each label of the service object.
  • __meta_kubernetes_service_name: The name of the service object.
  • __meta_kubernetes_service_port_name: Name of the service port for the target.
  • __meta_kubernetes_service_port_number: Number of the service port for the target.
  • __meta_kubernetes_service_port_protocol: Protocol of the service port for the target.
  • __meta_kubernetes_service_type: The type of the service.

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.
  • __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.
  • __meta_kubernetes_pod_container_init: true if the container is an InitContainer
  • __meta_kubernetes_pod_container_name: Name of the container the target address points to.
  • __meta_kubernetes_pod_container_image: The image the container is using.
  • __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.
  • __meta_kubernetes_pod_phase: Set to Pending, Running, Succeeded, Failed or Unknown in the lifecycle.
  • __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.
  • __meta_kubernetes_pod_uid: The UID of the pod object.
  • __meta_kubernetes_pod_controller_kind: Object kind of the pod controller.
  • __meta_kubernetes_pod_controller_name: Name of the pod controller.

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.
  • __meta_kubernetes_endpoints_label_<labelname>: Each label from the endpoints object.
  • __meta_kubernetes_endpoints_labelpresent_<labelname>: true for each label from the endpoints object.
  • For all targets discovered directly from the endpoints list (those not additionally inferred from underlying pods), the following labels are attached:
    • __meta_kubernetes_endpoint_hostname: Hostname of the endpoint.
    • __meta_kubernetes_endpoint_node_name: Name of the node hosting the endpoint.
    • __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.
    • __meta_kubernetes_endpoint_address_target_kind: Kind of the endpoint address target.
    • __meta_kubernetes_endpoint_address_target_name: Name of the endpoint address target.
  • 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.

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 address of the 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.

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.
  • __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.
  • __meta_kubernetes_ingress_class_name: Class name from ingress spec, if present.
  • __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 /.

See below for the configuration options for Kubernetes discovery:

  1. # The information to access the Kubernetes API.
  3. # The API server addresses. If left empty, Prometheus is assumed to run inside
  4. # of the cluster and will discover API servers automatically and use the pod's
  5. # CA certificate and bearer token file at /var/run/secrets/kubernetes.io/serviceaccount/.
  6. [ api_server: <host> ]
  8. # The Kubernetes role of entities that should be discovered.
  9. # One of endpoints, endpointslice, service, pod, node, or ingress.
  10. role: <string>
  12. # Optional path to a kubeconfig file.
  13. # Note that api_server and kube_config are mutually exclusive.
  14. [ kubeconfig_file: <filename> ]
  16. # Optional authentication information used to authenticate to the API server.
  17. # Note that `basic_auth` and `authorization` options are mutually exclusive.
  18. # password and password_file are mutually exclusive.
  20. # Optional HTTP basic authentication information.
  21. basic_auth:
  22.   [ username: <string> ]
  23.   [ password: <secret> ]
  24.   [ password_file: <string> ]
  26. # Optional `Authorization` header configuration.
  27. authorization:
  28.   # Sets the authentication type.
  29.   [ type: <string> | default: Bearer ]
  30.   # Sets the credentials. It is mutually exclusive with
  31.   # `credentials_file`.
  32.   [ credentials: <secret> ]
  33.   # Sets the credentials to the credentials read from the configured file.
  34.   # It is mutually exclusive with `credentials`.
  35.   [ credentials_file: <filename> ]
  37. # Optional OAuth 2.0 configuration.
  38. # Cannot be used at the same time as basic_auth or authorization.
  39. oauth2:
  40.   [ <oauth2> ]
  42. # Optional proxy URL.
  43. [ proxy_url: <string> ]
  44. # Specifies headers to send to proxies during CONNECT requests.
  45. [ proxy_connect_headers:
  46.   [ <string>: [<secret>, ...] ] ]
  48. # Configure whether HTTP requests follow HTTP 3xx redirects.
  49. [ follow_redirects: <boolean> | default = true ]
  51. # Whether to enable HTTP2.
  52. [ enable_http2: <bool> | default: true ]
  54. # TLS configuration.
  55. tls_config:
  56.   [ <tls_config> ]
  58. # Optional namespace discovery. If omitted, all namespaces are used.
  59. namespaces:
  60.   own_namespace: <boolean>
  61.   names:
  62.     [ - <string> ]
  64. # Optional label and field selectors to limit the discovery process to a subset of available resources.
  65. # See https://kubernetes.io/docs/concepts/overview/working-with-objects/field-selectors/
  66. # and https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ to learn more about the possible
  67. # filters that can be used. The endpoints role supports pod, service and endpoints selectors.
  68. # The pod role supports node selectors when configured with `attach_metadata: {node: true}`.
  69. # Other roles only support selectors matching the role itself (e.g. node role can only contain node selectors).
  71. # Note: When making decision about using field/label selector make sure that this
  72. # is the best approach - it will prevent Prometheus from reusing single list/watch
  73. # for all scrape configs. This might result in a bigger load on the Kubernetes API,
  74. # because per each selector combination there will be additional LIST/WATCH. On the other hand,
  75. # if you just want to monitor small subset of pods in large cluster it's recommended to use selectors.
  76. # Decision, if selectors should be used or not depends on the particular situation.
  77. [ selectors:
  78.   [ - role: <string>
  79.     [ label: <string> ]
  80.     [ field: <string> ] ]]
  82. # Optional metadata to attach to discovered targets. If omitted, no additional metadata is attached.
  83. attach_metadata:
  84. # Attaches node metadata to discovered targets. Valid for roles: pod, endpoints, endpointslice.
  85. # When set to true, Prometheus must have permissions to get Nodes.
  86.   [ node: <boolean> | default = false ]

See this example Prometheus configuration file for a detailed example of configuring Prometheus for Kubernetes.

You may wish to check out the 3rd party Prometheus Operator, which automates the Prometheus setup on top of Kubernetes.

<kuma_sd_config>

Kuma SD configurations allow retrieving scrape target from the Kuma control plane.

This SD discovers “monitoring assignments” based on Kuma Dataplane Proxies, 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:

  • __meta_kuma_mesh: the name of the proxy’s Mesh
  • __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:

  1. # Address of the Kuma Control Plane's MADS xDS server.
  2. server: <string>
  4. # The time to wait between polling update requests.
  5. [ refresh_interval: <duration> | default = 30s ]
  7. # The time after which the monitoring assignments are refreshed.
  8. [ fetch_timeout: <duration> | default = 2m ]
  10. # Optional proxy URL.
  11. [ proxy_url: <string> ]
  12. # Specifies headers to send to proxies during CONNECT requests.
  13. [ proxy_connect_headers:
  14.   [ <string>: [<secret>, ...] ] ]
  16. # TLS configuration.
  17. tls_config:
  18.   [ <tls_config> ]
  20. # Authentication information used to authenticate to the Docker daemon.
  21. # Note that `basic_auth` and `authorization` options are
  22. # mutually exclusive.
  23. # password and password_file are mutually exclusive.
  25. # Optional HTTP basic authentication information.
  26. basic_auth:
  27.   [ username: <string> ]
  28.   [ password: <secret> ]
  29.   [ password_file: <string> ]
  31. # Optional the `Authorization` header configuration.
  32. authorization:
  33.   # Sets the authentication type.
  34.   [ type: <string> | default: Bearer ]
  35.   # Sets the credentials. It is mutually exclusive with
  36.   # `credentials_file`.
  37.   [ credentials: <secret> ]
  38.   # Sets the credentials with the credentials read from the configured file.
  39.   # It is mutually exclusive with `credentials`.
  40.   [ credentials_file: <filename> ]
  42. # Optional OAuth 2.0 configuration.
  43. # Cannot be used at the same time as basic_auth or authorization.
  44. oauth2:
  45.   [ <oauth2> ]
  47. # Configure whether HTTP requests follow HTTP 3xx redirects.
  48. [ follow_redirects: <boolean> | default = true ]
  50. # Whether to enable HTTP2.
  51. [ enable_http2: <bool> | default: true ]

The relabeling phase is the preferred and more powerful way to filter proxies and user-defined tags.

<lightsail_sd_config>

Lightsail SD configurations allow retrieving scrape targets from AWS 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:

  • __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_region: the region of the instance
  • __meta_lightsail_tag_<tagkey>: each tag value of the instance

See below for the configuration options for Lightsail discovery:

  1. # The information to access the Lightsail API.
  3. # The AWS region. If blank, the region from the instance metadata is used.
  4. [ region: <string> ]
  6. # Custom endpoint to be used.
  7. [ endpoint: <string> ]
  9. # The AWS API keys. If blank, the environment variables `AWS_ACCESS_KEY_ID`
  10. # and `AWS_SECRET_ACCESS_KEY` are used.
  11. [ access_key: <string> ]
  12. [ secret_key: <secret> ]
  13. # Named AWS profile used to connect to the API.
  14. [ profile: <string> ]
  16. # AWS Role ARN, an alternative to using AWS API keys.
  17. [ role_arn: <string> ]
  19. # Refresh interval to re-read the instance list.
  20. [ refresh_interval: <duration> | default = 60s ]
  22. # The port to scrape metrics from. If using the public IP address, this must
  23. # instead be specified in the relabeling rule.
  24. [ port: <int> | default = 80 ]
  26. # Authentication information used to authenticate to the Lightsail API.
  27. # Note that `basic_auth`, `authorization` and `oauth2` options are
  28. # mutually exclusive.
  29. # `password` and `password_file` are mutually exclusive.
  31. # Optional HTTP basic authentication information, currently not supported by AWS.
  32. basic_auth:
  33.   [ username: <string> ]
  34.   [ password: <secret> ]
  35.   [ password_file: <string> ]
  37. # Optional `Authorization` header configuration, currently not supported by AWS.
  38. authorization:
  39.   # Sets the authentication type.
  40.   [ type: <string> | default: Bearer ]
  41.   # Sets the credentials. It is mutually exclusive with
  42.   # `credentials_file`.
  43.   [ credentials: <secret> ]
  44.   # Sets the credentials to the credentials read from the configured file.
  45.   # It is mutuall exclusive with `credentials`.
  46.   [ credentials_file: <filename> ]
  48. # Optional OAuth 2.0 configuration, currently not supported by AWS.
  49. oauth2:
  50.   [ <oauth2> ]
  52. # Optional proxy URL.
  53. [ proxy_url: <string> ]
  54. # Specifies headers to send to proxies during CONNECT requests.
  55. [ proxy_connect_headers:
  56.   [ <string>: [<secret>, ...] ] ]
  58. # Configure whether HTTP requests follow HTTP 3xx redirects.
  59. [ follow_redirects: <boolean> | default = true ]
  61. # Whether to enable HTTP2.
  62. [ enable_http2: <bool> | default: true ]
  64. # TLS configuration.
  65. tls_config:
  66.   [ <tls_config> ]

<linode_sd_config>

Linode SD configurations allow retrieving scrape targets from Linode’s Linode APIv4. This service discovery uses the public IPv4 address by default, by that can be changed with relabeling, as demonstrated in the Prometheus linode-sd configuration file.

The following meta labels are available on targets during relabeling:

  • __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
  1. # Authentication information used to authenticate to the API server.
  2. # Note that `basic_auth` and `authorization` options are
  3. # mutually exclusive.
  4. # password and password_file are mutually exclusive.
  5. # Note: Linode APIv4 Token must be created with scopes: 'linodes:read_only', 'ips:read_only', and 'events:read_only'
  7. # Optional HTTP basic authentication information, not currently supported by Linode APIv4.
  8. basic_auth:
  9.   [ username: <string> ]
  10.   [ password: <secret> ]
  11.   [ password_file: <string> ]
  13. # Optional the `Authorization` header configuration.
  14. authorization:
  15.   # Sets the authentication type.
  16.   [ type: <string> | default: Bearer ]
  17.   # Sets the credentials. It is mutually exclusive with
  18.   # `credentials_file`.
  19.   [ credentials: <secret> ]
  20.   # Sets the credentials with the credentials read from the configured file.
  21.   # It is mutually exclusive with `credentials`.
  22.   [ credentials_file: <filename> ]
  24. # Optional OAuth 2.0 configuration.
  25. # Cannot be used at the same time as basic_auth or authorization.
  26. oauth2:
  27.   [ <oauth2> ]
  29. # Optional proxy URL.
  30. [ proxy_url: <string> ]
  31. # Specifies headers to send to proxies during CONNECT requests.
  32. [ proxy_connect_headers:
  33.   [ <string>: [<secret>, ...] ] ]
  35. # Configure whether HTTP requests follow HTTP 3xx redirects.
  36. [ follow_redirects: <boolean> | default = true ]
  38. # Whether to enable HTTP2.
  39. [ enable_http2: <bool> | default: true ]
  41. # TLS configuration.
  42. tls_config:
  43.   [ <tls_config> ]
  45. # The port to scrape metrics from.
  46. [ port: <int> | default = 80 ]
  48. # The string by which Linode Instance tags are joined into the tag label.
  49. [ tag_separator: <string> | default = , ]
  51. # The time after which the linode instances are refreshed.
  52. [ refresh_interval: <duration> | default = 60s ]

<marathon_sd_config>

Marathon SD configurations allow retrieving scrape targets using the 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:

  • __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
  • __meta_marathon_port_index: the port index number (e.g. 1 for PORT1)

See below for the configuration options for Marathon discovery:

  1. # List of URLs to be used to contact Marathon servers.
  2. # You need to provide at least one server URL.
  3. servers:
  4.   - <string>
  6. # Polling interval
  7. [ refresh_interval: <duration> | default = 30s ]
  9. # Optional authentication information for token-based authentication
  10. # https://docs.mesosphere.com/1.11/security/ent/iam-api/#passing-an-authentication-token
  11. # It is mutually exclusive with `auth_token_file` and other authentication mechanisms.
  12. [ auth_token: <secret> ]
  14. # Optional authentication information for token-based authentication
  15. # https://docs.mesosphere.com/1.11/security/ent/iam-api/#passing-an-authentication-token
  16. # It is mutually exclusive with `auth_token` and other authentication mechanisms.
  17. [ auth_token_file: <filename> ]
  19. # Sets the `Authorization` header on every request with the
  20. # configured username and password.
  21. # This is mutually exclusive with other authentication mechanisms.
  22. # password and password_file are mutually exclusive.
  23. basic_auth:
  24.   [ username: <string> ]
  25.   [ password: <secret> ]
  26.   [ password_file: <string> ]
  28. # Optional `Authorization` header configuration.
  29. # NOTE: The current version of DC/OS marathon (v1.11.0) does not support
  30. # standard `Authentication` header, use `auth_token` or `auth_token_file`
  31. # instead.
  32. authorization:
  33.   # Sets the authentication type.
  34.   [ type: <string> | default: Bearer ]
  35.   # Sets the credentials. It is mutually exclusive with
  36.   # `credentials_file`.
  37.   [ credentials: <secret> ]
  38.   # Sets the credentials to the credentials read from the configured file.
  39.   # It is mutually exclusive with `credentials`.
  40.   [ credentials_file: <filename> ]
  42. # Optional OAuth 2.0 configuration.
  43. # Cannot be used at the same time as basic_auth or authorization.
  44. oauth2:
  45.   [ <oauth2> ]
  47. # Configure whether HTTP requests follow HTTP 3xx redirects.
  48. [ follow_redirects: <boolean> | default = true ]
  50. # Whether to enable HTTP2.
  51. [ enable_http2: <bool> | default: true ]
  53. # TLS configuration for connecting to marathon servers
  54. tls_config:
  55.   [ <tls_config> ]
  57. # Optional proxy URL.
  58. [ proxy_url: <string> ]
  59. # Specifies headers to send to proxies during CONNECT requests.
  60. [ proxy_connect_headers:
  61.   [ <string>: [<secret>, ...] ] ]

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 Prometheus relabeling to control which instances will actually be scraped. See the Prometheus marathon-sd configuration file 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 in the configuration file), which can also be changed using relabeling.

<nerve_sd_config>

Nerve SD configurations allow retrieving scrape targets from AirBnB’s Nerve which are stored in Zookeeper.

The following meta labels are available on targets during relabeling:

  • __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
  1. # The Zookeeper servers.
  2. servers:
  3.   - <host>
  4. # Paths can point to a single service, or the root of a tree of services.
  5. paths:
  6.   - <string>
  7. [ timeout: <duration> | default = 10s ]

<nomad_sd_config>

Nomad SD configurations allow retrieving scrape targets from Nomad’s Service API.

The following meta labels are available on targets during relabeling:

  • __meta_nomad_address: the service address of the target
  • __meta_nomad_dc: the datacenter name for the target
  • __meta_nomad_namespace: the namespace of the target
  • __meta_nomad_node_id: the node name defined for the target
  • __meta_nomad_service: the name of the service the target belongs to
  • __meta_nomad_service_address: the service address of the target
  • __meta_nomad_service_id: the service ID of the target
  • __meta_nomad_service_port: the service port of the target
  • __meta_nomad_tags: the list of tags of the target joined by the tag separator
  1. # The information to access the Nomad API. It is to be defined
  2. # as the Nomad documentation requires.
  3. [ allow_stale: <boolean> | default = true ]
  4. [ datacenter: <string> ]
  5. [ namespace: <string> | default = default ]
  6. [ refresh_interval: <duration> | default = 60s ]
  7. [ region: <string> | default = global ]
  8. [ server: <host> ]
  9. [ tag_separator: <string> | default = ,]
  11. # Authentication information used to authenticate to the nomad server.
  12. # Note that `basic_auth`, `authorization` and `oauth2` options are
  13. # mutually exclusive.
  14. # `password` and `password_file` are mutually exclusive.
  16. # Optional HTTP basic authentication information.
  17. basic_auth:
  18.   [ username: <string> ]
  19.   [ password: <secret> ]
  20.   [ password_file: <string> ]
  22. # Optional `Authorization` header configuration.
  23. authorization:
  24.   # Sets the authentication type.
  25.   [ type: <string> | default: Bearer ]
  26.   # Sets the credentials. It is mutually exclusive with
  27.   # `credentials_file`.
  28.   [ credentials: <secret> ]
  29.   # Sets the credentials to the credentials read from the configured file.
  30.   # It is mutually exclusive with `credentials`.
  31.   [ credentials_file: <filename> ]
  33. # Optional OAuth 2.0 configuration.
  34. oauth2:
  35.   [ <oauth2> ]
  37. # Optional proxy URL.
  38. [ proxy_url: <string> ]
  39. # Specifies headers to send to proxies during CONNECT requests.
  40. [ proxy_connect_headers:
  41.   [ <string>: [<secret>, ...] ] ]
  43. # Configure whether HTTP requests follow HTTP 3xx redirects.
  44. [ follow_redirects: <boolean> | default = true ]
  46. # Whether to enable HTTP2.
  47. [ enable_http2: <bool> | default: true ]
  49. # TLS configuration.
  50. tls_config:
  51.   [ <tls_config> ]

<serverset_sd_config>

Serverset SD configurations allow retrieving scrape targets from Serversets which are stored in Zookeeper. Serversets are commonly used by Finagle and Aurora.

The following meta labels are available on targets during relabeling:

  • __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
  1. # The Zookeeper servers.
  2. servers:
  3.   - <host>
  4. # Paths can point to a single serverset, or the root of a tree of serversets.
  5. paths:
  6.   - <string>
  7. [ timeout: <duration> | default = 10s ]

Serverset data must be in the JSON format, the Thrift format is not currently supported.

<triton_sd_config>

Triton SD configurations allow retrieving scrape targets from Container Monitor discovery endpoints.

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:

  • __meta_triton_groups: the list of groups belonging to the target joined by a comma separator
  • __meta_triton_machine_alias: the alias of the target container
  • __meta_triton_machine_brand: the brand of the target container
  • __meta_triton_machine_id: the UUID of the target container
  • __meta_triton_machine_image: the target container’s image type
  • __meta_triton_server_id: the server UUID the target container is running on

cn

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:

  • __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:

  1. # The information to access the Triton discovery API.
  3. # The account to use for discovering new targets.
  4. account: <string>
  6. # The type of targets to discover, can be set to:
  7. # * "container" to discover virtual machines (SmartOS zones, lx/KVM/bhyve branded zones) running on Triton
  8. # * "cn" to discover compute nodes (servers/global zones) making up the Triton infrastructure
  9. [ role : <string> | default = "container" ]
  11. # The DNS suffix which should be applied to target.
  12. dns_suffix: <string>
  14. # The Triton discovery endpoint (e.g. 'cmon.us-east-3b.triton.zone'). This is
  15. # often the same value as dns_suffix.
  16. endpoint: <string>
  18. # A list of groups for which targets are retrieved, only supported when `role` == `container`.
  19. # If omitted all containers owned by the requesting account are scraped.
  20. groups:
  21.   [ - <string> ... ]
  23. # The port to use for discovery and metric scraping.
  24. [ port: <int> | default = 9163 ]
  26. # The interval which should be used for refreshing targets.
  27. [ refresh_interval: <duration> | default = 60s ]
  29. # The Triton discovery API version.
  30. [ version: <int> | default = 1 ]
  32. # TLS configuration.
  33. tls_config:
  34.   [ <tls_config> ]

<eureka_sd_config>

Eureka SD configurations allow retrieving scrape targets using the 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:

  • __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:

  1. # The URL to connect to the Eureka server.
  2. server: <string>
  4. # Sets the `Authorization` header on every request with the
  5. # configured username and password.
  6. # password and password_file are mutually exclusive.
  7. basic_auth:
  8.   [ username: <string> ]
  9.   [ password: <secret> ]
  10.   [ password_file: <string> ]
  12. # Optional `Authorization` header configuration.
  13. authorization:
  14.   # Sets the authentication type.
  15.   [ type: <string> | default: Bearer ]
  16.   # Sets the credentials. It is mutually exclusive with
  17.   # `credentials_file`.
  18.   [ credentials: <secret> ]
  19.   # Sets the credentials to the credentials read from the configured file.
  20.   # It is mutually exclusive with `credentials`.
  21.   [ credentials_file: <filename> ]
  23. # Optional OAuth 2.0 configuration.
  24. # Cannot be used at the same time as basic_auth or authorization.
  25. oauth2:
  26.   [ <oauth2> ]
  28. # Configures the scrape request's TLS settings.
  29. tls_config:
  30.   [ <tls_config> ]
  32. # Optional proxy URL.
  33. [ proxy_url: <string> ]
  34. # Specifies headers to send to proxies during CONNECT requests.
  35. [ proxy_connect_headers:
  36.   [ <string>: [<secret>, ...] ] ]
  38. # Configure whether HTTP requests follow HTTP 3xx redirects.
  39. [ follow_redirects: <boolean> | default = true ]
  41. # Whether to enable HTTP2.
  42. [ enable_http2: <bool> | default: true ]
  44. # Refresh interval to re-read the app instance list.
  45. [ refresh_interval: <duration> | default = 30s ]

See the Prometheus eureka-sd configuration file for a practical example on how to set up your Eureka app and your Prometheus configuration.

<scaleway_sd_config>

Scaleway SD configurations allow retrieving scrape targets from Scaleway instances and baremetal services.

The following meta labels are available on targets during relabeling:

Instance role

  • __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
  • __meta_scaleway_instance_name: name of the server
  • __meta_scaleway_instance_organization_id: the organization of the server
  • __meta_scaleway_instance_private_ipv4: the private IPv4 address of the server
  • __meta_scaleway_instance_project_id: project id of the server
  • __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
  • __meta_scaleway_instance_status: status of the server
  • __meta_scaleway_instance_tags: the list of tags of the server joined by the tag separator
  • __meta_scaleway_instance_type: commercial type of the server
  • __meta_scaleway_instance_zone: the zone of the server (ex: fr-par-1, complete list here)

This role uses the private IPv4 address by default. This can be changed with relabeling, as demonstrated in the Prometheus scaleway-sd configuration file.

Baremetal role

  • __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)

This role uses the public IPv4 address by default. This can be changed with relabeling, as demonstrated in the Prometheus scaleway-sd configuration file.

See below for the configuration options for Scaleway discovery:

  1. # Access key to use. https://console.scaleway.com/project/credentials
  2. access_key: <string>
  4. # Secret key to use when listing targets. https://console.scaleway.com/project/credentials
  5. # It is mutually exclusive with `secret_key_file`.
  6. [ secret_key: <secret> ]
  8. # Sets the secret key with the credentials read from the configured file.
  9. # It is mutually exclusive with `secret_key`.
  10. [ secret_key_file: <filename> ]
  12. # Project ID of the targets.
  13. project_id: <string>
  15. # Role of the targets to retrieve. Must be `instance` or `baremetal`.
  16. role: <string>
  18. # The port to scrape metrics from.
  19. [ port: <int> | default = 80 ]
  21. # API URL to use when doing the server listing requests.
  22. [ api_url: <string> | default = "https://api.scaleway.com" ]
  24. # Zone is the availability zone of your targets (e.g. fr-par-1).
  25. [ zone: <string> | default = fr-par-1 ]
  27. # NameFilter specify a name filter (works as a LIKE) to apply on the server listing request.
  28. [ name_filter: <string> ]
  30. # TagsFilter specify a tag filter (a server needs to have all defined tags to be listed) to apply on the server listing request.
  31. tags_filter:
  32. [ - <string> ]
  34. # Refresh interval to re-read the targets list.
  35. [ refresh_interval: <duration> | default = 60s ]
  37. # Configure whether HTTP requests follow HTTP 3xx redirects.
  38. [ follow_redirects: <boolean> | default = true ]
  40. # Whether to enable HTTP2.
  41. [ enable_http2: <bool> | default: true ]
  43. # Optional proxy URL.
  44. [ proxy_url: <string> ]
  45. # Specifies headers to send to proxies during CONNECT requests.
  46. [ proxy_connect_headers:
  47.   [ <string>: [<secret>, ...] ] ]
  49. # TLS configuration.
  50. tls_config:
  51.   [ <tls_config> ]

<uyuni_sd_config>

Uyuni SD configurations allow retrieving scrape targets from managed systems via Uyuni API.

The following meta labels are available on targets during relabeling:

  • __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:

  1. # The URL to connect to the Uyuni server.
  2. server: <string>
  4. # Credentials are used to authenticate the requests to Uyuni API.
  5. username: <string>
  6. password: <secret>
  8. # The entitlement string to filter eligible systems.
  9. [ entitlement: <string> | default = monitoring_entitled ]
  11. # The string by which Uyuni group names are joined into the groups label.
  12. [ separator: <string> | default = , ]
  14. # Refresh interval to re-read the managed targets list.
  15. [ refresh_interval: <duration> | default = 60s ]
  17. # Optional HTTP basic authentication information, currently not supported by Uyuni.
  18. basic_auth:
  19.   [ username: <string> ]
  20.     [ password: <secret> ]
  21.     [ password_file: <string> ]
  23. # Optional `Authorization` header configuration, currently not supported by Uyuni.
  24. authorization:
  25.   # Sets the authentication type.
  26.     [ type: <string> | default: Bearer ]
  27.     # Sets the credentials. It is mutually exclusive with
  28.     # `credentials_file`.
  29.     [ credentials: <secret> ]
  30.     # Sets the credentials to the credentials read from the configured file.
  31.     # It is mutually exclusive with `credentials`.
  32.     [ credentials_file: <filename> ]
  34. # Optional OAuth 2.0 configuration, currently not supported by Uyuni.
  35. # Cannot be used at the same time as basic_auth or authorization.
  36. oauth2:
  37.   [ <oauth2> ]
  39. # Optional proxy URL.
  40. [ proxy_url: <string> ]
  41. # Specifies headers to send to proxies during CONNECT requests.
  42. [ proxy_connect_headers:
  43.   [ <string>: [<secret>, ...] ] ]
  45. # Configure whether HTTP requests follow HTTP 3xx redirects.
  46. [ follow_redirects: <boolean> | default = true ]
  48. # Whether to enable HTTP2.
  49. [ enable_http2: <bool> | default: true ]
  51. # TLS configuration.
  52. tls_config:
  53.   [ <tls_config> ]

See the Prometheus uyuni-sd configuration file for a practical example on how to set up Uyuni Prometheus configuration.

<vultr_sd_config>

Vultr SD configurations allow retrieving scrape targets from Vultr.

This service discovery uses the main IPv4 address by default, which that be changed with relabeling, as demonstrated in the Prometheus vultr-sd configuration file.

The following meta labels are available on targets during relabeling:

  • __meta_vultr_instance_id : A unique ID for the vultr Instance.
  • __meta_vultr_instance_label : The user-supplied label for this instance.
  • __meta_vultr_instance_os : The Operating System name.
  • __meta_vultr_instance_os_id : The Operating System id used by this instance.
  • __meta_vultr_instance_region : The Region id where the Instance is located.
  • __meta_vultr_instance_plan : A unique ID for the Plan.
  • __meta_vultr_instance_main_ip : The main IPv4 address.
  • __meta_vultr_instance_internal_ip : The private IP address.
  • __meta_vultr_instance_main_ipv6 : The main IPv6 address.
  • __meta_vultr_instance_features : List of features that are available to the instance.
  • __meta_vultr_instance_tags : List of tags associated with the instance.
  • __meta_vultr_instance_hostname : The hostname for this instance.
  • __meta_vultr_instance_server_status : The server health status.
  • __meta_vultr_instance_vcpu_count : Number of vCPUs.
  • __meta_vultr_instance_ram_mb : The amount of RAM in MB.
  • __meta_vultr_instance_disk_gb : The size of the disk in GB.
  • __meta_vultr_instance_allowed_bandwidth_gb : Monthly bandwidth quota in GB.
  1. # Authentication information used to authenticate to the API server.
  2. # Note that `basic_auth` and `authorization` options are
  3. # mutually exclusive.
  4. # password and password_file are mutually exclusive.
  6. # Optional HTTP basic authentication information, not currently supported by Vultr.
  7. basic_auth:
  8.   [ username: <string> ]
  9.   [ password: <secret> ]
  10.   [ password_file: <string> ]
  12. # Optional `Authorization` header configuration.
  13. authorization:
  14.   # Sets the authentication type.
  15.   [ type: <string> | default: Bearer ]
  16.   # Sets the credentials. It is mutually exclusive with
  17.   # `credentials_file`.
  18.   [ credentials: <secret> ]
  19.   # Sets the credentials to the credentials read from the configured file.
  20.   # It is mutually exclusive with `credentials`.
  21.   [ credentials_file: <filename> ]
  23. # Optional OAuth 2.0 configuration.
  24. # Cannot be used at the same time as basic_auth or authorization.
  25. oauth2:
  26.   [ <oauth2> ]
  28. # Optional proxy URL.
  29. [ proxy_url: <string> ]
  30. # Specifies headers to send to proxies during CONNECT requests.
  31. [ proxy_connect_headers:
  32.   [ <string>: [<secret>, ...] ] ]
  34. # Configure whether HTTP requests follow HTTP 3xx redirects.
  35. [ follow_redirects: <boolean> | default = true ]
  37. # Whether to enable HTTP2.
  38. [ enable_http2: <bool> | default: true ]
  40. # TLS configuration.
  41. tls_config:
  42.   [ <tls_config> ]
  44. # The port to scrape metrics from.
  45. [ port: <int> | default = 80 ]
  47. # The time after which the instances are refreshed.
  48. [ refresh_interval: <duration> | default = 60s ]

<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.

  1. # The targets specified by the static config.
  2. targets:
  3.   [ - '<host>' ]
  5. # Labels assigned to all metrics scraped from the targets.
  6. labels:
  7.   [ <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>.

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.

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.

Labels starting with __ will be removed from the label set after target relabeling is completed.

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.

  1. # The source labels select values from existing labels. Their content is concatenated
  2. # using the configured separator and matched against the configured regular expression
  3. # for the replace, keep, and drop actions.
  4. [ source_labels: '[' <labelname> [, ...] ']' ]
  6. # Separator placed between concatenated source label values.
  7. [ separator: <string> | default = ; ]
  9. # Label to which the resulting value is written in a replace action.
  10. # It is mandatory for replace actions. Regex capture groups are available.
  11. [ target_label: <labelname> ]
  13. # Regular expression against which the extracted value is matched.
  14. [ regex: <regex> | default = (.*) ]
  16. # Modulus to take of the hash of the source label values.
  17. [ modulus: <int> ]
  19. # Replacement value against which a regex replace is performed if the
  20. # regular expression matches. Regex capture groups are available.
  21. [ replacement: <string> | default = $1 ]
  23. # Action to perform based on regex matching.
  24. [ action: <relabel_action> | default = replace ]

<regex> is any valid RE2 regular expression. 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.
  • lowercase: Maps the concatenated source_labels to their lower case.
  • uppercase: Maps the concatenated source_labels to their upper case.
  • keep: Drop targets for which regex does not match the concatenated source_labels.
  • drop: Drop targets for which regex matches the concatenated source_labels.
  • keepequal: Drop targets for which the concatenated source_labels do not match target_label.
  • dropequal: Drop targets for which the concatenated source_labels do match target_label.
  • hashmod: Set target_label to the modulus of a hash of the concatenated source_labels.
  • labelmap: Match regex against all source label names, not just those specified in source_labels. 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.

Care must be taken with labeldrop and labelkeep to ensure that metrics are still uniquely labeled once the labels are removed.

<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.

One use for this is to exclude time series that are too expensive to ingest.

<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>

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.

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.

  1. # Per-target Alertmanager timeout when pushing alerts.
  2. [ timeout: <duration> | default = 10s ]
  4. # The api version of Alertmanager.
  5. [ api_version: <string> | default = v2 ]
  7. # Prefix for the HTTP path alerts are pushed to.
  8. [ path_prefix: <path> | default = / ]
  10. # Configures the protocol scheme used for requests.
  11. [ scheme: <scheme> | default = http ]
  13. # Sets the `Authorization` header on every request with the
  14. # configured username and password.
  15. # password and password_file are mutually exclusive.
  16. basic_auth:
  17.   [ username: <string> ]
  18.   [ password: <secret> ]
  19.   [ password_file: <string> ]
  21. # Optional `Authorization` header configuration.
  22. authorization:
  23.   # Sets the authentication type.
  24.   [ type: <string> | default: Bearer ]
  25.   # Sets the credentials. It is mutually exclusive with
  26.   # `credentials_file`.
  27.   [ credentials: <secret> ]
  28.   # Sets the credentials to the credentials read from the configured file.
  29.   # It is mutually exclusive with `credentials`.
  30.   [ credentials_file: <filename> ]
  32. # Optional OAuth 2.0 configuration.
  33. # Cannot be used at the same time as basic_auth or authorization.
  34. oauth2:
  35.   [ <oauth2> ]
  37. # Configures the scrape request's TLS settings.
  38. tls_config:
  39.   [ <tls_config> ]
  41. # Optional proxy URL.
  42. [ proxy_url: <string> ]
  43. # Specifies headers to send to proxies during CONNECT requests.
  44. [ proxy_connect_headers:
  45.   [ <string>: [<secret>, ...] ] ]
  47. # Configure whether HTTP requests follow HTTP 3xx redirects.
  48. [ follow_redirects: <boolean> | default = true ]
  50. # Whether to enable HTTP2.
  51. [ enable_http2: <bool> | default: true ]
  53. # List of Azure service discovery configurations.
  54. azure_sd_configs:
  55.   [ - <azure_sd_config> ... ]
  57. # List of Consul service discovery configurations.
  58. consul_sd_configs:
  59.   [ - <consul_sd_config> ... ]
  61. # List of DNS service discovery configurations.
  62. dns_sd_configs:
  63.   [ - <dns_sd_config> ... ]
  65. # List of EC2 service discovery configurations.
  66. ec2_sd_configs:
  67.   [ - <ec2_sd_config> ... ]
  69. # List of Eureka service discovery configurations.
  70. eureka_sd_configs:
  71.   [ - <eureka_sd_config> ... ]
  73. # List of file service discovery configurations.
  74. file_sd_configs:
  75.   [ - <file_sd_config> ... ]
  77. # List of DigitalOcean service discovery configurations.
  78. digitalocean_sd_configs:
  79.   [ - <digitalocean_sd_config> ... ]
  81. # List of Docker service discovery configurations.
  82. docker_sd_configs:
  83.   [ - <docker_sd_config> ... ]
  85. # List of Docker Swarm service discovery configurations.
  86. dockerswarm_sd_configs:
  87.   [ - <dockerswarm_sd_config> ... ]
  89. # List of GCE service discovery configurations.
  90. gce_sd_configs:
  91.   [ - <gce_sd_config> ... ]
  93. # List of Hetzner service discovery configurations.
  94. hetzner_sd_configs:
  95.   [ - <hetzner_sd_config> ... ]
  97. # List of HTTP service discovery configurations.
  98. http_sd_configs:
  99.   [ - <http_sd_config> ... ]
  101.  # List of IONOS service discovery configurations.
  102. ionos_sd_configs:
  103.   [ - <ionos_sd_config> ... ]
  105. # List of Kubernetes service discovery configurations.
  106. kubernetes_sd_configs:
  107.   [ - <kubernetes_sd_config> ... ]
  109. # List of Lightsail service discovery configurations.
  110. lightsail_sd_configs:
  111.   [ - <lightsail_sd_config> ... ]
  113. # List of Linode service discovery configurations.
  114. linode_sd_configs:
  115.   [ - <linode_sd_config> ... ]
  117. # List of Marathon service discovery configurations.
  118. marathon_sd_configs:
  119.   [ - <marathon_sd_config> ... ]
  121. # List of AirBnB's Nerve service discovery configurations.
  122. nerve_sd_configs:
  123.   [ - <nerve_sd_config> ... ]
  125. # List of Nomad service discovery configurations.
  126. nomad_sd_configs:
  127.   [ - <nomad_sd_config> ... ]
  129. # List of OpenStack service discovery configurations.
  130. openstack_sd_configs:
  131.   [ - <openstack_sd_config> ... ]
  133. # List of OVHcloud service discovery configurations.
  134. ovhcloud_sd_configs:
  135.   [ - <ovhcloud_sd_config> ... ]
  137. # List of PuppetDB service discovery configurations.
  138. puppetdb_sd_configs:
  139.   [ - <puppetdb_sd_config> ... ]
  141. # List of Scaleway service discovery configurations.
  142. scaleway_sd_configs:
  143.   [ - <scaleway_sd_config> ... ]
  145. # List of Zookeeper Serverset service discovery configurations.
  146. serverset_sd_configs:
  147.   [ - <serverset_sd_config> ... ]
  149. # List of Triton service discovery configurations.
  150. triton_sd_configs:
  151.   [ - <triton_sd_config> ... ]
  153. # List of Uyuni service discovery configurations.
  154. uyuni_sd_configs:
  155.   [ - <uyuni_sd_config> ... ]
  157. # List of Vultr service discovery configurations.
  158. vultr_sd_configs:
  159.   [ - <vultr_sd_config> ... ]
  161. # List of labeled statically configured Alertmanagers.
  162. static_configs:
  163.   [ - <static_config> ... ]
  165. # List of Alertmanager relabel configurations.
  166. relabel_configs:
  167.   [ - <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 of how to use this functionality.

  1. # The URL of the endpoint to send samples to.
  2. url: <string>
  4. # Timeout for requests to the remote write endpoint.
  5. [ remote_timeout: <duration> | default = 30s ]
  7. # Custom HTTP headers to be sent along with each remote write request.
  8. # Be aware that headers that are set by Prometheus itself can't be overwritten.
  9. headers:
  10.   [ <string>: <string> ... ]
  12. # List of remote write relabel configurations.
  13. write_relabel_configs:
  14.   [ - <relabel_config> ... ]
  16. # Name of the remote write config, which if specified must be unique among remote write configs.
  17. # The name will be used in metrics and logging in place of a generated value to help users distinguish between
  18. # remote write configs.
  19. [ name: <string> ]
  21. # Enables sending of exemplars over remote write. Note that exemplar storage itself must be enabled for exemplars to be scraped in the first place.
  22. [ send_exemplars: <boolean> | default = false ]
  24. # Enables sending of native histograms, also known as sparse histograms, over remote write.
  25. [ send_native_histograms: <boolean> | default = false ]
  27. # Sets the `Authorization` header on every remote write request with the
  28. # configured username and password.
  29. # password and password_file are mutually exclusive.
  30. basic_auth:
  31.   [ username: <string> ]
  32.   [ password: <secret> ]
  33.   [ password_file: <string> ]
  35. # Optional `Authorization` header configuration.
  36. authorization:
  37.   # Sets the authentication type.
  38.   [ type: <string> | default: Bearer ]
  39.   # Sets the credentials. It is mutually exclusive with
  40.   # `credentials_file`.
  41.   [ credentials: <secret> ]
  42.   # Sets the credentials to the credentials read from the configured file.
  43.   # It is mutually exclusive with `credentials`.
  44.   [ credentials_file: <filename> ]
  46. # Optionally configures AWS's Signature Verification 4 signing process to
  47. # sign requests. Cannot be set at the same time as basic_auth, authorization, or oauth2.
  48. # To use the default credentials from the AWS SDK, use `sigv4: {}`.
  49. sigv4:
  50.   # The AWS region. If blank, the region from the default credentials chain
  51.   # is used.
  52.   [ region: <string> ]
  54.   # The AWS API keys. If blank, the environment variables `AWS_ACCESS_KEY_ID`
  55.   # and `AWS_SECRET_ACCESS_KEY` are used.
  56.   [ access_key: <string> ]
  57.   [ secret_key: <secret> ]
  59.   # Named AWS profile used to authenticate.
  60.   [ profile: <string> ]
  62.   # AWS Role ARN, an alternative to using AWS API keys.
  63.   [ role_arn: <string> ]
  65. # Optional OAuth 2.0 configuration.
  66. # Cannot be used at the same time as basic_auth, authorization, or sigv4.
  67. oauth2:
  68.   [ <oauth2> ]
  70. # Configures the remote write request's TLS settings.
  71. tls_config:
  72.   [ <tls_config> ]
  74. # Optional proxy URL.
  75. [ proxy_url: <string> ]
  76. # Specifies headers to send to proxies during CONNECT requests.
  77. [ proxy_connect_headers:
  78.   [ <string>: [<secret>, ...] ] ]
  80. # Configure whether HTTP requests follow HTTP 3xx redirects.
  81. [ follow_redirects: <boolean> | default = true ]
  83. # Whether to enable HTTP2.
  84. [ enable_http2: <bool> | default: true ]
  86. # Configures the queue used to write to remote storage.
  87. queue_config:
  88.   # Number of samples to buffer per shard before we block reading of more
  89.   # samples from the WAL. It is recommended to have enough capacity in each
  90.   # shard to buffer several requests to keep throughput up while processing
  91.   # occasional slow remote requests.
  92.   [ capacity: <int> | default = 2500 ]
  93.   # Maximum number of shards, i.e. amount of concurrency.
  94.   [ max_shards: <int> | default = 200 ]
  95.   # Minimum number of shards, i.e. amount of concurrency.
  96.   [ min_shards: <int> | default = 1 ]
  97.   # Maximum number of samples per send.
  98.   [ max_samples_per_send: <int> | default = 500]
  99.   # Maximum time a sample will wait in buffer.
  100.   [ batch_send_deadline: <duration> | default = 5s ]
  101.   # Initial retry delay. Gets doubled for every retry.
  102.   [ min_backoff: <duration> | default = 30ms ]
  103.   # Maximum retry delay.
  104.   [ max_backoff: <duration> | default = 5s ]
  105.   # Retry upon receiving a 429 status code from the remote-write storage.
  106.   # This is experimental and might change in the future.
  107.   [ retry_on_http_429: <boolean> | default = false ]
  109. # Configures the sending of series metadata to remote storage.
  110. # Metadata configuration is subject to change at any point
  111. # or be removed in future releases.
  112. metadata_config:
  113.   # Whether metric metadata is sent to remote storage or not.
  114.   [ send: <boolean> | default = true ]
  115.   # How frequently metric metadata is sent to remote storage.
  116.   [ send_interval: <duration> | default = 1m ]
  117.   # Maximum number of samples per send.
  118.   [ max_samples_per_send: <int> | default = 500]

There is a list of integrations with this feature.

<remote_read>

  1. # The URL of the endpoint to query from.
  2. url: <string>
  4. # Name of the remote read config, which if specified must be unique among remote read configs.
  5. # The name will be used in metrics and logging in place of a generated value to help users distinguish between
  6. # remote read configs.
  7. [ name: <string> ]
  9. # An optional list of equality matchers which have to be
  10. # present in a selector to query the remote read endpoint.
  11. required_matchers:
  12.   [ <labelname>: <labelvalue> ... ]
  14. # Timeout for requests to the remote read endpoint.
  15. [ remote_timeout: <duration> | default = 1m ]
  17. # Custom HTTP headers to be sent along with each remote read request.
  18. # Be aware that headers that are set by Prometheus itself can't be overwritten.
  19. headers:
  20.   [ <string>: <string> ... ]
  22. # Whether reads should be made for queries for time ranges that
  23. # the local storage should have complete data for.
  24. [ read_recent: <boolean> | default = false ]
  26. # Sets the `Authorization` header on every remote read request with the
  27. # configured username and password.
  28. # password and password_file are mutually exclusive.
  29. basic_auth:
  30.   [ username: <string> ]
  31.   [ password: <secret> ]
  32.   [ password_file: <string> ]
  34. # Optional `Authorization` header configuration.
  35. authorization:
  36.   # Sets the authentication type.
  37.   [ type: <string> | default: Bearer ]
  38.   # Sets the credentials. It is mutually exclusive with
  39.   # `credentials_file`.
  40.   [ credentials: <secret> ]
  41.   # Sets the credentials to the credentials read from the configured file.
  42.   # It is mutually exclusive with `credentials`.
  43.   [ credentials_file: <filename> ]
  45. # Optional OAuth 2.0 configuration.
  46. # Cannot be used at the same time as basic_auth or authorization.
  47. oauth2:
  48.   [ <oauth2> ]
  50. # Configures the remote read request's TLS settings.
  51. tls_config:
  52.   [ <tls_config> ]
  54. # Optional proxy URL.
  55. [ proxy_url: <string> ]
  56. # Specifies headers to send to proxies during CONNECT requests.
  57. [ proxy_connect_headers:
  58.   [ <string>: [<secret>, ...] ] ]
  60. # Configure whether HTTP requests follow HTTP 3xx redirects.
  61. [ follow_redirects: <boolean> | default = true ]
  63. # Whether to enable HTTP2.
  64. [ enable_http2: <bool> | default: true ]
  66. # Whether to use the external labels as selectors for the remote read endpoint.
  67. [ filter_external_labels: <boolean> | default = true ]

There is a list of integrations with this feature.

<tsdb>

tsdb lets you configure the runtime-reloadable configuration settings of the TSDB.

NOTE: Out-of-order ingestion is an experimental feature, but you do not need any additional flag to enable it. Setting out_of_order_time_window to a positive duration enables it.

  1. # Configures how old an out-of-order/out-of-bounds sample can be w.r.t. the TSDB max time.
  2. # An out-of-order/out-of-bounds sample is ingested into the TSDB as long as the timestamp
  3. # of the sample is >= TSDB.MaxTime-out_of_order_time_window.
  4. #
  5. # When out_of_order_time_window is >0, the errors out-of-order and out-of-bounds are
  6. # combined into a single error called 'too-old'; a sample is either (a) ingestible
  7. # into the TSDB, i.e. it is an in-order sample or an out-of-order/out-of-bounds sample
  8. # that is within the out-of-order window, or (b) too-old, i.e. not in-order
  9. # and before the out-of-order window.
  10. [ out_of_order_time_window: <duration> | default = 0s ]

<exemplars>

Note that exemplar storage is still considered experimental and must be enabled via --enable-feature=exemplar-storage.

  1. # Configures the maximum size of the circular buffer used to store exemplars for all series. Resizable during runtime.
  2. [ max_exemplars: <int> | default = 100000 ]

<tracing_config>

tracing_config configures exporting traces from Prometheus to a tracing backend via the OTLP protocol. Tracing is currently an experimental feature and could change in the future.

  1. # Client used to export the traces. Options are 'http' or 'grpc'.
  2. [ client_type: <string> | default = grpc ]
  4. # Endpoint to send the traces to. Should be provided in format <host>:<port>.
  5. [ endpoint: <string> ]
  7. # Sets the probability a given trace will be sampled. Must be a float from 0 through 1.
  8. [ sampling_fraction: <float> | default = 0 ]
  10. # If disabled, the client will use a secure connection.
  11. [ insecure: <boolean> | default = false ]
  13. # Key-value pairs to be used as headers associated with gRPC or HTTP requests.
  14. headers:
  15.   [ <string>: <string> ... ]
  17. # Compression key for supported compression types. Supported compression: gzip.
  18. [ compression: <string> ]
  20. # Maximum time the exporter will wait for each batch export.
  21. [ timeout: <duration> | default = 10s ]
  23. # TLS configuration.
  24. tls_config:
  25.   [ <tls_config> ]

This documentation is open-source. Please help improve it by filing issues or pull requests.