[SDK] Add tracer scope configurator #3137
Open
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
✅ Deploy Preview for opentelemetry-cpp-api-docs canceled.
|
psx95
force-pushed
the
add-scope-config
branch
from
6e15bc3 to
75d84d8
Compare
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #3137 +/- ##
==========================================
+ Coverage 87.73% 87.85% +0.12%
==========================================
Files 198 201 +3
Lines 6258 6316 +58
==========================================
+ Hits 5490 5548 +58
Misses 768 768
|
psx95
force-pushed
the
add-scope-config
branch
11 times, most recently
from
dd70641 to
0370722
Compare
psx95
force-pushed
the
add-scope-config
branch
2 times, most recently
from
b82ea68 to
f6ff444
Compare
psx95
force-pushed
the
add-scope-config
branch
10 times, most recently
from
93950bf to
c77065e
Compare
psx95
changed the title
psx95
force-pushed
the
add-scope-config
branch
from
2329279 to
2f1ee38
Compare
psx95
force-pushed
the
add-scope-config
branch
from
db05adc to
31c73a3
Compare
Converting ScopeConfigurator from type alias to a dedicated class allows control over how it is initialized. This commits makes it so that ScopeConfigurator can only be initialized using the inner Builder class. This will prevent future confusion on how to initialize ScopeConfigurators.
marcalff
reviewed
Jan 13, 2025
| std::unique_ptr<IdGenerator> id_generator, | ||
| std::unique_ptr<instrumentationscope::ScopeConfigurator<TracerConfig>> tracer_configurator); | ||
|
|
||
| /* Series of creator methods with a single processor. */ |
marcalff
reviewed
Jan 13, 2025
Comment on lines
+48
to
+68
| const std::array<instrumentation_scope::InstrumentationScope *, 5> instrumentation_scopes = { | ||
| std::move(instrumentation_scope::InstrumentationScope::Create("test_scope_1")).get(), | ||
| std::move(instrumentation_scope::InstrumentationScope::Create("test_scope_2", "1.0")).get(), | ||
| std::move(instrumentation_scope::InstrumentationScope::Create( | ||
| "test_scope_3", | ||
| "0", | ||
| "https://opentelemetry.io/schemas/v1.18.0")) | ||
| .get(), | ||
| std::move(instrumentation_scope::InstrumentationScope::Create( | ||
| "test_scope_3", | ||
| "0", | ||
| "https://opentelemetry.io/schemas/v1.18.0", | ||
| {attr1})) | ||
| .get(), | ||
| std::move(instrumentation_scope::InstrumentationScope::Create( | ||
| "test_scope_4", | ||
| "0", | ||
| "https://opentelemetry.io/schemas/v1.18.0", | ||
| {attr1, attr2, attr3})) | ||
| .get(), | ||
| }; |
There was a problem hiding this comment.
This construct is a problem.
Either this is static test data, where the instrumentation_scopes array is initialized with data, not code.
Ot it is constructed with code, with statements adding elements in the array.
As written, this will be very challenging to debug and interpret stack traces, should it fail at runtime.
marcalff
reviewed
Jan 13, 2025
| // evaluating other condition | ||
| const auto span_foo_scope_with_version_2 = tracer_foo_scope_with_version_2->StartSpan("span 1"); | ||
| auto &span_foo_scope_with_version_ref_2 = *span_foo_scope_with_version_2.get(); | ||
| EXPECT_EQ(typeid(span_foo_scope_with_version_ref_2), typeid(trace_api::NoopSpan)); |
There was a problem hiding this comment.
Possible alternative to using OPENTELEMETRY_RTTI_ENABLED, not tested, to investigate:
- Create a noop_span using NoopTracerProvider::GetTracer() and NoopTracer::StartSpan
- Compare the pointer to the span object with the noop span.
This relies on the fact that noop spans are always the same object, per:
// Don't allocate a no-op span for every StartSpan call, but use a static
// singleton for this case.
static nostd::shared_ptr<trace::Span> noop_span(new trace::NoopSpan{this->shared_from_this()});
return noop_span;
Alternate possibility:
- check for IsRecordable(), should be false for noop span and true for real spans.
marcalff
reviewed
Jan 13, 2025
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.
Re #2641
Adds scope configurator for Tracers.
Changes
Some optional, good-to-have convenience functions were recommended by the spec to accommodate common use-cases - these have not been added in this PR.
See the TracerConfigurator spec for these recommendations. They should be added in a future PR.
For significant contributions please make sure you have completed the following items:
CHANGELOG.mdupdated for non-trivial changes