opentelemetry.io icon indicating copy to clipboard operation
opentelemetry.io copied to clipboard

OTLP exporters description in the registry is not accurate

Open joaopgrassi opened this issue 2 years ago • 5 comments

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

joaopgrassi avatar Sep 30 '22 14:09 joaopgrassi

@cartermp, thoughts on how this should be phrased?

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

svrnm avatar Oct 04 '22 09:10 svrnm

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

joaopgrassi avatar Oct 04 '22 09:10 joaopgrassi

@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

svrnm avatar Oct 04 '22 10:10 svrnm

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

cartermp avatar Oct 05 '22 15:10 cartermp

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

joaopgrassi avatar Oct 06 '22 11:10 joaopgrassi