Add deprecation message.

open-telemetry · Feb 13, 2025 · d3a2b11 · d3a2b11
1 parent 4bbac22
commit d3a2b11
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/packages/opentelemetry-sdk-trace-base/src/Span.ts b/packages/opentelemetry-sdk-trace-base/src/Span.ts
@@ -63,6 +63,10 @@ export class Span implements APISpan, ReadableSpan {
   // purposes but are not intended to be written-to directly.
   private readonly _spanContext: SpanContext;
   readonly kind: SpanKind;
+  /**
+   * @deprecated
+   * Please use {@link parentSpanContext}'s spanId instead.
+   */
   readonly parentSpanId?: string;
   readonly parentSpanContext?: SpanContext;
   readonly attributes: SpanAttributes = {};

diff --git a/packages/opentelemetry-sdk-trace-base/src/export/ReadableSpan.ts b/packages/opentelemetry-sdk-trace-base/src/export/ReadableSpan.ts
@@ -30,6 +30,10 @@ export interface ReadableSpan {
   readonly name: string;
   readonly kind: SpanKind;
   readonly spanContext: () => SpanContext;
+  /**
+   * @deprecated
+   * Use {@link parentSpanContext}'s spanId instead.
+   */
   readonly parentSpanId?: string;
   readonly parentSpanContext?: SpanContext;
   readonly startTime: HrTime;