Prometheus scrape source

Collect metrics via the Prometheus client

Alias

This component was previously called the prometheus source. Make sure to update your Vector configuration to accommodate the name change:

[sources.my_prometheus_scrape_source]
+type = "prometheus_scrape"
-type = "prometheus"

Configuration

Example configurations

{
  "sources": {
    "my_source_id": {
      "type": "prometheus_scrape",
      "endpoints": [
        "http://localhost:9090/metrics"
      ],
      "scrape_interval_secs": 15,
      "instance_tag": "instance",
      "endpoint_tag": "endpoint",
      "honor_labels": null
    }
  }
}

[sources.my_source_id]
type = "prometheus_scrape"
endpoints = [ "http://localhost:9090/metrics" ]
scrape_interval_secs = 15
instance_tag = "instance"
endpoint_tag = "endpoint"

---
sources:
  my_source_id:
    type: prometheus_scrape
    endpoints:
      - http://localhost:9090/metrics
    scrape_interval_secs: 15
    instance_tag: instance
    endpoint_tag: endpoint
    honor_labels: null

{
  "sources": {
    "my_source_id": {
      "type": "prometheus_scrape",
      "endpoints": [
        "http://localhost:9090/metrics"
      ],
      "scrape_interval_secs": 15,
      "instance_tag": "instance",
      "endpoint_tag": "endpoint",
      "honor_labels": null,
      "query": {
        "match[]": [
          "{job=\"somejob\"}",
          "{__name__=~\"job:.*\"}"
        ]
      },
      "proxy": null,
      "tls": null,
      "auth": null
    }
  }
}

[sources.my_source_id]
type = "prometheus_scrape"
endpoints = [ "http://localhost:9090/metrics" ]
scrape_interval_secs = 15
instance_tag = "instance"
endpoint_tag = "endpoint"

  [sources.my_source_id.query]
  "match[]" = [ "{job=\"somejob\"}", "{__name__=~\"job:.*\"}" ]

---
sources:
  my_source_id:
    type: prometheus_scrape
    endpoints:
      - http://localhost:9090/metrics
    scrape_interval_secs: 15
    instance_tag: instance
    endpoint_tag: endpoint
    honor_labels: null
    query:
      "match[]":
        - '{job="somejob"}'
        - '{__name__=~"job:.*"}'
    proxy: null
    tls: null
    auth: null

auth

optional object

Configures the authentication strategy.

auth.password

required string literal

The basic authentication password.

Examples

"${PROMETHEUS_PASSWORD}"

"password"

auth.strategy

required string literal enum

The authentication strategy to use.

Enum options

Option	Description
`basic`	The basic authentication strategy.
`bearer`	The bearer token authentication strategy.

Examples

"basic"

"bearer"

auth.token

required string literal

The token to use for bearer authentication

Examples

"${API_TOKEN}"

"xyz123"

auth.user

required string literal

The basic authentication user name.

Examples

"${PROMETHEUS_USERNAME}"

"username"

endpoint_tag

common optional string literal

The tag name added to each event representing the scraped instance’s endpoint.

Examples

"endpoint"

endpoints

required [string]

Endpoints to scrape metrics from.

Warning

You must explicitly add the path to your endpoints. Vector will not automatically add /metrics.

Array string literal

Examples

[
  "http://localhost:9090/metrics"
]

Controls how tag conflicts are handled if the scraped source has tags that Vector would add. If true, Vector will not add the new tag if the scraped metric has the tag already. If false, Vector will rename the conflicting tag by adding exported_ to it. This matches Prometheus’s honor_labels configuration.

default: false

instance_tag

common optional string literal

The tag name added to each event representing the scraped instance’s host:port.

Examples

"instance"

proxy

optional object

Configures an HTTP(S) proxy for Vector to use. By default, the globally configured proxy is used.

proxy.enabled

optional bool

If false the proxy will be disabled.

default: true

proxy.http

optional string literal

The URL to proxy HTTP requests through.

Examples

"http://foo.bar:3128"

proxy.https

optional string literal

The URL to proxy HTTPS requests through.

Examples

"http://foo.bar:3128"

proxy.no_proxy

optional [string]

A list of hosts to avoid proxying. Allowed patterns here include:

Pattern	Example match
Domain names	`example.com` matches requests to `example.com`
Wildcard domains	`.example.com` matches requests to `example.com` and its subdomains
IP addresses	`127.0.0.1` matches requests to 127.0.0.1
CIDR blocks	`192.168.0.0./16` matches requests to any IP addresses in this range
Splat	`*` matches all hosts

query

optional object

Custom parameters for the scrape request query string. One or more values for the same parameter key can be provided. The parameters provided in this option are appended to any parameters manually provided in the endpoints option. This option is especially useful when scraping the /federate endpoint.

query.*

optional [string]

Any query key

Examples

[
  "{job=\"somejob\"}",
  "{__name__=~\"job:.*\"}"
]

scrape_interval_secs

common optional uint

The interval between scrapes, in seconds.

default: 15 (seconds)

tls

optional object

Configures the TLS options for incoming/outgoing connections.

tls.alpn_protocols

optional [string]

Sets the list of supported ALPN protocols.

Declare the supported ALPN protocols, which are used during negotiation with peer. Prioritized in the order they are defined.

tls.ca_file

optional string literal

Absolute path to an additional CA certificate file.

The certificate must be in the DER or PEM (X.509) format. Additionally, the certificate can be provided as an inline string in PEM format.

Examples

"/path/to/certificate_authority.crt"

tls.crt_file

common optional string literal

Absolute path to a certificate file used to identify this server.

The certificate must be in DER, PEM (X.509), or PKCS#12 format. Additionally, the certificate can be provided as an inline string in PEM format.

If this is set, and is not a PKCS#12 archive, key_file must also be set.

Examples

"/path/to/host_certificate.crt"

tls.key_file

common optional string literal

Absolute path to a private key file used to identify this server.

