feat: start a root span with spanOptions.parent = null (open-telemetr…

…y#889) * feat: start a root span with spanOptions.parent = null * chore: lint * chore: add return type for readability
dyladan · Feb 18, 2021 · 5319e53 · 5319e53
1 parent 41e0d74
commit 5319e53
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/api/src/trace/SpanOptions.ts b/api/src/trace/SpanOptions.ts
@@ -44,6 +44,9 @@ export interface SpanOptions {
    * A parent `SpanContext` (or `Span`, for convenience) that the newly-started
    * span will be the child of. This overrides the parent span extracted from
    * the currently active context.
+   *
+   * A null value here should prevent the SDK from extracting a parent from
+   * the current context, forcing the new span to be a root span.
    */
   parent?: Span | SpanContext | null;