-
Notifications
You must be signed in to change notification settings - Fork 1.1k
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
Consider using go module paths for scope name in demos #5412
Consider using go module paths for scope name in demos #5412
Comments
Also, should we document the convention that the go import path of the library producing the telemetry should be used as the scope name? |
SGTM. Only question is where should we document this? Package docs? |
To complete this, the docs site will need to be updated as well. |
We already document this directly for the Meter and Tracer:
We should add this to the LoggerProvider: opentelemetry-go/log/provider.go Lines 19 to 25 in d595dab
@dashpole do you think this is adequate documentation? |
|
yes, thank you! |
Part of #5412 --------- Co-authored-by: Robert Pająk <[email protected]>
Part of #5412 - Use the recommended package name for the instrumentation exemplified in the repository. - Use the recommended detection of a `TracerProvider` from passed context.
Problem Statement
I noticed the rolldice example has a single-word name for the meter and tracer:
opentelemetry-go/example/dice/rolldice.go
Lines 12 to 17 in ca93aae
I haven't checked other examples, but IMO we should consider doing this across all of them.
Proposed Solution
Since many users will use this as a starting point for their code, would it make more sense to use a "real" scope name? E.g.
go.opentelemetry.io/otel/example/dice
?Alternatives
Keep simpler names for samples
The text was updated successfully, but these errors were encountered: