Skip to content

Commit

Permalink
fix typo err and add env ref
Browse files Browse the repository at this point in the history
  • Loading branch information
minimAluminiumalism authored and wilsonxscai committed Aug 17, 2024
1 parent 545f930 commit c94ef65
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ To instrument an application on the same host, follow these steps:
For example:

```sh
sudo OTEL_GO_AUTO_TARGET_EXE=/home/bin/service_executable OTEL_SERVICE_NAME=my_service OTEL_EXPORTER_OTLP_ENDPOINT=http://localhost:4318 ./otel-go-instrumentation`
sudo OTEL_GO_AUTO_TARGET_EXE=/home/bin/service_executable OTEL_SERVICE_NAME=my_service OTEL_EXPORTER_OTLP_ENDPOINT=http://localhost:4318 ./otel-go-instrumentation
```

3. Run the OpenTelemetry Go Automatic Instrumentation with root privileges.
Expand All @@ -61,12 +61,15 @@ network, a shared volume, and a service for the application.
environment:
- OTEL_EXPORTER_OTLP_ENDPOINT=http://<address_in_docker_network>:4318
- OTEL_GO_AUTO_TARGET_EXE=<location_of_target_application_binary>
- OTEL_RESOURCE_ATTRIBUTES=key1=value1
- OTEL_SERVICE_NAME=<name_of_your_application>
- OTEL_PROPAGATORS=tracecontext,baggage
volumes:
- <shared_volume_of_application>
- /proc:/host/proc
```
For more environment variables, refer to [here](https://opentelemetry.io/docs/languages/sdk-configuration/).
3. Run `docker compose up`.

Expand Down

0 comments on commit c94ef65

Please sign in to comment.