docs: add SimpleSpanProcessor warning (open-telemetry#4798)

* docs: add SimpleSpanProcessor warning * Update packages/opentelemetry-sdk-trace-base/src/export/SimpleSpanProcessor.ts Co-authored-by: Marc Pichler <marc.pichler@dynatrace.com> --------- Co-authored-by: Marc Pichler <marc.pichler@dynatrace.com>
Zirak · Sep 14, 2024 · c9e83ed · c9e83ed
1 parent 44a631d
commit c9e83ed
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>;