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

[Page feedback]: Add examples and best practices to Go exporters documentation #5847

Open
jcranfordbeyondtrust opened this issue Dec 23, 2024 · 2 comments
Labels
help wanted Extra attention is needed sig:go

Comments

@jcranfordbeyondtrust
Copy link

URL

https://opentelemetry.io/docs/languages/go/exporters/

Description

Need examples of how to separately create and return:

  1. *metric.MeterProvider
  2. *trace.TracerProvider
  3. *log.LoggerProvider

Include best practices such as

  1. Batching
  2. Vender neutrality (e.g. metricsProvider should have pull provider Prometheus for local testing, and push provider for preprod testing)
@tiffany76 tiffany76 added help wanted Extra attention is needed sig:go labels Jan 1, 2025
@tiffany76 tiffany76 changed the title [Page feedback]: ADD A SUMMARY OF YOUR FEEDBACK HERE [Page feedback]: Add examples and best practices to Go exporters documentation Jan 1, 2025
@tiffany76
Copy link
Contributor

@open-telemetry/go-approvers, PTAL. Thanks.

@pellared
Copy link
Member

pellared commented Jan 20, 2025

Need examples of how to separately create and return:

  1. *metric.MeterProvider
  2. *trace.TracerProvider
  3. *log.LoggerProvider

This is in https://opentelemetry.io/docs/languages/go/instrumentation.

Include best practices such as

  1. Batching

This is also included in https://opentelemetry.io/docs/languages/go/instrumentation. Notice also that examples in https://pkg.go.dev (for instance https://pkg.go.dev/go.opentelemetry.io/otel/exporters/otlp/otlplog/otlploghttp#example-package) do that. Maybe we should remove the code snippets from https://opentelemetry.io/docs/languages/go/exporters ?

  1. Vender neutrality (e.g. metricsProvider should have pull provider Prometheus for local testing, and push provider for preprod testing)

ad. 2
Is there anything not vendor-neutral in our docs? The suggestions you provided are subjective. Some may prefer to use logging exporters or use OTel Collector for local testing. Using Prometheus for production is also fine.

@open-telemetry/docs-approvers, can you follow-up please?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed sig:go
Projects
Status: No status
Development

No branches or pull requests

3 participants