This repository has been archived by the owner on May 23, 2023. It is now read-only.
V0.32.0 README update #332
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
|
Any objection to merging this one @yurishkuro ? ;) |
yurishkuro
approved these changes
Mar 5, 2019
README.md
Outdated
| // cannot record the exception in the span since scope is not accessible and span is finished | ||
| } | ||
| ``` | ||
|
|
||
| **If there is a `Scope`, it will act as the parent to any newly started `Span`** unless |
There was a problem hiding this comment.
If there is already an active Span
README.md
Outdated
| 2. In the closure/`Runnable`/`Future`/etc itself, invoke `tracer.scopeManager().activate(span, false)` to re-activate the `Span` and get a new `Scope`, then `deactivate()` it when the `Span` is no longer active (or use try-with-resources for less typing). | ||
| 3. In the closure/`Runnable`/`Future`/etc where the end of the task is reached, invoke `tracer.scopeManager().activate(span, true)` to re-activate the `Span` and have the new `Scope` close the `Span` automatically. | ||
| 1. Start a `Span` via `start`. | ||
| 2. In the closure/`Runnable`/`Future`/etc itself, invoke `tracer.scopeManager().activate(span)` to re-activate the `Span` and get a new `Scope`, then `deactivate()` it when the `Span` is no longer active (or use try-with-resources for less typing). |
There was a problem hiding this comment.
s/In the/At the beginning of/
README.md
Outdated
| 3. In the closure/`Runnable`/`Future`/etc where the end of the task is reached, invoke `tracer.scopeManager().activate(span, true)` to re-activate the `Span` and have the new `Scope` close the `Span` automatically. | ||
| 1. Start a `Span` via `start`. | ||
| 2. In the closure/`Runnable`/`Future`/etc itself, invoke `tracer.scopeManager().activate(span)` to re-activate the `Span` and get a new `Scope`, then `deactivate()` it when the `Span` is no longer active (or use try-with-resources for less typing). | ||
| 3. In the closure/`Runnable`/`Future`/etc where the end of the task is reached, invoke `tracer.scopeManager().activate(span)` to re-activate the `Span` and invoke `span.finish()` when the work is done. |
There was a problem hiding this comment.
Not sure there's a reason to re-activate the span here, just finishing it is fine.
There was a problem hiding this comment.
That makes sense. I'm guessing users will know they can do 2) (reactivation) anytime they need it, including when they are finishing the Span .
README.md
Outdated
| ... | ||
| doMoreAsyncWork(new Runnable() { |
There was a problem hiding this comment.
a bit weird example. Might be better to show an example with completable future and whenComplete()
|
Hey @yurishkuro docs got updated. Let me know ;) |
yurishkuro
approved these changes
Mar 7, 2019
README.md
Outdated
| ... | ||
| } | ||
| ``` | ||
| `Scope.span()` and `ScopeManager.scope()` have been deprecated in order to prevent passing of `Scope` objects between threads (`Scope` objects are not guaranteed to be thread-safe). |
There was a problem hiding this comment.
In order to prevent the anti-pattern of passing scope...
| } | ||
| }).thenRun(() -> { | ||
| // STEP 3 ABOVE: finish the Span when the work is done. | ||
| span.finish(); | ||
| }); |
|
@yurishkuro Updated ;) |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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 README is now updated with the new Scope/Span usage, as well as mention of deprecation of automatic Span finish upon Scope close (and related members).
This is done prior to do a release (finally) ;)