Skip to content
This repository was archived by the owner on Jan 21, 2025. It is now read-only.

Commit efc5588

Browse files
authored
README: Add Datadog Instructions (#4)
* README: Add Datadog Instructions * README: link to latest release
1 parent aa830f6 commit efc5588

File tree

1 file changed

+39
-0
lines changed

1 file changed

+39
-0
lines changed

README.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,42 @@
1+
# Datadog Fork
2+
3+
This is an experimental fork of [elastic/otel-profiling-agent](https://github.com/elastic/otel-profiling-agent). The upstream project is in the process of being [donated](https://github.com/open-telemetry/community/issues/1918) to the OpenTelemetry project. Please refer to our [documentation](https://docs.datadoghq.com/profiler/) for a list of offically supported Datadog profilers.
4+
5+
Our fork adds support for sending profiling data to the Datadog backend via the Datadog Agent. We are active members of the OpenTelemetry Profiling SIG that is working on the OpenTelemetry profiling signal. However, the signal is still under active development, so this fork can be used by Datadog users until we release our support for directly ingesting the data using OTLP.
6+
7+
## Build
8+
9+
To build the agent, you can use the following commands:
10+
11+
```
12+
make docker-image
13+
make agent
14+
```
15+
16+
This will create a `otel-profiling-agent` binary in the current directory.
17+
18+
Alternatively you can download pre-built amd64 and arm64 binaries for our [latest release](https://github.com/DataDog/otel-profiling-agent/releases/latest).
19+
20+
## Run
21+
22+
To run the agent, you need to make sure that debugfs is mounted. If it's not, you can run:
23+
24+
```
25+
sudo mount -t debugfs none /sys/kernel/debug
26+
```
27+
28+
After that, you can start the agent as shown below:
29+
30+
```
31+
sudo otel-profiling-agent -tags 'service:myservice;remote_symbols:yes' -collection-agent "http://localhost:8126" -reporter-interval 60s -samples-per-second 20
32+
```
33+
34+
For this to work you need to run a Datadog agent that listens for APM traffic at `localhost:8126`. If your agent is reachable under a different address, you can modify the `-collection-agent` parameter accordingly.
35+
36+
The contents of the original upstream README are below.
37+
38+
---
39+
140
> [!NOTE]
241
>
342
> Please be aware that we currently won't merge 3rd party PRs because this repository

0 commit comments

Comments
 (0)