Instrument and send data

Grafana Alloy

Reference

Components

prometheus

prometheus.operator.probes

General availability (GA) Open source Grafana Cloud

`prometheus.operator.probes`

prometheus.operator.probes discovers Probe resources in your Kubernetes cluster and scrapes the targets they reference. This component performs three main functions:

Discover Probe resources from your Kubernetes cluster.
Discover targets or ingresses that match those Probes.
Scrape metrics from those endpoints, and forward them to a receiver.

The default configuration assumes Alloy is running inside a Kubernetes cluster, and uses the in-cluster configuration to access the Kubernetes API. You can run it from outside the cluster by supplying connection info in the client block, but network level access to pods is required to scrape metrics from them.

Probes may reference secrets for authenticating to targets to scrape them. In these cases, the secrets are loaded and refreshed only when the Probe is updated or when this component refreshes its’ internal state, which happens on a 5-minute refresh cycle.

Usage

prometheus.operator.probes "<LABEL>" {
    forward_to = <RECEIVER_LIST>
}

Arguments

You can use the following arguments with prometheus.operator.probes:

Name	Type	Description	Default	Required
`forward_to`	`list(MetricsReceiver)`	List of receivers to send scraped metrics to.		yes
`informer_sync_timeout`	`duration`	Timeout for initial sync of Probe resources.	`"1m"`	no
`namespaces`	`list(string)`	List of namespaces to search for Probe resources. If not specified, all namespaces are searched.		no

Blocks

You can use the following blocks with prometheus.operator.probes:

Name	Description	Required
`client`	Configures Kubernetes client used to find Probes.	no
`client` > `authorization`	Configure generic authorization to the Kubernetes API.	no
`client` > `basic_auth`	Configure basic authentication to the Kubernetes API.	no
`client` > `oauth2`	Configure OAuth 2.0 for authenticating to the Kubernetes API.	no
`client` > `tls_config`	Configure TLS settings for connecting to the Kubernetes API.	no
`client` > `oauth2` > `tls_config`	Configure TLS settings for connecting to the Kubernetes API.	no
`clustering`	Configure the component for when Alloy is running in clustered mode.	no
`rule`	Relabeling rules to apply to discovered targets.	no
`scrape`	Default scrape configuration to apply to discovered targets.	no
`selector`	Label selector for which Probes to discover.	no
`selector` > `match_expression`	Label selector expression for which Probes to discover.	no

`client`

The client block configures the Kubernetes client used to discover Probes. If the client block isn’t provided, the default in-cluster configuration with the service account of the running Alloy Pod is used.

The following arguments are supported:

Name	Type	Description	Default	Required
`api_server`	`string`	URL of the Kubernetes API server.		no
`bearer_token_file`	`string`	File containing a bearer token to authenticate with.		no
`bearer_token`	`secret`	Bearer token to authenticate with.		no
`enable_http2`	`bool`	Whether HTTP2 is supported for requests.	`true`	no
`follow_redirects`	`bool`	Whether redirects returned by the server should be followed.	`true`	no
`http_headers`	`map(list(secret))`	Custom HTTP headers to be sent along with each request. The map key is the header name.		no
`kubeconfig_file`	`string`	Path of the `kubeconfig` file to use for connecting to Kubernetes.		no
`no_proxy`	`string`	Comma-separated list of IP addresses, CIDR notations, and domain names to exclude from proxying.		no
`proxy_connect_header`	`map(list(secret))`	Specifies headers to send to proxies during CONNECT requests.		no
`proxy_from_environment`	`bool`	Use the proxy URL indicated by environment variables.	`false`	no
`proxy_url`	`string`	HTTP proxy to send requests through.		no

At most, one of the following can be provided:

authorization block
basic_auth block
bearer_token_file argument
bearer_token argument
oauth2 block

no_proxy can contain IPs, CIDR notations, and domain names. IP and domain names can contain port numbers. proxy_url must be configured if no_proxy is configured.

proxy_from_environment uses the environment variables HTTP_PROXY, HTTPS_PROXY, and NO_PROXY (or the lowercase versions thereof). Requests use the proxy from the environment variable matching their scheme, unless excluded by NO_PROXY. proxy_url and no_proxy must not be configured if proxy_from_environment is configured.

proxy_connect_header should only be configured if proxy_url or proxy_from_environment are configured.

`authorization`

Name	Type	Description	Required
`credentials_file`	`string`	File containing the secret value.	no
`credentials`	`secret`	Secret value.	no
`type`	`string`	Authorization type, for example, “Bearer”.	no

credential and credentials_file are mutually exclusive, and only one can be provided inside an authorization block.

Warning
Using credentials_file causes the file to be read on every outgoing request. Use the local.file component with the credentials attribute instead to avoid unnecessary reads.

`basic_auth`

Name	Type	Description	Required
`password_file`	`string`	Path to a file that contains the basic auth password.	no
`password`	`secret`	Basic auth password.	no
`username`	`string`	Basic auth username.	no

When you use password_file, the file is read on every outgoing request that uses basic authentication.

password and password_file are mutually exclusive, and only one can be provided inside a basic_auth block.

Note
High scrape or write rates create repeated file reads when you use password_file. You can use the local.file component to read the password file and provide the content to the password attribute. This avoids repeated file reads because local.file monitors the file and reads when it changes.

prometheus.operator.probes

Usage

Arguments

Blocks

client

authorization

basic_auth

oauth2

`prometheus.operator.probes`

`client`

`authorization`

`basic_auth`

`oauth2`