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

<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 bearer token. It is mutually exclusive with `bearer_token_file`.
  62. [ bearer_token: <secret> ]
  64. # Sets the `Authorization` header on every scrape request with the bearer token
  65. # read from the configured file. It is mutually exclusive with `bearer_token`.
  66. [ bearer_token_file: <filename> ]
  68. # Configures the scrape request's TLS settings.
  69. tls_config:
  70.   [ <tls_config> ]
  72. # Optional proxy URL.
  73. [ proxy_url: <string> ]
  75. # List of Azure service discovery configurations.
  76. azure_sd_configs:
  77.   [ - <azure_sd_config> ... ]
  79. # List of Consul service discovery configurations.
  80. consul_sd_configs:
  81.   [ - <consul_sd_config> ... ]
  83. # List of DigitalOcean service discovery configurations.
  84. digitalocean_sd_configs:
  85.   [ - <digitalocean_sd_config> ... ]
  87. # List of Docker Swarm service discovery configurations.
  88. dockerswarm_sd_configs:
  89.   [ - <dockerswarm_sd_config> ... ]
  91. # List of DNS service discovery configurations.
  92. dns_sd_configs:
  93.   [ - <dns_sd_config> ... ]
  95. # List of EC2 service discovery configurations.
  96. ec2_sd_configs:
  97.   [ - <ec2_sd_config> ... ]
  99. # List of Eureka service discovery configurations.
  100. eureka_sd_configs:
  101.   [ - <eureka_sd_config> ... ]
  103. # List of file service discovery configurations.
  104. file_sd_configs:
  105.   [ - <file_sd_config> ... ]
  107. # List of GCE service discovery configurations.
  108. gce_sd_configs:
  109.   [ - <gce_sd_config> ... ]
  111. # List of Hetzner service discovery configurations.
  112. hetzner_sd_configs:
  113.   [ - <hetzner_sd_config> ... ]
  115. # List of Kubernetes service discovery configurations.
  116. kubernetes_sd_configs:
  117.   [ - <kubernetes_sd_config> ... ]
  119. # List of Marathon service discovery configurations.
  120. marathon_sd_configs:
  121.   [ - <marathon_sd_config> ... ]
  123. # List of AirBnB's Nerve service discovery configurations.
  124. nerve_sd_configs:
  125.   [ - <nerve_sd_config> ... ]
  127. # List of OpenStack service discovery configurations.
  128. openstack_sd_configs:
  129.   [ - <openstack_sd_config> ... ]
  131. # List of Zookeeper Serverset service discovery configurations.
  132. serverset_sd_configs:
  133.   [ - <serverset_sd_config> ... ]
  135. # List of Triton service discovery configurations.
  136. triton_sd_configs:
  137.   [ - <triton_sd_config> ... ]
  139. # List of labeled statically configured targets for this job.
  140. static_configs:
  141.   [ - <static_config> ... ]
  143. # List of target relabel configurations.
  144. relabel_configs:
  145.   [ - <relabel_config> ... ]
  147. # List of metric relabel configurations.
  148. metric_relabel_configs:
  149.   [ - <relabel_config> ... ]
  151. # Per-scrape limit on number of scraped samples that will be accepted.
  152. # If more than this number of samples are present after metric relabeling
  153. # the entire scrape will be treated as failed. 0 means no limit.
  154. [ sample_limit: <int> | default = 0 ]
  156. # Per-scrape config limit on number of unique targets that will be
  157. # accepted. If more than this number of targets are present after target
  158. # relabeling, Prometheus will mark the targets as failed without scraping them.
  159. # 0 means no limit. This is an experimental feature, this behaviour could
  160. # change in the future.
  161. [ 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> ]

<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_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. # Refresh interval to re-read the instance list.
  18. [ refresh_interval: <duration> | default = 300s ]
  20. # The port to scrape metrics from. If using the public IP address, this must
  21. # instead be specified in the relabeling rule.
  22. [ port: <int> | default = 80 ]

<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_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. [ scheme: <string> | default = "http" ]
  7. [ username: <string> ]
  8. [ password: <secret> ]
  10. tls_config:
  11.   [ <tls_config> ]
  13. # A list of services for which targets are retrieved. If omitted, all services
  14. # are scraped.
  15. services:
  16.   [ - <string> ]
  18. # See https://www.consul.io/api/catalog.html#list-nodes-for-service to know more
  19. # about the possible filters that can be used.
  21. # An optional list of tags used to filter nodes for a given service. Services must contain all tags in the list.
  22. tags:
  23.   [ - <string> ]
  25. # Node metadata key/value pairs to filter nodes for a given service.
  26. [ node_meta:
  27.   [ <string>: <string> ... ] ]
  29. # The string by which Consul tags are joined into the tag label.
  30. [ tag_separator: <string> | default = , ]
  32. # Allow stale Consul results (see https://www.consul.io/api/features/consistency.html). Will reduce load on Consul.
  33. [ allow_stale: <boolean> | default = true ]
  35. # The time after which the provided names are refreshed.
  36. # On large setup it might be a good idea to increase this value because the catalog will change all the time.
  37. [ refresh_interval: <duration> | default = 30s ]

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 relabelling, 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 image name of the droplet
  • __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
  1. # Authentication information used to authenticate to the API server.
  2. # Note that `basic_auth`, `bearer_token` and `bearer_token_file` 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 bearer token authentication information.
  13. [ bearer_token: <secret> ]
  15. # Optional bearer token file authentication information.
  16. [ bearer_token_file: <filename> ]
  18. # Optional proxy URL.
  19. [ proxy_url: <string> ]
  21. # TLS configuration.
  22. tls_config:
  23.   [ <tls_config> ]
  25. # The port to scrape metrics from.
  26. [ port: <int> | default = 80 ]
  28. # The time after which the droplets are refreshed.
  29. [ refresh_interval: <duration> | default = 60s ]

<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_task_id: the id of the task
  • __meta_dockerswarm_task_container_id: the container id of the task
  • __meta_dockerswarm_task_desired_state: the desired state of the task
  • __meta_dockerswarm_task_label_<labelname>: each label of the task
  • __meta_dockerswarm_task_slot: the slot of the task
  • __meta_dockerswarm_task_state: the state of the task
  • __meta_dockerswarm_task_port_publish_mode: the publish mode of the task port
  • __meta_dockerswarm_service_id: the id of the service
  • __meta_dockerswarm_service_name: the name of the service
  • __meta_dockerswarm_service_mode: the mode of the service
  • __meta_dockerswarm_service_label_<labelname>: each label of the service
  • __meta_dockerswarm_network_id: the ID of the network
  • __meta_dockerswarm_network_name: the name of the network
  • __meta_dockerswarm_network_ingress: whether the network is ingress
  • __meta_dockerswarm_network_internal: whether the network is internal
  • __meta_dockerswarm_network_label_<labelname>: each label of the network
  • __meta_dockerswarm_network_label: each label of the network
  • __meta_dockerswarm_network_scope: the scope of the network
  • __meta_dockerswarm_node_id: the ID of the node
  • __meta_dockerswarm_node_hostname: the hostname of the node
  • __meta_dockerswarm_node_address: the address of the node
  • __meta_dockerswarm_node_availability: the availability of the node
  • __meta_dockerswarm_node_label_<labelname>: each label of the node
  • __meta_dockerswarm_node_platform_architecture: the architecture of the node
  • __meta_dockerswarm_node_platform_os: the operating system of the node
  • __meta_dockerswarm_node_role: the role of the node
  • __meta_dockerswarm_node_status: the status of the node

The __meta_dockerswarm_network_* meta labels are not populated for ports which are published with mode=host.

nodes

The nodes role is used to discover Swarm nodes.

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> ]
  7. # TLS configuration.
  8. tls_config:
  9.   [ <tls_config> ]
  11. # Role of the targets to retrieve. Must be `services`, `tasks`, or `nodes`.
  12. role: <string>
  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. # Optional filters to limit the discovery process to a subset of available
  19. # resources.
  20. # The available filters are listed in the upstream documentation:
  21. # Services: https://docs.docker.com/engine/api/v1.40/#operation/ServiceList
  22. # Tasks: https://docs.docker.com/engine/api/v1.40/#operation/TaskList
  23. # Nodes: https://docs.docker.com/engine/api/v1.40/#operation/NodeList
  24. [ filters:
  25.   [ - name: <string>
  26.       values: <string>, [...] ]
  28. # The time after which the droplets are refreshed.
  29. [ refresh_interval: <duration> | default = 60s ]
  31. # Authentication information used to authenticate to the Docker daemon.
  32. # Note that `basic_auth`, `bearer_token` and `bearer_token_file` options are
  33. # mutually exclusive.
  34. # password and password_file are mutually exclusive.
  36. # Optional HTTP basic authentication information.
  37. basic_auth:
  38.   [ username: <string> ]
  39.   [ password: <secret> ]
  40.   [ password_file: <string> ]
  42. # Optional bearer token authentication information.
  43. [ bearer_token: <secret> ]
  45. # Optional bearer token file authentication information.
  46. [ bearer_token_file: <filename> ]

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 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
  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, or AAAA.
  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 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_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_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_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/2.23/APIReference/API_DescribeInstances.html
  29. # Filter API documentation: https://docs.aws.amazon.com/AWSEC2/2.23/APIReference/API_Filter.html
  30. filters:
  31.   [ - name: <string>
  32.       values: <string>, [...] ]

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_id: the hypervisor node’s ID.
  • __meta_openstack_hypervisor_name: the hypervisor node’s name.
  • __meta_openstack_hypervisor_state: the hypervisor node’s state.
  • __meta_openstack_hypervisor_status: the hypervisor node’s status.
  • __meta_openstack_hypervisor_type: the hypervisor node’s type.

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

<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 json [ { "targets": [ "<host>", ... ], "labels": { "<labelname>": "<labelvalue>", ... } }, ... ]

YAML yaml - targets: [ - '<host>' ] labels: [ <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_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/2.23/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_image_description: the description of the server image
  • __meta_hetzner_hcloud_datacenter_location: the location of the server
  • __meta_hetzner_hcloud_datacenter_location_network_zone: the network zone of the server
  • __meta_hetzner_hcloud_server_type: the type of the server
  • __meta_hetzner_hcloud_cpu_cores: the CPU cores count of the server
  • __meta_hetzner_hcloud_cpu_type: the CPU type of the server (shared or dedicated)
  • __meta_hetzner_hcloud_memory_size_gb: the amount of memory of the server (in GB)
  • __meta_hetzner_hcloud_disk_size_gb: the disk size of the server (in GB)
  • __meta_hetzner_hcloud_private_ipv4_<networkname>: the private ipv4 address of the server within a given network
  • __meta_hetzner_hcloud_label_<labelname>: each label of the server

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`, `bearer_token` and `bearer_token_file` 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 bearer token authentication information, required when role is hcloud
  18. # Role robot does not support bearer token authentication.
  19. [ bearer_token: <secret> ]
  21. # Optional bearer token file authentication information.
  22. [ bearer_token_file: <filename> ]
  24. # Optional proxy URL.
  25. [ proxy_url: <string> ]
  27. # TLS configuration.
  28. tls_config:
  29.   [ <tls_config> ]
  31. # The port to scrape metrics from.
  32. [ port: <int> | default = 80 ]
  34. # The time after which the servers are refreshed.
  35. [ 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_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_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_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>: truefor 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_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.
  • 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.

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_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, service, pod, node, or ingress.
  10. role: <string>
  12. # Optional authentication information used to authenticate to the API server.
  13. # Note that `basic_auth`, `bearer_token` and `bearer_token_file` options are
  14. # mutually exclusive.
  15. # password and password_file are mutually exclusive.
  17. # Optional HTTP basic authentication information.
  18. basic_auth:
  19.   [ username: <string> ]
  20.   [ password: <secret> ]
  21.   [ password_file: <string> ]
  23. # Optional bearer token authentication information.
  24. [ bearer_token: <secret> ]
  26. # Optional bearer token file authentication information.
  27. [ bearer_token_file: <filename> ]
  29. # Optional proxy URL.
  30. [ proxy_url: <string> ]
  32. # TLS configuration.
  33. tls_config:
  34.   [ <tls_config> ]
  36. # Optional namespace discovery. If omitted, all namespaces are used.
  37. namespaces:
  38.   names:
  39.     [ - <string> ]
  41. # Optional label and field selectors to limit the discovery process to a subset of available resources. 
  42. # See https://kubernetes.io/docs/concepts/overview/working-with-objects/field-selectors/
  43. # and https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ to learn more about the possible 
  44. # filters that can be used. Endpoints role supports pod, service and endpoints selectors, other roles
  45. # only support selectors matching the role itself (e.g. node role can only contain node selectors).
  47. # Note: When making decision about using field/label selector make sure that this 
  48. # is the best approach - it will prevent Prometheus from reusing single list/watch
  49. # for all scrape configs. This might result in a bigger load on the Kubernetes API,
  50. # because per each selector combination there will be additional LIST/WATCH. On the other hand,
  51. # if you just want to monitor small subset of pods in large cluster it's recommended to use selectors.
  52. # Decision, if selectors should be used or not depends on the particular situation.
  53. [ selectors:
  54.   [ - role: <string>
  55.     [ label: <string> ]
  56.     [ field: <string> ] ]]

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.

<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. # Sets the `Authorization` header on every request with
  29. # the configured bearer token. It is mutually exclusive with `bearer_token_file` and other authentication mechanisms.
  30. # NOTE: The current version of DC/OS marathon (v1.11.0) does not support standard Bearer token authentication. Use `auth_token` instead.
  31. [ bearer_token: <string> ]
  33. # Sets the `Authorization` header on every request with the bearer token
  34. # read from the configured file. It is mutually exclusive with `bearer_token` and other authentication mechanisms.
  35. # NOTE: The current version of DC/OS marathon (v1.11.0) does not support standard Bearer token authentication. Use `auth_token_file` instead.
  36. [ bearer_token_file: <filename> ]
  38. # TLS configuration for connecting to marathon servers
  39. tls_config:
  40.   [ <tls_config> ]
  42. # Optional proxy URL.
  43. [ proxy_url: <string> ]

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 ]

<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. # Sets the `Authorization` header on every request with
  13. # the configured bearer token. It is mutually exclusive with `bearer_token_file`.
  14. [ bearer_token: <string> ]
  16. # Sets the `Authorization` header on every request with the bearer token
  17. # read from the configured file. It is mutually exclusive with `bearer_token`.
  18. [ bearer_token_file: <filename> ]
  20. # Configures the scrape request's TLS settings.
  21. tls_config:
  22.   [ <tls_config> ]
  24. # Optional proxy URL.
  25. [ proxy_url: <string> ]
  27. # Refresh interval to re-read the app instance list.
  28. [ 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.

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

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.
  • keep: Drop targets for which regex does not match the concatenated source_labels.
  • drop: Drop targets for which regex matches the concatenated source_labels.
  • hashmod: Set target_label to the modulus of a hash of the concatenated source_labels.
  • labelmap: Match regex against all label names. Then copy the values of the matching labels to label names given by replacement with match group references (${1}, ${2}, …) in replacement substituted by their value.
  • labeldrop: Match regex against all label names. Any label that matches will be removed from the set of labels.
  • labelkeep: Match regex against all label names. Any label that does not match will be removed from the set of labels.

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 = v1 ]
  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. # Sets the `Authorization` header on every request with
  22. # the configured bearer token. It is mutually exclusive with `bearer_token_file`.
  23. [ bearer_token: <string> ]
  25. # Sets the `Authorization` header on every request with the bearer token
  26. # read from the configured file. It is mutually exclusive with `bearer_token`.
  27. [ bearer_token_file: <filename> ]
  29. # Configures the scrape request's TLS settings.
  30. tls_config:
  31.   [ <tls_config> ]
  33. # Optional proxy URL.
  34. [ proxy_url: <string> ]
  36. # List of Azure service discovery configurations.
  37. azure_sd_configs:
  38.   [ - <azure_sd_config> ... ]
  40. # List of Consul service discovery configurations.
  41. consul_sd_configs:
  42.   [ - <consul_sd_config> ... ]
  44. # List of DNS service discovery configurations.
  45. dns_sd_configs:
  46.   [ - <dns_sd_config> ... ]
  48. # List of EC2 service discovery configurations.
  49. ec2_sd_configs:
  50.   [ - <ec2_sd_config> ... ]
  52. # List of Eureka service discovery configurations.
  53. eureka_sd_configs:
  54.   [ - <eureka_sd_config> ... ]
  56. # List of file service discovery configurations.
  57. file_sd_configs:
  58.   [ - <file_sd_config> ... ]
  60. # List of DigitalOcean service discovery configurations.
  61. digitalocean_sd_configs:
  62.   [ - <digitalocean_sd_config> ... ]
  64. # List of Docker Swarm service discovery configurations.
  65. dockerswarm_sd_configs:
  66.   [ - <dockerswarm_sd_config> ... ]
  68. # List of GCE service discovery configurations.
  69. gce_sd_configs:
  70.   [ - <gce_sd_config> ... ]
  72. # List of Hetzner service discovery configurations.
  73. hetzner_sd_configs:
  74.   [ - <hetzner_sd_config> ... ]
  76. # List of Kubernetes service discovery configurations.
  77. kubernetes_sd_configs:
  78.   [ - <kubernetes_sd_config> ... ]
  80. # List of Marathon service discovery configurations.
  81. marathon_sd_configs:
  82.   [ - <marathon_sd_config> ... ]
  84. # List of AirBnB's Nerve service discovery configurations.
  85. nerve_sd_configs:
  86.   [ - <nerve_sd_config> ... ]
  88. # List of OpenStack service discovery configurations.
  89. openstack_sd_configs:
  90.   [ - <openstack_sd_config> ... ]
  92. # List of Zookeeper Serverset service discovery configurations.
  93. serverset_sd_configs:
  94.   [ - <serverset_sd_config> ... ]
  96. # List of Triton service discovery configurations.
  97. triton_sd_configs:
  98.   [ - <triton_sd_config> ... ]
  100. # List of labeled statically configured Alertmanagers.
  101. static_configs:
  102.   [ - <static_config> ... ]
  104. # List of Alertmanager relabel configurations.
  105. relabel_configs:
  106.   [ - <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. # List of remote write relabel configurations.
  8. write_relabel_configs:
  9.   [ - <relabel_config> ... ]
  11. # Name of the remote write config, which if specified must be unique among remote write configs. 
  12. # The name will be used in metrics and logging in place of a generated value to help users distinguish between
  13. # remote write configs.
  14. [ name: <string> ]
  16. # Sets the `Authorization` header on every remote write request with the
  17. # configured username and password.
  18. # password and password_file are mutually exclusive.
  19. basic_auth:
  20.   [ username: <string> ]
  21.   [ password: <secret> ]
  22.   [ password_file: <string> ]
  24. # Sets the `Authorization` header on every remote write request with
  25. # the configured bearer token. It is mutually exclusive with `bearer_token_file`.
  26. [ bearer_token: <string> ]
  28. # Sets the `Authorization` header on every remote write request with the bearer token
  29. # read from the configured file. It is mutually exclusive with `bearer_token`.
  30. [ bearer_token_file: <filename> ]
  32. # Configures the remote write request's TLS settings.
  33. tls_config:
  34.   [ <tls_config> ]
  36. # Optional proxy URL.
  37. [ proxy_url: <string> ]
  39. # Configures the queue used to write to remote storage.
  40. queue_config:
  41.   # Number of samples to buffer per shard before we block reading of more
  42.   # samples from the WAL. It is recommended to have enough capacity in each
  43.   # shard to buffer several requests to keep throughput up while processing
  44.   # occasional slow remote requests.
  45.   [ capacity: <int> | default = 2500 ]
  46.   # Maximum number of shards, i.e. amount of concurrency.
  47.   [ max_shards: <int> | default = 200 ]
  48.   # Minimum number of shards, i.e. amount of concurrency.
  49.   [ min_shards: <int> | default = 1 ]
  50.   # Maximum number of samples per send.
  51.   [ max_samples_per_send: <int> | default = 500]
  52.   # Maximum time a sample will wait in buffer.
  53.   [ batch_send_deadline: <duration> | default = 5s ]
  54.   # Initial retry delay. Gets doubled for every retry.
  55.   [ min_backoff: <duration> | default = 30ms ]
  56.   # Maximum retry delay.
  57.   [ max_backoff: <duration> | default = 100ms ]
  58. # Configures the sending of series metadata to remote storage.
  59. # Metadata configuration is subject to change at any point
  60. # or be removed in future releases.
  61. metadata_config:
  62.   # Whether metric metadata is sent to remote storage or not.
  63.   [ send: <boolean> | default = true ]
  64.   # How frequently metric metadata is sent to remote storage.
  65.   [ send_interval: <duration> | default = 1m ]

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. # Whether reads should be made for queries for time ranges that
  18. # the local storage should have complete data for.
  19. [ read_recent: <boolean> | default = false ]
  21. # Sets the `Authorization` header on every remote read request with the
  22. # configured username and password.
  23. # password and password_file are mutually exclusive.
  24. basic_auth:
  25.   [ username: <string> ]
  26.   [ password: <secret> ]
  27.   [ password_file: <string> ]
  29. # Sets the `Authorization` header on every remote read request with
  30. # the configured bearer token. It is mutually exclusive with `bearer_token_file`.
  31. [ bearer_token: <string> ]
  33. # Sets the `Authorization` header on every remote read request with the bearer token
  34. # read from the configured file. It is mutually exclusive with `bearer_token`.
  35. [ bearer_token_file: <filename> ]
  37. # Configures the remote read request's TLS settings.
  38. tls_config:
  39.   [ <tls_config> ]
  41. # Optional proxy URL.
  42. [ proxy_url: <string> ]

There is a list of integrations with this feature.