This repository has been archived by the owner on May 23, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 344
Make Tracer extends Closable. #329
Merged
carlosalberto
merged 4 commits into
opentracing:v0.32.0
from
carlosalberto:tracer-closeable
Mar 1, 2019
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -13,13 +13,15 @@ | |
*/ | ||
package io.opentracing; | ||
|
||
import java.io.Closeable; | ||
|
||
import io.opentracing.propagation.Format; | ||
import io.opentracing.tag.Tag; | ||
|
||
/** | ||
* Tracer is a simple, thin interface for Span creation and propagation across arbitrary transports. | ||
*/ | ||
public interface Tracer { | ||
public interface Tracer extends Closeable { | ||
|
||
/** | ||
* @return the current {@link ScopeManager}, which may be a noop but may not be null. | ||
|
@@ -117,6 +119,19 @@ public interface Tracer { | |
*/ | ||
<C> SpanContext extract(Format<C> format, C carrier); | ||
|
||
/** | ||
* Closes the Tracer, and tries to flush the in-memory collection to the configured persistance store. | ||
* | ||
* <p> | ||
* The close method should be considered idempotent; closing an already closed Tracer should not raise an error. | ||
* Spans that are created or finished after a Tracer has been closed may or may not be flushed. | ||
* Calling the close method should be considered a synchronous operation. Observe this call may block for | ||
* a relatively long period of time, depending on the internal shutdown. | ||
* <p> | ||
* For stateless tracers, this can be a no-op. | ||
*/ | ||
@Override | ||
void close(); | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Should this There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Done ;) |
||
|
||
interface SpanBuilder { | ||
|
||
|
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
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
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
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
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this text implies that while spans may not be flushed, the tracer must still create them like business as usual, right?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, I'd say so (as mentioned in the spec RFC) - an alternative is to NOT allow Span objects to be created (from where? from the builder? from
start
?)