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.

Sign up for GitHub

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

Jump to bottom

Refine OTLP exporter documentation #4688

Closed
pellared opened this issue Nov 2, 2023 · 0 comments · Fixed by #4695
Closed

Refine OTLP exporter documentation #4688

pellared opened this issue Nov 2, 2023 · 0 comments · Fixed by #4695
Assignees
@pellared
Labels
documentation Provides helpful information enhancement New feature or request pkg:exporter:otlp Related to the OTLP exporter package
Milestone
v1.20.0

Comments

@pellared
Copy link
Member

pellared commented Nov 2, 2023 •
edited
Loading

  1. Rewrite the docs to follow our documentation guidelines. Example: https://pkg.go.dev/go.opentelemetry.io/contrib/exporters/autoexport
  2. Make sure to clearly document that we default to HTTPS (not HTTP). See: OTLP exporters have improper default endpoint  #4147 (comment)
  3. Document in package docs the supported env vars (with description and defaults). Reference the options that can be used to override these values (e.g. for _ENDPOINT env vars these are WithInsecure, WithEndpoint and WithURLPath (sic!). Prior work by @MadVikingGod: otlpmetricgrpc otlpmetrichttp: Add README.md #4336
  4. Revisit the testable examples.
@pellared pellared added enhancement New feature or request documentation Provides helpful information pkg:exporter:otlp Related to the OTLP exporter package labels Nov 2, 2023
@pellared pellared mentioned this issue Nov 2, 2023
Closed
@pellared pellared self-assigned this Nov 2, 2023
This was referenced Nov 2, 2023
Closed
Closed
@pellared pellared added this to the v1.20.0 milestone Nov 3, 2023
@pellared pellared mentioned this issue Nov 6, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@pellared pellared

Labels
documentation Provides helpful information enhancement New feature or request pkg:exporter:otlp Related to the OTLP exporter package
Projects
No open projects
Go: Metric OTLP Exporter (GA)
Status: Done
Milestone
v1.20.0
Development

Successfully merging a pull request may close this issue.

otlp: Refine documentation pellared/opentelemetry-go
1 participant
@pellared