Skip to content

Commit

Permalink
Eager exporting batch span processor (open-telemetry#3024)
Browse files Browse the repository at this point in the history
  • Loading branch information
dyladan authored Jan 13, 2023
1 parent 0251150 commit 1f0073c
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 2 deletions.
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
23 changes: 21 additions & 2 deletions specification/trace/sdk.md
Original file line number Diff line number Diff line change
Expand Up @@ -579,17 +579,36 @@ 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
`SpanProcessor#Export()` has not yet returned (for additional concurrency
details see the [Export() specification](#exportbatch)):

- `scheduledDelayMillis` after the processor is constructed OR the first span
is received by the span processor.
- `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.
- `ForceFlush` is called.

If any of the above events occurs before `Export()` returns, the span processor
should wait until `Export()` returns before exporting the next batch.
If the queue is empty when an export is triggered, 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

0 comments on commit 1f0073c

Please sign in to comment.