From e146850b5770051fe1a61a73a3eb15ba9e50e6b9 Mon Sep 17 00:00:00 2001 From: Rachel Klein Date: Thu, 15 Oct 2020 16:37:05 -0700 Subject: [PATCH] Clarify when to use simple vs. batching span processors --- specification/trace/sdk.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/specification/trace/sdk.md b/specification/trace/sdk.md index 710b23229f7..44c8a935777 100644 --- a/specification/trace/sdk.md +++ b/specification/trace/sdk.md @@ -400,6 +400,11 @@ This is an implementation of `SpanProcessor` which passes finished spans and the export-friendly span data representation to the configured `SpanExporter` as soon as they are finished. +Typically, the simple processor will be most suitable for use in testing and/or +in scenarios where creating multiple threads is not desirable, since batching +span processors will typically be threaded in order to pass spans on to exporters +in the background. + **Configurable parameters:** * `exporter` - the exporter where the spans are pushed. @@ -410,6 +415,9 @@ This is an implementation of `SpanProcessor` which creates batches of finished spans and passes the export-friendly span data representations to the configured `SpanExporter`. +Typically, the batching processor will be more suitable for production environments +than the simple processor. + **Configurable parameters:** * `exporter` - the exporter where the spans are pushed.