search

open-telemetry / opentelemetry.io

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

OTLP exporters description in the registry is not accurate #1793

Closed joaopgrassi closed 2 years ago

joaopgrassi commented 2 years ago

What needs to be changed? I noticed that the description used in the OTLP exporter entries (e.g. the Java one) in the registry is not accurate. It says:

This library allows to export data to the OpenTelemetry Collector using the OpenTelemetry Protocol.

It's not accurate because OTLP exporters also allow sending data to other places outside the collector (e.g., directly to an o11y back-end).

What is the name + path of the page that needs changed? content/en/registry/exporter-{lang}-otlp

Additional context I initially spotted and discussed it here https://github.com/open-telemetry/opentelemetry.io/pull/1792#discussion_r984521837

Suggestion: @svrnm suggested in the PR above to use something like:

This library allows to export telemetry data in the OpenTelemetry Protocol (OTLP) format to the OpenTelemetry Collector and OTLP-compliant backends/receivers

svrnm commented 2 years ago

@cartermp, thoughts on how this should be phrased?

@joaopgrassi would you be open to fix that for all the OTLP exporters?

joaopgrassi commented 2 years ago

@svrnm yes, I can send a PR to fix all the others, once we agree on the sentence.

svrnm commented 2 years ago

@joaopgrassi thanks!

@chalin , @cartermp I am also wondering if this would be something we could fix via a short code or other mechanisms? so have that repeated text stored away somewhere

cartermp commented 2 years ago

Regarding this proposed sentence:

This library allows to export telemetry data in the OpenTelemetry Protocol (OTLP) format to the OpenTelemetry Collector and OTLP-compliant backends/receivers

I would propose something similar, just with one word change 🙂

This library allows exporting telemetry data in the OpenTelemetry Protocol (OTLP) format to the OpenTelemetry Collector and OTLP-compliant backends/receivers

joaopgrassi commented 2 years ago

I'll open a PR fixing all registry entries in the upcoming day(s). Feel free to assign this to me if you want :)