trace: split tracer and versioned_tracer methods
#682
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The [trace spec] requires that `TracerProvider`s MUST accept optional `version` and `schema_url` parameters. This introduces ergonomic issues as rust does not have a variadic solution outside of macros, leading to many calls with only a single relevant argument (e.g. `tracer(name, None, None)`). This patch splits the current `TracerProvider::tracer` method into `TracerProvider::versioned_tracer` which implements the spec mandated optional fields, as well as a `TracerProvider::tracer` method that accepts only a `name` parameter as a convenience method for the above listed common case. [trace spec]: https://github.com/open-telemetry/opentelemetry-specification/blob/v1.4.0/specification/trace/api.md#get-a-tracer
Codecov Report
@@ Coverage Diff @@
## main #682 +/- ##
==========================================
- Coverage 63.85% 63.81% -0.05%
==========================================
Files 95 96 +1
Lines 7717 7725 +8
==========================================
+ Hits 4928 4930 +2
- Misses 2789 2795 +6
Continue to review full report at Codecov.
|
|
I think it's related to #555. Since we started preparing GA. One question here is what if the spec adds another parameter in the future? |
|
I think as the trace spec is frozen we can assume they will not for now. If they do, then the simplest thing seems to be to either add another method or do a major version bump to support the new spec. |
|
I think we can close #555 with this PR |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The trace spec requires that
TracerProviders MUST accept optionalversionandschema_urlparameters. This introduces ergonomic issues as rust does not have a variadic solution outside of macros, leading to many calls with only a single relevant argument (e.g.tracer(name, None, None)).This patch splits the current
TracerProvider::tracermethod intoTracerProvider::versioned_tracerwhich implements the spec mandated optional fields, as well as aTracerProvider::tracermethod that accepts only anameparameter as a convenience method for the above listed common case.