Update readthedocs api guide: nested spans and context propagator #792
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
lalitb
changed the title
Codecov Report
@@ Coverage Diff @@
## main #792 +/- ##
=======================================
Coverage 96.00% 96.00%
=======================================
Files 176 176
Lines 7186 7186
=======================================
Hits 6899 6899
Misses 287 287 |
ThomsonTan
reviewed
May 24, 2021
| @@ -48,5 +48,57 @@ related span is ended. | |||
|
|
|||
| The concept of an active span is important, as any span that is created | |||
| without explicitly specifying a parent is parented to the currently | |||
| active span. | |||
| active span. A span without a parent is called root span. | |||
There was a problem hiding this comment.
Suggested change
| active span. A span without a parent is called root span. | |
| active span. A span with a null parent is called root span. |
ThomsonTan
reviewed
May 24, 2021
| auto inner_span = tracer->StartSpan("Inner operation"); | ||
| auto inner_scope = tracer->WithActiveSpan(inner_span); | ||
| // ... perform inner operation | ||
| inner_span->End(); |
There was a problem hiding this comment.
Is this call to ->End() optional? The destruction of inner_span would call End().
There was a problem hiding this comment.
It's optional, as ~Span destructor calls it anyway. But the Span object returned by Tracer::StartSpan is shared_ptr and in case instrumentation code is referring to this object at some other places, the ~Span destructor will be called when all the references are cleaned up. It's always good ( and no harm ) to call it explicitly to export the Span when it is complete. And later when the destructor is called, it won't perform this again.
ThomsonTan
approved these changes
May 24, 2021
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.
Added Nested spans and Context Propagation in API Getting started guide.
Here is how it looks like:
https://labhas-opentelemetry-cpp.readthedocs.io/en/latest/GettingStarted.html
For significant contributions please make sure you have completed the following items:
CHANGELOG.mdupdated for non-trivial changes