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.

Documentation Grafana Alloy Reference Components pyroscope pyroscope.write

pyroscope.write

pyroscope.write receives performance profiles from other components and forwards them to a series of user-supplied endpoints using Pyroscope’ Push API.

You can specify multiple pyroscope.write components by giving them different labels.

Usage

Alloy Copy

pyroscope.write "<LABEL>" {
  endpoint {
    url = "<PYROSCOPE_URL>"

    ...
  }

  ...
}

Arguments

You can use the following argument with pyroscope.write:

Blocks

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

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

endpoint

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:

At most, one of the following can be provided:

• authorization block
• basic_auth block
• bearer_token_file argument
• bearer_token argument
• oauth2 block

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

authorization

basic_auth

oauth2

tls_config

Exported fields

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

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 doesn’t expose any component-specific debug information.

Example

Alloy Copy

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

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

Compatible components

pyroscope.write has exports that can be consumed by the following components:

• Components that consume Pyroscope ProfilesReceiver