Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add ForceFlush to Tracing SDK #1452

Merged
merged 7 commits into from
Feb 22, 2021
Merged

Add ForceFlush to Tracing SDK #1452

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
8b33c5d
Update sdk.md
kipwoker Feb 19, 2021
c581827
Update CHANGELOG.md
kipwoker Feb 19, 2021
44c67af
Update spec-compliance-matrix.md
kipwoker Feb 19, 2021
53fffbe
Update CHANGELOG.md
kipwoker Feb 19, 2021
8ee31d4
Merge branch 'main' into kipwoker/forceflush-tracerprovider
bogdandrutu Feb 19, 2021
358b1de
Update specification/trace/sdk.md
Feb 19, 2021
c14ae6d
Update specification/trace/sdk.md
kipwoker Feb 19, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ release.

- Adds `none` as a possible value for OTEL_TRACES_EXPORTER and OTEL_METRICS_EXPORTER to disable export
([#1439](https://github.com/open-telemetry/opentelemetry-specification/pull/1439))
- Add [`ForceFlush`](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/sdk.md#forceflush) to SDK's `TracerProvider` ([#1452](https://github.com/open-telemetry/opentelemetry-specification/pull/1452))

## v1.0.1 (2021-02-11)

Expand Down
1 change: 1 addition & 0 deletions spec-compliance-matrix.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ status of the feature is not known.
| Get a Tracer | | + | + | + | + | + | + | + | + | + | + | + |
| Safe for concurrent calls | | + | + | + | + | + | + | + | + | + | + | + |
| Shutdown (SDK only required) | | | + | + | + | + | - | | + | + | + | + |
| ForceFlush (SDK only required) | | | + | - | - | - | - | | - | - | + | - |
| [Trace / Context interaction](specification/trace/api.md#context-interaction) | | | | | | | | | | | | |
| Get active Span | | | + | + | + | + | + | | + | + | + | + |
| Set active Span | | | + | + | + | + | + | | + | + | + | + |
Expand Down
14 changes: 14 additions & 0 deletions specification/trace/sdk.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,20 @@ make the shutdown timeout configurable.

`Shutdown` MUST be implemented at least by invoking `Shutdown` within all internal processors.

### ForceFlush

This method provides a way for provider to immediately export all spans that have not yet been exported for all the internal processors.

`ForceFlush` SHOULD provide a way to let the caller know whether it succeeded,
failed or timed out.

`ForceFlush` SHOULD complete or abort within some timeout. `ForceFlush` can be
implemented as a blocking API or an asynchronous API which notifies the caller
via a callback or an event. OpenTelemetry client authors can decide if they want to
make the flush timeout configurable.

`ForceFlush` MUST invoke `ForceFlush` on all registered `SpanProcessors`.
bogdandrutu marked this conversation as resolved.
Show resolved Hide resolved

## Additional Span Interfaces

The [API-level definition for Span's interface](api.md#span-operations)
Expand Down