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.write receives performance profiles from other components and forwards them to a series of user-supplied endpoints using Pyroscope’ Push API.

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

Usage for Grafana Agent flow mode

pyroscope.write "LABEL" {
  endpoint {




The following arguments are supported:

external_labelsmap(string)Labels to add to profiles sent over the


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

endpointendpointLocation to send profiles
endpoint > basic_authbasic_authConfigure basic_auth for authenticating to the
endpoint > authorizationauthorizationConfigure generic authorization to the
endpoint > oauth2oauth2Configure OAuth2 for authenticating to the
endpoint > oauth2 > tls_configtls_configConfigure TLS settings for connecting to the
endpoint > tls_configtls_configConfigure TLS settings for connecting to the

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

endpoint block

The endpoint block describes a single location to send profiles to. Multiple endpoint blocks can be provided to send profiles to multiple locations.

The following arguments are supported:

urlstringFull URL to send metrics to.yes
namestringOptional name to identify the endpoint in
remote_timeoutdurationTimeout for requests made to the URL."10s"no
headersmap(string)Extra headers to deliver with the
min_backoff_perioddurationInitial backoff time between retries."500ms"no
max_backoff_perioddurationMaximum backoff time between retries."5m"no
max_backoff_retriesintMaximum number of retries. 0 to retry infinitely.10no
bearer_tokensecretBearer token to authenticate
bearer_token_filestringFile containing a bearer token to authenticate
proxy_urlstringHTTP proxy to proxy requests
follow_redirectsboolWhether redirects returned by the server should be followed.trueno
enable_http2boolWhether HTTP2 is supported for requests.trueno

At most one of the following can be provided:

When multiple endpoint blocks are provided, profiles are concurrently forwarded to all configured locations.

basic_auth block

usernamestringBasic auth
passwordsecretBasic auth
password_filestringFile containing the basic auth

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

authorization block

typestringAuthorization type, for example, “Bearer”.no
credentials_filestringFile containing the secret

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

oauth2 block

client_idstringOAuth2 client
client_secretsecretOAuth2 client
client_secret_filestringFile containing the OAuth2 client
scopeslist(string)List of scopes to authenticate
token_urlstringURL to fetch the token
endpoint_paramsmap(string)Optional parameters to append to the token
proxy_urlstringOptional proxy URL for OAuth2

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

The oauth2 block may also contain its own separate tls_config sub-block.

tls_config block

ca_pemstringCA PEM-encoded text to validate the server
ca_filestringCA certificate to validate the server
cert_pemstringCertificate PEM-encoded text for client
cert_filestringCertificate file for client
key_pemsecretKey PEM-encoded text for client
key_filestringKey file for client
server_namestringServerName extension to indicate the name of the
insecure_skip_verifyboolDisables validation of the server
min_versionstringMinimum acceptable TLS

The following pairs of arguments are mutually exclusive and cannot 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)

Exported fields

The following fields are exported and can be referenced by other components:

receiverreceiverA value that other components can use to send profiles to.

Component health

pyroscope.write is only reported as unhealthy if given an invalid configuration. In those cases, exported fields are kept at their last healthy values.

Debug information

pyroscope.write does not expose any component-specific debug information.


pyroscope.write "staging" {
  // Send metrics to a locally running Pyroscope instance.
  endpoint {
    url = "http://pyroscope:4100"
    headers = {
      "X-Scope-OrgID" = "squad-1",
  external_labels = {
    "env" = "staging",

pyroscope.scrape "default" {
  targets = [
    {"__address__" = "pyroscope:4100", "service_name"="pyroscope"},
    {"__address__" = "agent:12345", "service_name"="agent"},
  forward_to = [pyroscope.write.staging.receiver]