Caution
Grafana Alloy is the new name for our distribution of the OTel collector. Grafana Agent has been deprecated and is in Long-Term Support (LTS) through October 31, 2025. Grafana Agent will reach an End-of-Life (EOL) on November 1, 2025. Read more about why we recommend migrating to Grafana Alloy.

Important: This documentation is about an older version. It's relevant only to the release noted, many of the features and functions have been updated or replaced. Please view the current version.

pyroscope.scrape

Beta

pyroscope.scrape

BETA: This is a beta component. Beta components are subject to breaking changes, and may be replaced with equivalent functionality that cover the same use case.

pyroscope.scrape configures a pprof scraping job for a given set of targets. The scraped performance profiles are forwarded to the list of receivers passed in forward_to.

Multiple pyroscope.scrape components can be specified by giving them different labels.

Usage

pyroscope.scrape "LABEL" {
  targets    = TARGET_LIST
  forward_to = RECEIVER_LIST
}

Arguments

The component configures and starts a new scrape job to scrape all of the input targets. Multiple scrape jobs can be spawned for a single input target when scraping multiple profile types.

The list of arguments that can be used to configure the block is presented below.

The scrape job name defaults to the component’s unique identifier.

Any omitted fields take on their default values. If conflicting attributes are being passed (e.g., defining both a BearerToken and BearerTokenFile or configuring both Basic Authorization and OAuth2 at the same time), the component reports an error.

The following arguments are supported:

Name	Type	Description	Default	Required
`targets`	`list(map(string))`	List of targets to scrape.		yes
`forward_to`	`list(ProfilesReceiver)`	List of receivers to send scraped profiles to.		yes
`job_name`	`string`	The job name to override the job label with.	component name	no
`params`	`map(list(string))`	A set of query parameters with which the target is scraped.		no
`scrape_interval`	`duration`	How frequently to scrape the targets of this scrape config.	`"15s"`	no
`scrape_timeout`	`duration`	The timeout for scraping targets of this config.	`"15s"`	no
`scheme`	`string`	The URL scheme with which to fetch metrics from targets.		no
`bearer_token`	`secret`	Bearer token to authenticate with.		no
`bearer_token_file`	`string`	File containing a bearer token to authenticate with.		no
`proxy_url`	`string`	HTTP proxy to proxy requests through.		no
`follow_redirects`	`bool`	Whether redirects returned by the server should be followed.	`true`	no
`enable_http2`	`bool`	Whether HTTP2 is supported for requests.	`true`	no

At most one of the following can be provided:

bearer_token argument.
bearer_token_file argument.
basic_auth block.
authorization block.
oauth2 block.

Blocks

The following blocks are supported inside the definition of pyroscope.scrape:

Hierarchy	Block	Description	Required
basic_auth	basic_auth	Configure basic_auth for authenticating to targets.	no
authorization	authorization	Configure generic authorization to targets.	no
oauth2	oauth2	Configure OAuth2 for authenticating to targets.	no
oauth2 > tls_config	tls_config	Configure TLS settings for connecting to targets via OAuth2.	no
tls_config	tls_config	Configure TLS settings for connecting to targets.	no
profiling_config	profiling_config	Configure profiling settings for the scrape job.	no
profiling_config > profile.memory	profile.memory	Collect memory profiles.	no
profiling_config > profile.block	profile.block	Collect profiles on blocks.	no
profiling_config > profile.goroutine	profile.goroutine	Collect goroutine profiles.	no
profiling_config > profile.mutex	profile.mutex	Collect mutex profiles.	no
profiling_config > profile.process_cpu	profile.process_cpu	Collect CPU profiles.	no
profiling_config > profile.fgprof	profile.fgprof	Collect fgprof profiles.	no
profiling_config > profile.godeltaprof_memory	profile.godeltaprof_memory	Collect godeltaprof memory profiles.	no
profiling_config > profile.godeltaprof_mutex	profile.godeltaprof_mutex	Collect godeltaprof mutex profiles.	no
profiling_config > profile.godeltaprof_block	profile.godeltaprof_block	Collect godeltaprof block profiles.	no
profiling_config > profile.custom	profile.custom	Collect custom profiles.	no
clustering	clustering	Configure the component for when the Agent is running in clustered mode.	no

The > symbol indicates deeper levels of nesting. For example, oauth2 > tls_config refers to a tls_config block defined inside an oauth2 block.

basic_auth block

Name	Type	Description	Required
`password_file`	`string`	File containing the basic auth password.	no
`password`	`secret`	Basic auth password.	no
`username`	`string`	Basic auth username.	no

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

authorization block

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.

oauth2 block

Name	Type	Description	Required
`client_id`	`string`	OAuth2 client ID.	no
`client_secret_file`	`string`	File containing the OAuth2 client secret.	no
`client_secret`	`secret`	OAuth2 client secret.	no
`endpoint_params`	`map(string)`	Optional parameters to append to the token URL.	no
`proxy_url`	`string`	Optional proxy URL for OAuth2 requests.	no
`scopes`	`list(string)`	List of scopes to authenticate with.	no
`token_url`	`string`	URL to fetch the token from.	no

client_secret and client_secret_file are mutually exclusive, and only one can be provided inside an oauth2 block.

The oauth2 block may also contain a separate tls_config sub-block.

tls_config block

Name	Type	Description	Required
`ca_pem`	`string`	CA PEM-encoded text to validate the server with.	no
`ca_file`	`string`	CA certificate to validate the server with.	no
`cert_pem`	`string`	Certificate PEM-encoded text for client authentication.	no
`cert_file`	`string`	Certificate file for client authentication.	no
`insecure_skip_verify`	`bool`	Disables validation of the server certificate.	no
`key_file`	`string`	Key file for client authentication.	no
`key_pem`	`secret`	Key PEM-encoded text for client authentication.	no
`min_version`	`string`	Minimum acceptable TLS version.	no
`server_name`	`string`	ServerName extension to indicate the name of the server.	no

The following pairs of arguments are mutually exclusive and can’t both be set simultaneously:

ca_pem and ca_file
cert_pem and cert_file
key_pem and key_file

When configuring client authentication, both the client certificate (using cert_pem or cert_file) and the client key (using key_pem or key_file) must be provided.

When min_version is not provided, the minimum acceptable TLS version is inherited from Go’s default minimum version, TLS 1.2. If min_version is provided, it must be set to one of the following strings:

"TLS10" (TLS 1.0)
"TLS11" (TLS 1.1)
"TLS12" (TLS 1.2)
"TLS13" (TLS 1.3)

profiling_config block

The profiling_config block configures the profiling settings when scraping targets.

The block contains the following attributes:

Name	Type	Description	Default	Required
`path_prefix`	`string`	The path prefix to use when scraping targets.		no