canonical

aliases

description

labels

title

https://grafana.com/docs/alloy/latest/reference/components/pyroscope/pyroscope.ebpf/

../pyroscope.ebpf/

Learn about pyroscope.ebpf

stage

products

general-availability

oss

pyroscope.ebpf

`pyroscope.ebpf`

pyroscope.ebpf configures an eBPF profiling job for the current host. The collected performance profiles are forwarded to the list of receivers passed in forward_to.

The pyroscope.ebpf component embeds the grafana/opentelemetry-ebpf-profiler which is a fork of open-telemetry/opentelemetry-ebpf-profiler.

{{< admonition type="note" >}} To use the pyroscope.ebpf component you must run {{< param "PRODUCT_NAME" >}} as root and inside the host PID namespace. {{< /admonition >}}

{{< admonition type="note" >}} The profiler requires file system storage at /tmp/symb-cache to store symbol cache data. Ensure this directory is accessible and has sufficient storage space. {{< /admonition >}}

You can specify multiple pyroscope.ebpf components by giving them different labels, however it's not recommended as it can lead to additional memory and CPU usage.

Supported languages

Native code (C/C++, Rust, Zig, Go, etc. without debug symbols on host)
Broad set of HLLs (Hotspot JVM, Python, Ruby, PHP, Node.JS, V8, Perl).

Usage

pyroscope.ebpf "<LABEL>" {
  targets    = <TARGET_LIST>
  forward_to = <RECEIVER_LIST>
}

Arguments

The component configures and starts a new eBPF profiling job to collect performance profiles from the current host.

You can use the following arguments with pyroscope.ebpf:

Name	Type	Description	Default	Required
`forward_to`	`list(ProfilesReceiver)`	List of receivers to send collected profiles to.		yes
`targets`	`list(map(string))`	List of targets to group profiles by container ID.		yes
`build_id_cache_size`	`int`	Deprecated (no-op), previously controlled the size of the elf file build id -> symbols table LRU cache.	`64`	no
`cache_rounds`	`int`	Deprecated (no-op), previously controlled the number of cache rounds.		no
`collect_interval`	`duration`	How frequently to collect profiles.	`"15s"`	no
`collect_kernel_profile`	`bool`	Deprecated (no-op), previously enabled collection of kernelspace profiles.	`true`	no
`collect_user_profile`	`bool`	Deprecated (no-op), previously enabled collection of userspace profiles.	`true`	no
`container_id_cache_size`	`int`	The size of the PID -> container ID table LRU cache.	`1024`	no
`demangle`	`string`	C++ demangle mode. Available options are: `none`, `simplified`, `templates`, or `full`.	`"none"`	no
`dotnet_enabled`	`bool`	A flag to enable or disable .NET profiling.	`true`	no
`go_table_fallback`	`bool`	Deprecated (no-op), previously enabled symbol lookup in `.sym` / `.dynsym` sections when `.gopclntab` lookup failed.	`false`	no
`hotspot_enabled`	`bool`	A flag to enable ordisable hotspot profiling.	`true`	no
`perl_enabled`	`bool`	A flag to enable or disable Perl profiling.	`true`	no
`php_enabled`	`bool`	A flag to enable or disable PHP profiling.	`true`	no
`pid_cache_size`	`int`	Deprecated (no-op), previously controlled the size of the PID -> proc symbols table LRU cache.	`32`	no
`pid_map_size`	`int`	Deprecated (no-op), previously controlled the size of eBPF PID map.	`2048`	no
`python_enabled`	`bool`	A flag to enable or disable python profiling.	`true`	no
`ruby_enabled`	`bool`	A flag to enable or disable Ruby profiling.	`true`	no
`same_file_cache_size`	`int`	Deprecated (no-op), previously controlled the size of the elf file -> symbols table LRU cache.	`8`	no
`sample_rate`	`int`	How many times per second to collect profile samples.	`19`	no
`symbols_map_size`	`int`	Deprecated (no-op), previously controlled the size of eBPF symbols map .	`16384`	no
`load_probe`	`bool`	Enable loading uprobe dynamically during runtime.	`false`	no
`u_probe_links`	`list(string)`	List of user-space symbols to collect stack-trace from, e.g. `["/usr/lib/libc.so.6:malloc"]`.		no
`v8_enabled`	`bool`	A flag to enable/disable V8 profiling.	`true`	no
`off_cpu_threshold`	`float`	A flag to adjust the off-cpu profiling threshold between 0 and 1 as float.	`0`	no
`verbose_mode`	`bool`	Enable verbose logging for the eBPF profiler.	`false`	no
`lazy_mode`	`bool`	Enable lazy mode to defer eBPF profiler startup until targets are discovered.	`false`	no

