search

open-telemetry / opentelemetry.io

The OpenTelemetry website and documentation
https://opentelemetry.io
Creative Commons Attribution 4.0 International
487 stars 1.01k forks source link

Misleading link to collector from SDK examples #4713

Closed yurishkuro closed 1 week ago

yurishkuro commented 1 week ago

https://opentelemetry.io/docs/languages/go/exporters/#otlp

image

The last link to exporter in the collector does not belong to this section, it only confuses people (slack thread: https://cloud-native.slack.com/archives/CGG7NFUJ3/p1718664686569899).

Instead, it would be good to actually tell people how to configure the SDK in a minimal way, e.g. by mentioning OTEL_EXPORTER_OTLP_ENDPOINT env var. Could also point to Jaeger's docker-compose example https://github.com/jaegertracing/jaeger/blob/main/examples/hotrod/docker-compose.yml (especially from the Jaeger subsection, which again doesn't tell how to configure the SDK)

svrnm commented 1 week ago

Thanks @yurishkuro, go is one of the few languages not being consistent as outlined in https://github.com/open-telemetry/opentelemetry.io/issues/3559, my immediate solution would be removing that sentence and then in a second step fix that whole page.

diegolatorre116 commented 1 week ago

I am the person with the confusion in the slack thread. I can open a PR at night to eliminate that text that causes confusion and in a few days try to provide a new description.

tiffany76 commented 1 week ago

Thanks, @diegolatorre116! We welcome your contribution!

theletterf commented 1 week ago

Fixed by @diegolatorre116