This is documentation for the next version of Grafana Alloy Documentation. For the latest stable release, go to the latest version.

Documentation Grafana Alloy Reference Components pyroscope pyroscope.enrich

pyroscope.enrich

pyroscope.enrich enriches profiles with additional labels from service discovery targets. It matches a label from incoming profiles against a label from discovered targets, and copies specified labels from the matched target to the profile.

Usage

Alloy Copy

pyroscope.enrich "<LABEL>" {
  targets = <DISCOVERY_COMPONENT>.targets
  target_match_label = "<LABEL>"
  forward_to = [<RECEIVER_LIST>]
}

Arguments

You can use the following arguments with pyroscope.enrich:

If profiles_match_label isn’t provided, the component uses target_match_label for matching profile labels.

Blocks

pyroscope.enrich doesn’t support any blocks. Configure this component with arguments.

Exported fields

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

Component health

pyroscope.enrich is only reported as unhealthy if given an invalid configuration.

Debug information

pyroscope.enrich doesn’t expose debug information.

Debug metrics

pyroscope.enrich doesn’t expose additional metrics.

Example

This example enriches profiles received over HTTP with metadata from Kubernetes service discovery:

Alloy Copy

// Discover Kubernetes pods
discovery.kubernetes "pods" {
  role = "pod"
}

// Add custom labels from Kubernetes metadata
discovery.relabel "pods" {
  targets = discovery.kubernetes.pods.targets
  
  rule {
    source_labels = ["__meta_kubernetes_namespace"]
    target_label  = "namespace"
  }
  
  rule {
    source_labels = ["__meta_kubernetes_pod_node_name"]
    target_label  = "node"
  }
  
  rule {
    source_labels = ["__meta_kubernetes_pod_label_app"]
    target_label  = "app"
  }
  
  rule {
    source_labels = ["__meta_kubernetes_pod_label_environment"]
    target_label  = "environment"
  }
  
  rule {
    source_labels = ["__meta_kubernetes_pod_ip"]
    target_label  = "pod_ip"
  }
}

// Receive profiles over HTTP
pyroscope.receive_http "default" {
  http {
    listen_address = "0.0.0.0"
    listen_port    = 4040
  }
  forward_to = [pyroscope.enrich.metadata.receiver]
}

// Enrich profiles with Kubernetes metadata
pyroscope.enrich "metadata" {
  targets               = discovery.relabel.pods.output
  target_match_label    = "pod_ip"
  profiles_match_label  = "service_name"
  labels_to_copy        = ["namespace", "node", "app", "environment"]
  forward_to            = [pyroscope.write.default.receiver]
}

// Write profiles to Pyroscope
pyroscope.write "default" {
  endpoint {
    url = "http://pyroscope:4040"
  }
}

Component behavior

The component matches profiles to discovered targets and enriches them with additional labels:

1. For each profile, it looks up the value of profiles_match_label from the profile’s labels, or target_match_label if profiles_match_label isn’t specified.
2. It matches this value against the target_match_label in discovered targets.
3. When it finds a match, it copies the requested labels_to_copy from the discovered target to the profile. If labels_to_copy is empty, it copies all labels.
4. The component forwards the profile, enriched or unchanged, to the configured receivers.

Compatible components

pyroscope.enrich can accept arguments from the following components:

• Components that export Targets
• Components that export Pyroscope ProfilesReceiver

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

• Components that consume Pyroscope ProfilesReceiver