grafana / alloy

OpenTelemetry Collector distribution with programmable pipelines
https://grafana.com/oss/alloy
Apache License 2.0
968 stars 103 forks source link

Docs feedback: OTLPHTTP Exporter Encoding argument incorrectly defined #1051

Open alexmwinter opened 1 week ago

alexmwinter commented 1 week ago

URL

https://grafana.com/docs/alloy/latest/reference/components/otelcol.exporter.otlphttp/

Feedback

The documntation states that the encoding argument lives within the Client block; however, in practice it actually lives outside the Client block. The actual component is built here and we can see that in the Arguments block starting on line 34 that the Encoding argument is not a part of the client args.

I am curious if the best course of action here is to update the documentation to reflect this difference, or if it is better to just move the Encoding declaration further down the file into the Client Args?