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
OpenTelemetry::SDK::Resources::Constants appears to be undocumented #379
Comments
TBH, this is a terrible way to access this constant - for this one specifically, I think a helper in the configurator is justified: c.service_name = 'my-service' |
There are a few in there that helpers might be nice for. The main one besides name is the one for an app’s version. |
Adds a convenience method so setter the service.name resource attribute. Closes open-telemetry#379
Adds a convenience method so setter the service.name resource attribute. Closes #379
I think this should be reopened as there are still a lot of constants that need to be documented. |
I may have eagerly closed this out, the constants are documented here https://github.com/open-telemetry/opentelemetry-specification/tree/master/specification/resource/semantic_conventions Do you think that additional documentation should live within this repo? @genebean |
I do. Even if it is just a readme that points to the spec. There is no way the average user would know to go hunt that down in it's current home. |
Closing this for now. The spec now requires a semantic-conventions package to be autogenerated from the semantic conventions YAML files in the spec. We've implemented this and removed the constants from the SDK gem. |
When setting up the new
Jaeger::CollectorExporter
I came acrossOpenTelemetry::SDK::Resources::Constants::SERVICE_RESOURCE[:name]
in its readme. I have not found any docs on this other than in its source code.A readme in
sdk/lib/opentelemetry/sdk/resources
might be a good way to fix this.The text was updated successfully, but these errors were encountered: