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.

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

Eager exporting batch span processor #3024

Merged
merged 20 commits into from
Jan 13, 2023
Merged
Show file tree
Hide file tree
Changes from 10 commits
Commits
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
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ release.

### Traces

- Clarify that the BatchSpanProcessor should export batches when the queue reaches the batch size
([#3024](https://github.com/open-telemetry/opentelemetry-specification/pull/3024))
- Deprecate jaeger exporter, scheduled for spec removal in July 2023.
[#2858](https://github.com/open-telemetry/opentelemetry-specification/pull/2858)

Expand Down
26 changes: 24 additions & 2 deletions specification/trace/sdk.md
Original file line number Diff line number Diff line change
Expand Up @@ -579,17 +579,39 @@ This is an implementation of the `SpanProcessor` which create batches of finishe
spans and passes the export-friendly span data representations to the
configured `SpanExporter`.

The processor SHOULD export a batch when any of the following happens AND
there is not an export currently in progress:
dyladan marked this conversation as resolved.
Show resolved Hide resolved

- `scheduledDelayMillis` after the processor is constructed OR the first span
is received from the span processor
dyladan marked this conversation as resolved.
Show resolved Hide resolved
- `scheduledDelayMillis` after the previous export timer ends, OR the previous
export completes, OR the first span is added to the queue after the previous
export timer ends or previous batch completes.
- The queue contains `maxExportBatchSize` or more spans.
reyang marked this conversation as resolved.
Show resolved Hide resolved

In any of the above cases the processor MUST NOT begin an export if another
export is in progress. If one of the above events occurs during an ongoing export
the processor MAY do either of the following:

- Export the next batch immediately when the ongoing export completes
- Export the next batch `scheduledDelayMillis` after the ongoing export completes

In any of the above cases, if the queue is empty the processor MAY export
an empty batch OR skip the export and consider it to be completed immediately.

**Configurable parameters:**

* `exporter` - the exporter where the spans are pushed.
* `maxQueueSize` - the maximum queue size. After the size is reached spans are
dropped. The default value is `2048`.
* `scheduledDelayMillis` - the delay interval in milliseconds between two
* `scheduledDelayMillis` - the maximum delay interval in milliseconds between two
consecutive exports. The default value is `5000`.
* `exportTimeoutMillis` - how long the export can run before it is cancelled.
The default value is `30000`.
* `maxExportBatchSize` - the maximum batch size of every export. It must be
smaller or equal to `maxQueueSize`. The default value is `512`.
smaller or equal to `maxQueueSize`. If the queue reaches `maxExportBatchSize`
a batch will be exported even if `scheduledDelayMillis` milliseconds have not
elapsed. The default value is `512`.

## Span Exporter

Expand Down