Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: documentation on "Well known exporters" and OTEL_TRACES_EXPORTER variable #2023

Merged
merged 3 commits into from
Aug 13, 2021

Conversation

ecourreges-orange
Copy link
Contributor

@ecourreges-orange ecourreges-orange commented Aug 9, 2021

Following the auto-instrumentation README and examples, I encountered 2 inconsistencies between doc and code, so I fixed the documentation:

fix: documentation on "Well known exporters" -> zipkin doesn't exist but zipkin_json and zipkin_proto exist, etc. Thanks @ocelotl
fix: documentation env var is not OTEL_TRACE_EXPORTER but OTEL_TRACES_EXPORTER

@ecourreges-orange ecourreges-orange requested a review from a team as a code owner August 9, 2021 14:56
@ecourreges-orange ecourreges-orange requested review from owais and lzchen and removed request for a team August 9, 2021 14:56
@ecourreges-orange ecourreges-orange changed the title fix: documentation on "Well known exporters" and OTEL_TRACES_EXPORTERS variable fix: documentation on "Well known exporters" and OTEL_TRACES_EXPORTER variable Aug 9, 2021
Copy link
Contributor

@ocelotl ocelotl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch, thanks for the fixes ✌️

Copy link
Contributor

@codeboten codeboten left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for fixing this!

- otlp
- otlp_proto_grpc_span
Copy link
Member

@srikanthccv srikanthccv Aug 9, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We have proto_grpc exporter right?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch, that's correct, otlp_proto_grpc_span should stay.

- otlp
- otlp_proto_grpc_span
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch, that's correct, otlp_proto_grpc_span should stay.

Copy link
Contributor

@ocelotl ocelotl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please fix the requested change ✌️

@ecourreges-orange
Copy link
Contributor Author

/

Please fix the requested change ✌️

Actually it already says just below in the doc that otlp is an alias for otlp_proto_grpc_span but ok i can re-add it as well if you prefer.

fix: documentation OTEL_TRACE_EXPORTER -> OTEL_TRACES_EXPORTER
Copy link
Contributor

@codeboten codeboten left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

Copy link
Contributor

@codeboten codeboten left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ocelotl please take a look and approve if your comments have been addressed.

@ocelotl
Copy link
Contributor

ocelotl commented Aug 12, 2021

Will review tonight ✌️

@ocelotl ocelotl merged commit 820c89e into open-telemetry:main Aug 13, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants