docs: add SimpleSpanProcessor warning (#4798)

* docs: add SimpleSpanProcessor warning * Update packages/opentelemetry-sdk-trace-base/src/export/SimpleSpanProcessor.ts Co-authored-by: Marc Pichler <[email protected]> --------- Co-authored-by: Marc Pichler <[email protected]>
open-telemetry · Jun 18, 2024 · 3cbc9c7 · 3cbc9c7
1 parent 9e421f6
commit 3cbc9c7
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/packages/opentelemetry-sdk-trace-base/src/export/SimpleSpanProcessor.ts b/packages/opentelemetry-sdk-trace-base/src/export/SimpleSpanProcessor.ts
@@ -33,6 +33,8 @@ import { Resource } from '@opentelemetry/resources';
  * to {@link ReadableSpan} and passes it to the configured exporter.
  *
  * Only spans that are sampled are converted.
+ *
+ * NOTE: This {@link SpanProcessor} exports every ended span individually instead of batching spans together, which causes significant performance overhead with most exporters. For production use, please consider using the {@link BatchSpanProcessor} instead.
  */
 export class SimpleSpanProcessor implements SpanProcessor {
   private _shutdownOnce: BindOnceFuture<void>;