Skip to content

Commit

Permalink
update otel docs
Browse files Browse the repository at this point in the history
Signed-off-by: Amy Tobey <[email protected]>
  • Loading branch information
Amy Tobey committed Aug 25, 2021
1 parent 3eed86f commit 21c06f5
Showing 1 changed file with 8 additions and 10 deletions.
18 changes: 8 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,26 +72,24 @@ The most interesting targets are `make all` (or just `make`) and `make images`.

Rather than adding a bunch of command line options or a config file, OpenTelemetry
is configured via environment variables. The most relevant ones are below, for others
see https://github.com/tobert/otel-launcher-go/tree/temp-hack-for-tinkerbell-prs
see https://github.com/equinix-labs/otel-init-go

Notes:
* we're using a branch of Lightstep's otel-launcher-go modified to work with any OTLP provider
* currently this is just for tracing, metrics needs to be discussed with the community

| Env Variable | Required | Default |
|-----------------------------------|----------|---------- |
|`OTEL_EXPORTER_OTLP_SPAN_ENDPOINT` | n | localhost |
|`OTEL_EXPORTER_OTLP_SPAN_INSECURE` | n | false |
|`OTEL_EXPORTER_OTLP_HEADERS` | n | {} |
|`OTEL_LOG_LEVEL` | n | info |
| Env Variable | Required | Default |
|------------------------------|----------|---------- |
|`OTEL_EXPORTER_OTLP_ENDPOINT` | n | localhost |
|`OTEL_EXPORTER_OTLP_INSECURE` | n | false |
|`OTEL_LOG_LEVEL` | n | info |

To work with a local [opentelemetry-collector](https://github.com/open-telemetry/opentelemetry-collector),
try the following. For examples of how to set up the collector to relay to various services
take a look at [otel-cli](https://github.com/packethost/otel-cli)

```
export OTEL_EXPORTER_OTLP_SPAN_ENDPOINT=localhost
export OTEL_EXPORTER_OTLP_SPAN_INSECURE=true
export OTEL_EXPORTER_OTLP_ENDPOINT=localhost:4317
export OTEL_EXPORTER_OTLP_INSECURE=true
./cmd/tink-server/tink-server <stuff>
```

Expand Down

0 comments on commit 21c06f5

Please sign in to comment.