docs: add SimpleSpanProcessor warning (#4798)

danstarns · pichlermarc · web-flow · commit 3cbc9c72e940 · 2024-06-18T11:50:44.000Z
* docs: add SimpleSpanProcessor warning

* Update packages/opentelemetry-sdk-trace-base/src/export/SimpleSpanProcessor.ts

Co-authored-by: Marc Pichler &lt;marc.pichler@dynatrace.com&gt;

---------

Co-authored-by: Marc Pichler &lt;marc.pichler@dynatrace.com&gt;
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>;

Original file line number	Diff line number	Diff line change
`@@ -33,6 +33,8 @@ import { Resource } from '@opentelemetry/resources';`
`33`	`33`	`* to {@link ReadableSpan} and passes it to the configured exporter.`
`34`	`34`	`*`
`35`	`35`	`* Only spans that are sampled are converted.`
	`36`	`+ *`
	`37`	`+ * 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.`
`36`	`38`	`*/`
`37`	`39`	`export class SimpleSpanProcessor implements SpanProcessor {`
`38`	`40`	`private _shutdownOnce: BindOnceFuture<void>;`