Skip to content

Commit

Permalink
docs: add otel ebpf profiling support (#3713)
Browse files Browse the repository at this point in the history
* docs: add otel ebpf profiling support

---------

Co-authored-by: Dmitry Filimonov <[email protected]>
Co-authored-by: Kim Nylander <[email protected]>
  • Loading branch information
3 people authored Dec 2, 2024
1 parent b2e5d0a commit dd1dbdb
Showing 1 changed file with 52 additions and 0 deletions.
52 changes: 52 additions & 0 deletions docs/sources/configure-client/opentelemetry/ebpf-profiler.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
---
title: OpenTelemetry profiling support
menuTitle: OpenTelemetry profiling
description: OpenTelemetry profiling support in Pyroscope
weight: 10
---

# OpenTelemetry profiling support

{{< docs/experimental product="OpenTelemetry profiles" >}}

Pyroscope includes **experimental** support for receiving and visualizing profiles from OpenTelemetry sources. This integration allows you to:

- Collect system-wide profiles using the [OpenTelemetry eBPF profiler](https://github.com/open-telemetry/opentelemetry-ebpf-profiler)
- Process profile data through the OpenTelemetry Collector
- Visualize profiles in Grafana using Pyroscope

## Considerations

Before getting started, you should consider the following limitations:

- The OpenTelemetry profiles protocol ([proto files](https://github.com/open-telemetry/opentelemetry-proto/tree/main/opentelemetry/proto/profiles)) is under active development:
- Breaking changes are expected and have occurred
- Compatibility between components (profiler, collector, backend) requires careful version management
- We maintain support for the latest protocol version, but updates may be required frequently

- Symbolization support is currently limited:
- Function names may not appear in flamegraphs for some programs
- We're working on improving symbol resolution and adding support for manual symbol uploads

- We recommend evaluating this feature for development and testing purposes, but waiting for protocol stabilization before production use

## Requirements

- Linux system (amd64/arm64) for eBPF profiler
- OpenTelemetry Collector with profiles feature gate enabled
- Grafana with Pyroscope data source enabled

## Architecture

The profile collection pipeline consists of:

1. **OpenTelemetry eBPF Profiler**: Collects system-wide profiles
2. **OpenTelemetry Collector**: Receives and forwards profile data
3. **Pyroscope**: Stores and processes profiles
4. **Grafana**: Visualizes profile data

## Get started

For detailed setup instructions and working examples, refer to the [examples repository](https://github.com/grafana/pyroscope/tree/main/examples/grafana-agent-auto-instrumentation/ebpf-otel).

The examples demonstrate deployments for both Docker and Kubernetes environments.

0 comments on commit dd1dbdb

Please sign in to comment.