Only the forward_to and targets fields are required. Omitted fields take their default values.

Several arguments are marked as "Deprecated (no-op)". These arguments were previously used for configuring various cache sizes and behaviors, but they no longer have any effect. They are kept for backward compatibility but will be removed in a future release. It is recommended to remove these arguments from your configuration.

Blocks

The pyroscope.ebpf component doesn't support any blocks. You can configure this component with arguments.

Exported fields

pyroscope.ebpf doesn't export any fields that can be referenced by other components.

Component health

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

Debug information

elf_cache per build id and per same file symbol tables and their sizes in symbols count.
pid_cache per process elf symbol tables and their sizes in symbols count.
targets currently tracked active targets.

Debug metrics

pyroscope_ebpf_active_targets (gauge): Number of active targets the component tracks.
pyroscope_ebpf_pprofs_total (counter): Number of pprof profiles collected by the eBPF component.
pyroscope_ebpf_profiling_sessions_failing_total (counter): Number of profiling sessions failed.
pyroscope_ebpf_profiling_sessions_total (counter): Number of profiling sessions completed.
pyroscope_fanout_latency (histogram): Write latency for sending to direct and indirect components.

Profile collecting behavior

The pyroscope.ebpf component collects stack traces associated with a process running on the current host. You can use the sample_rate argument to define the number of stack traces collected per second. The default is 97.

The following labels are automatically injected into the collected profiles if you haven't defined them. These labels can help you pin down a profiling target.

Label	Description
`__container_id__`	The container ID derived from target.
`__name__`	Pyroscope metric name. Defaults to `process_cpu`.
`service_name`	Pyroscope service name. It's automatically selected from discovery meta labels if possible. Otherwise defaults to `unspecified`.

Targets

One of the following special labels must be included in each target of targets and the label must correspond to the container or process that is profiled:

__container_id__: The container ID.
__meta_docker_container_id: The ID of the Docker container.
__meta_kubernetes_pod_container_id: The ID of the Kubernetes Pod container.
__process_pid__ : The process ID.

Each process is then associated with a specified target from the targets list, determined by a container ID or process PID.

If a process's container ID matches a target's container ID label, the stack traces are aggregated per target based on the container ID. If a process's PID matches a target's process PID label, the stack traces are aggregated per target based on the process PID. Otherwise the process isn't profiled.

Service name

The special label service_name is required and must always be present. If it's not specified, it's attempted to be inferred from multiple sources:

__meta_docker_container_name
__meta_kubernetes_namespace and __meta_kubernetes_pod_container_name
__meta_kubernetes_pod_annotation_pyroscope_io_service_name which is a pyroscope.io/service_name Pod annotation.

If service_name isn't specified and couldn't be inferred, it's set to unspecified.

Troubleshoot unknown symbols

Symbols are extracted from various sources, including:

The .gopclntab section in Go language ELF files.
The .symtab and .dynsym sections in the debug ELF file.
The .symtab and .dynsym sections in the ELF file.

The search for debug files follows gdb algorithm. For example, if the profiler wants to find the debug file for /lib/x86_64-linux-gnu/libc.so.6 with a .gnu_debuglink set to libc.so.6.debug and a build ID 0123456789abcdef. The following paths are examined:

/usr/lib/debug/.build-id/01/0123456789abcdef.debug
/lib/x86_64-linux-gnu/libc.so.6.debug
/lib/x86_64-linux-gnu/.debug/libc.so.6.debug
/usr/lib/debug/lib/x86_64-linux-gnu/libc.so.6.debug

Deal with unknown symbols

Unknown symbols in the profiles you've collected indicate that the profiler couldn't access an ELF file associated with a given address in the trace.

This can occur for several reasons:

The process has terminated, making the ELF file inaccessible.
The ELF file is either corrupted or not recognized as an ELF file.
There is no corresponding ELF file entry in /proc/pid/maps for the address in the stack trace.

Address unresolved symbols

If you only see module names without corresponding function names, for example, /lib/x86_64-linux-gnu/libc.so.6, it indicates that the symbols couldn't be mapped to their respective function names.

This can occur for several reasons:

The binary has been stripped, leaving no .symtab, .dynsym, or .gopclntab sections in the ELF file.
The debug file is missing or couldn't be located.

To fix this for your binaries, ensure that they're either not stripped or that you have separate debug files available. You can achieve this by running:

objcopy --only-keep-debug elf elf.debug
strip elf -o elf.stripped
objcopy --add-gnu-debuglink=elf.debug elf.stripped elf.debuglink

For system libraries, ensure that debug symbols are installed. On Ubuntu, for example, you can install debug symbols for libc by executing:

apt install libc6-dbg

Understand flat stack traces

If your profiles show many shallow stack traces, typically 1-2 frames deep, your binary might have been compiled without frame pointers.

To compile your code with frame pointers, include the -fno-omit-frame-pointer flag in your compiler options.

Example

Kubernetes discovery

In the following example, performance profiles are collected from Pods on the same node, discovered using discovery.kubernetes. Pod selection relies on the HOSTNAME environment variable, which is a Pod name if {{< param "PRODUCT_NAME" >}} is used as an {{< param "PRODUCT_NAME" >}} Helm chart. The service_name label is set to {__meta_kubernetes_namespace}/{__meta_kubernetes_pod_container_name} from Kubernetes meta labels.

discovery.kubernetes "all_pods" {
  role = "pod"
  selectors {
    field = "spec.nodeName=" + sys.env("HOSTNAME")
    role = "pod"
  }
}

discovery.relabel "local_pods" {
  targets = discovery.kubernetes.all_pods.targets
  rule {
    action = "drop"
    regex = "Succeeded|Failed"
    source_labels = ["__meta_kubernetes_pod_phase"]
  }
  rule {
    action = "replace"
    regex = "(.*)@(.*)"
    replacement = "ebpf/${1}/${2}"
    separator = "@"
    source_labels = ["__meta_kubernetes_namespace", "__meta_kubernetes_pod_container_name"]
    target_label = "service_name"
  }
  rule {
    action = "labelmap"
    regex = "__meta_kubernetes_pod_label_(.+)"
  }
  rule {
    action = "replace"
    source_labels = ["__meta_kubernetes_namespace"]
    target_label = "namespace"
  }
  rule {
    action = "replace"
    source_labels = ["__meta_kubernetes_pod_name"]
    target_label = "pod"
  }
  rule {
    action = "replace"
    source_labels = ["__meta_kubernetes_pod_node_name"]
    target_label = "node"
  }
  rule {
    action = "replace"
    source_labels = ["__meta_kubernetes_pod_container_name"]
    target_label = "container"
  }
}
pyroscope.ebpf "local_pods" {
  forward_to = [ pyroscope.write.endpoint.receiver ]
  targets = discovery.relabel.local_pods.output
}

pyroscope.write "endpoint" {
  endpoint {
    url = "http://pyroscope:4040"
  }
}

Docker discovery

The following example collects performance profiles from containers discovered by discovery.docker and ignores all other profiles collected from outside any docker container. The service_name label is set to the __meta_docker_container_name label.

discovery.docker "linux" {
  host = "unix:///var/run/docker.sock"
}

discovery.relabel "local_containers" {
  targets = discovery.docker.linux.targets
  rule {
    action = "replace"
    source_labels = ["__meta_docker_container_name"]
    target_label = "service_name"
  }
}

pyroscope.write "staging" {
  endpoint {
    url = "http://pyroscope:4040"
  }
}

pyroscope.ebpf "default" {
  forward_to   = [ pyroscope.write.staging.receiver ]
  targets      = discovery.relabel.local_containers.output
}

Compatible components

pyroscope.ebpf can accept arguments from the following components:

Components that export Targets
Components that export Pyroscope ProfilesReceiver

{{< admonition type="note" >}} Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. Refer to the linked documentation for more details. {{< /admonition >}}

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

`pyroscope.ebpf`

Supported languages

Usage

Arguments

Blocks

Exported fields

Component health

Debug information

Debug metrics

Profile collecting behavior

Targets

Service name

Troubleshoot unknown symbols

Deal with unknown symbols

Address unresolved symbols

Understand flat stack traces

Example

Kubernetes discovery

Docker discovery

Compatible components

FilesExpand file tree

pyroscope.ebpf.md

Latest commit

History

pyroscope.ebpf.md

File metadata and controls

pyroscope.ebpf

Supported languages

Usage

Arguments

Blocks

Exported fields

Component health

Debug information

Debug metrics

Profile collecting behavior

Targets

Service name

Troubleshoot unknown symbols

Deal with unknown symbols

Address unresolved symbols

Understand flat stack traces

Example

Kubernetes discovery

Docker discovery

Compatible components

`pyroscope.ebpf`