The key must be in DER or PEM (PKCS#8) format. Additionally, the key can be provided as an inline string in PEM format.

Examples

"/path/to/host_certificate.key"

tls.key_pass

optional string literal

Passphrase used to unlock the encrypted key file.

This has no effect unless key_file is set.

Examples

"${KEY_PASS_ENV_VAR}"

"PassWord1"

tls.verify_certificate

optional bool

Enables certificate verification.

If enabled, certificates must be valid in terms of not being expired, as well as being issued by a trusted issuer. This verification operates in a hierarchical manner, checking that not only the leaf certificate (the certificate presented by the client/server) is valid, but also that the issuer of that certificate is valid, and so on until reaching a root certificate.

Relevant for both incoming and outgoing connections.

Do NOT set this to false unless you understand the risks of not verifying the validity of certificates.

default: true

tls.verify_hostname

optional bool

Enables hostname verification.

If enabled, the hostname used to connect to the remote host must be present in the TLS certificate presented by the remote host, either as the Common Name or as an entry in the Subject Alternative Name extension.

Only relevant for outgoing connections.

Do NOT set this to false unless you understand the risks of not verifying the remote hostname.

default: true

Environment variables

HTTPS_PROXY

common optional string literal

The global URL to proxy HTTPS requests through.

If another HTTPS proxy is set in the configuration file or at a component level, this one will be overridden.

The lowercase variant has priority over the uppercase one.

Examples

http://foo.bar:3128

HTTP_PROXY

common optional string literal

The global URL to proxy HTTP requests through.

If another HTTP proxy is set in the configuration file or at a component level, this one will be overridden.

The lowercase variant has priority over the uppercase one.

Examples

http://foo.bar:3128

NO_PROXY

common optional string literal

List of hosts to avoid proxying globally.

Allowed patterns here include:

Pattern	Example match
Domain names	`example.com` matches requests to `example.com`
Wildcard domains	`.example.come` matches requests to `example.com` and its subdomains
IP addresses	`127.0.0.1` matches requests to `127.0.0.1`
CIDR blocks	`192.168.0.0./16` matches requests to any IP addresses in this range
Splat	`*` matches all hosts

If another no_proxy value is set in the configuration file or at a component level, this one is overridden.

The lowercase variant has priority over the uppercase one.

Examples

localhost,.example.com,192.168.0.0./16

http_proxy

common optional string literal

The global URL to proxy HTTP requests through.

If another HTTP proxy is set in the configuration file or at a component level, this one will be overridden.

The lowercase variant has priority over the uppercase one.

Examples

http://foo.bar:3128

https_proxy

common optional string literal

The global URL to proxy HTTPS requests through.

If another HTTPS proxy is set in the configuration file or at a component level, this one will be overridden.

The lowercase variant has priority over the uppercase one.

Examples

http://foo.bar:3128

no_proxy

common optional string literal

List of hosts to avoid proxying globally.

Allowed patterns here include:

Pattern	Example match
Domain names	`example.com` matches requests to `example.com`
Wildcard domains	`.example.come` matches requests to `example.com` and its subdomains
IP addresses	`127.0.0.1` matches requests to `127.0.0.1`
CIDR blocks	`192.168.0.0./16` matches requests to any IP addresses in this range
Splat	`*` matches all hosts

If another no_proxy value is set in the configuration file or at a component level, this one is overridden.

The lowercase variant has priority over the uppercase one.

Examples

localhost,.example.com,192.168.0.0./16

Outputs

<component_id>

Default output stream of the component. Use this component’s ID as an input to downstream transforms and sinks.

Output Data

Metrics

counter

A single value that can be incremented or reset to a zero value but not decremented.

* optional

Any tags present on the metric.

endpoint optional

Any endpoint of the scraped instance. Only present if endpoint_tag is set.

instance optional

The host:port of the scraped instance. Only present if instance_tag is set.

gauge

A gauge represents a point-in-time value that can increase and decrease. Vector’s internal gauge type represents changes to that value. Gauges should be used to track fluctuations in values, like current memory or CPU usage.

* optional

Any tags present on the metric.

endpoint optional

Any endpoint of the scraped instance. Only present if endpoint_tag is set.

instance optional

The host:port of the scraped instance. Only present if instance_tag is set.

histogram

gauge

Also called a timer. A histogram samples observations (usually things like request durations or response sizes) and counts them in configurable buckets. It also provides a sum of all observed values.

* optional

Any tags present on the metric.

endpoint optional

Any endpoint of the scraped instance. Only present if endpoint_tag is set.

instance optional

The host:port of the scraped instance. Only present if instance_tag is set.

summary

gauge

Similar to a histogram, a summary samples observations (usually things like request durations and response sizes). While it also provides a total count of observations and a sum of all observed values, it calculates configurable quantiles over a sliding time window.

* optional

Any tags present on the metric.

endpoint optional

Any endpoint of the scraped instance. Only present if endpoint_tag is set.

instance optional

The host:port of the scraped instance. Only present if instance_tag is set.

Telemetry

Metrics

link

component_discarded_events_total

counter

The number of events dropped by this component.

component_id

The Vector component ID.

component_kind

The Vector component kind.

component_name

Deprecated, use component_id instead. The value is the same as component_id.

component_type

The Vector component type.

host optional

The hostname of the system Vector is running on.

pid optional

The process ID of the Vector instance.

component_errors_total

counter

The total number of errors encountered by this component.

component_id

The Vector component ID.

component_kind

The Vector component kind.

component_name

Deprecated, use component_id instead. The value is the same as component_id.

component_type

The Vector component type.

error_type

The type of the error

host optional

The hostname of the system Vector is running on.

pid optional

The process ID of the Vector instance.

stage

The stage within the component at which the error occurred.

component_received_bytes_total

counter

The number of raw bytes accepted by this component from source origins.

component_id

The Vector component ID.

component_kind

The Vector component kind.

component_name

Deprecated, use component_id instead. The value is the same as component_id.

component_type

The Vector component type.

container_name optional

The name of the container from which the data originated.

file optional

The file from which the data originated.

host optional

The hostname of the system Vector is running on.

mode optional

The connection mode used by the component.

peer_addr optional

The IP from which the data originated.

peer_path optional

The pathname from which the data originated.

pid optional

The process ID of the Vector instance.

pod_name optional

The name of the pod from which the data originated.

uri optional

The sanitized URI from which the data originated.

component_received_event_bytes_total

counter

The number of event bytes accepted by this component either from tagged origins like file and uri, or cumulatively from other origins.

component_id

The Vector component ID.

component_kind

The Vector component kind.

component_name

Deprecated, use component_id instead. The value is the same as component_id.

component_type

The Vector component type.

container_name optional

The name of the container from which the data originated.

file optional

The file from which the data originated.

host optional

The hostname of the system Vector is running on.

mode optional

The connection mode used by the component.

peer_addr optional

The IP from which the data originated.

peer_path optional

The pathname from which the data originated.

pid optional

The process ID of the Vector instance.

pod_name optional

The name of the pod from which the data originated.

uri optional

The sanitized URI from which the data originated.

component_received_events_total

counter

The number of events accepted by this component either from tagged origins like file and uri, or cumulatively from other origins.

component_id

The Vector component ID.

component_kind

The Vector component kind.

component_name

Deprecated, use component_id instead. The value is the same as component_id.

component_type

The Vector component type.

container_name optional

The name of the container from which the data originated.

file optional

The file from which the data originated.

host optional

The hostname of the system Vector is running on.

mode optional

The connection mode used by the component.

peer_addr optional

The IP from which the data originated.

peer_path optional

The pathname from which the data originated.

pid optional

The process ID of the Vector instance.

pod_name optional

The name of the pod from which the data originated.

uri optional

The sanitized URI from which the data originated.

component_sent_event_bytes_total

counter

The total number of event bytes emitted by this component.

component_id

The Vector component ID.

component_kind

The Vector component kind.

component_name

Deprecated, use component_id instead. The value is the same as component_id.

component_type

The Vector component type.

host optional

The hostname of the system Vector is running on.

output optional

The specific output of the component.

pid optional

The process ID of the Vector instance.

component_sent_events_total

counter

The total number of events emitted by this component.

component_id

The Vector component ID.

component_kind

The Vector component kind.

component_name

Deprecated, use component_id instead. The value is the same as component_id.

component_type

The Vector component type.

host optional

The hostname of the system Vector is running on.

output optional

The specific output of the component.

pid optional

The process ID of the Vector instance.

events_in_total

counter

The number of events accepted by this component either from tagged origins like file and uri, or cumulatively from other origins. This metric is deprecated and will be removed in a future version. Use component_received_events_total instead.

component_id

The Vector component ID.

component_kind

The Vector component kind.

component_name

Deprecated, use component_id instead. The value is the same as component_id.

component_type

The Vector component type.

container_name optional

The name of the container from which the data originated.

file optional

The file from which the data originated.

host optional

The hostname of the system Vector is running on.

mode optional

The connection mode used by the component.

peer_addr optional

The IP from which the data originated.

peer_path optional

The pathname from which the data originated.

pid optional

The process ID of the Vector instance.

pod_name optional

The name of the pod from which the data originated.

uri optional

The sanitized URI from which the data originated.

events_out_total

counter

The total number of events emitted by this component. This metric is deprecated and will be removed in a future version. Use component_sent_events_total instead.

component_id

The Vector component ID.

component_kind

The Vector component kind.

component_name

Deprecated, use component_id instead. The value is the same as component_id.

component_type

The Vector component type.

host optional

The hostname of the system Vector is running on.

output optional

The specific output of the component.

pid optional

The process ID of the Vector instance.

http_error_response_total

counter

The total number of HTTP error responses for this component.

host optional

The hostname of the system Vector is running on.

pid optional

The process ID of the Vector instance.

http_request_errors_total

counter

The total number of HTTP request errors for this component.

host optional

The hostname of the system Vector is running on.

pid optional

The process ID of the Vector instance.

parse_errors_total

counter

The total number of errors parsing metrics for this component.

host optional

The hostname of the system Vector is running on.

pid optional

The process ID of the Vector instance.

processed_bytes_total

counter

The number of bytes processed by the component.

component_id

The Vector component ID.

component_kind

The Vector component kind.

component_name

Deprecated, use component_id instead. The value is the same as component_id.

component_type

The Vector component type.

container_name optional

The name of the container from which the bytes originate.

file optional

The file from which the bytes originate.

host optional

The hostname of the system Vector is running on.

mode optional

The connection mode used by the component.

peer_addr optional

The IP from which the bytes originate.

peer_path optional

The pathname from which the bytes originate.

pid optional

The process ID of the Vector instance.

pod_name optional

The name of the pod from which the bytes originate.

uri optional

The sanitized URI from which the bytes originate.

processed_events_total

counter

The total number of events processed by this component. This metric is deprecated in place of using component_received_events_total and component_sent_events_total metrics.

component_id

The Vector component ID.

component_kind

The Vector component kind.

component_name

Deprecated, use component_id instead. The value is the same as component_id.

component_type

The Vector component type.

host optional

The hostname of the system Vector is running on.

pid optional

The process ID of the Vector instance.

request_duration_seconds

histogram

The total request duration in seconds.

host optional

The hostname of the system Vector is running on.

pid optional

The process ID of the Vector instance.

requests_completed_total

counter

The total number of requests completed by this component.

component_id

The Vector component ID.

component_kind

The Vector component kind.

component_name

Deprecated, use component_id instead. The value is the same as component_id.

component_type

The Vector component type.

host optional

The hostname of the system Vector is running on.

pid optional

The process ID of the Vector instance.

source_lag_time_seconds

histogram

The difference between the timestamp recorded in each event and the time when it was ingested, expressed as fractional seconds.

component_id

The Vector component ID.

component_kind

The Vector component kind.

component_name

Deprecated, use component_id instead. The value is the same as component_id.

component_type

The Vector component type.

host optional

The hostname of the system Vector is running on.

pid optional

The process ID of the Vector instance.

How it works

Context

By default, the prometheus_scrape source augments events with helpful context keys.

Duplicate tag names

Multiple tags with the same name are invalid within Prometheus. Prometheus itself will reject a metric with duplicate tags. Vector will accept the metric, but will only take the last value for each tag name specified.

State

This component is stateless, meaning its behavior is consistent across each input.

Transport Layer Security (TLS)

Vector uses OpenSSL for TLS protocols. You can adjust TLS behavior via the tls.* options.