43 lines
54 KiB
HTML
43 lines
54 KiB
HTML
<!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>TraceAPI | OpenTelemetry SDK</title><meta name="description" content="Documentation for OpenTelemetry SDK"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">OpenTelemetry SDK</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">OpenTelemetry SDK</a></li><li><a href="../modules/_opentelemetry_sdk-node.html">@opentelemetry/sdk-node</a></li><li><a href="../modules/_opentelemetry_sdk-node._opentelemetry_api.html">@opentelemetry/api</a></li><li><a href="_opentelemetry_sdk-node._opentelemetry_api.TraceAPI.html">TraceAPI</a></li></ul><h1>Class TraceAPI</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Singleton object which represents the entry point to the OpenTelemetry Tracing API</p>
|
||
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-since"><h4 class="tsd-anchor-link"><a id="since" class="tsd-anchor"></a>Since<a href="#since" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>1.0.0</p>
|
||
</div></div></section><aside class="tsd-sources"><ul><li>Defined in api/build/src/api/trace.d.ts:10</li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="_opentelemetry_sdk-node._opentelemetry_api.TraceAPI.html#deletespan" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>delete<wbr/>Span</span></a>
|
||
<a href="_opentelemetry_sdk-node._opentelemetry_api.TraceAPI.html#getactivespan" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>get<wbr/>Active<wbr/>Span</span></a>
|
||
<a href="_opentelemetry_sdk-node._opentelemetry_api.TraceAPI.html#getspan" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>get<wbr/>Span</span></a>
|
||
<a href="_opentelemetry_sdk-node._opentelemetry_api.TraceAPI.html#getspancontext" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>get<wbr/>Span<wbr/>Context</span></a>
|
||
<a href="_opentelemetry_sdk-node._opentelemetry_api.TraceAPI.html#isspancontextvalid" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is<wbr/>Span<wbr/>Context<wbr/>Valid</span></a>
|
||
<a href="_opentelemetry_sdk-node._opentelemetry_api.TraceAPI.html#setspan" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>set<wbr/>Span</span></a>
|
||
<a href="_opentelemetry_sdk-node._opentelemetry_api.TraceAPI.html#setspancontext" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>set<wbr/>Span<wbr/>Context</span></a>
|
||
<a href="_opentelemetry_sdk-node._opentelemetry_api.TraceAPI.html#wrapspancontext" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>wrap<wbr/>Span<wbr/>Context</span></a>
|
||
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="_opentelemetry_sdk-node._opentelemetry_api.TraceAPI.html#disable" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>disable</span></a>
|
||
<a href="_opentelemetry_sdk-node._opentelemetry_api.TraceAPI.html#gettracer" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Tracer</span></a>
|
||
<a href="_opentelemetry_sdk-node._opentelemetry_api.TraceAPI.html#gettracerprovider" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Tracer<wbr/>Provider</span></a>
|
||
<a href="_opentelemetry_sdk-node._opentelemetry_api.TraceAPI.html#setglobaltracerprovider" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Global<wbr/>Tracer<wbr/>Provider</span></a>
|
||
<a href="_opentelemetry_sdk-node._opentelemetry_api.TraceAPI.html#getinstance" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Instance</span></a>
|
||
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="deletespan" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>delete<wbr/>Span</span><a href="#deletespan" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">deleteSpan</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">context</span><span class="tsd-signature-symbol">:</span> <a href="../modules/_opentelemetry_sdk-node._opentelemetry_api.html" class="tsd-signature-type tsd-kind-namespace">@opentelemetry/api</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/_opentelemetry_sdk-node._opentelemetry_api.Context.html" class="tsd-signature-type tsd-kind-interface">Context</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <a href="../modules/_opentelemetry_sdk-node._opentelemetry_api.html" class="tsd-signature-type tsd-kind-namespace">@opentelemetry/api</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/_opentelemetry_sdk-node._opentelemetry_api.Context.html" class="tsd-signature-type tsd-kind-interface">Context</a></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">context</span><span class="tsd-signature-symbol">:</span> <a href="../modules/_opentelemetry_sdk-node._opentelemetry_api.html" class="tsd-signature-type tsd-kind-namespace">@opentelemetry/api</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/_opentelemetry_sdk-node._opentelemetry_api.Context.html" class="tsd-signature-type tsd-kind-interface">Context</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="../modules/_opentelemetry_sdk-node._opentelemetry_api.html" class="tsd-signature-type tsd-kind-namespace">@opentelemetry/api</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/_opentelemetry_sdk-node._opentelemetry_api.Context.html" class="tsd-signature-type tsd-kind-interface">Context</a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Remove current span stored in the context</p>
|
||
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">context</span>: <a href="../modules/_opentelemetry_sdk-node._opentelemetry_api.html" class="tsd-signature-type tsd-kind-namespace">@opentelemetry/api</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/_opentelemetry_sdk-node._opentelemetry_api.Context.html" class="tsd-signature-type tsd-kind-interface">Context</a></span><div class="tsd-comment tsd-typography"><p>context to delete span from</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../modules/_opentelemetry_sdk-node._opentelemetry_api.html" class="tsd-signature-type tsd-kind-namespace">@opentelemetry/api</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/_opentelemetry_sdk-node._opentelemetry_api.Context.html" class="tsd-signature-type tsd-kind-interface">Context</a></h4><div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><aside class="tsd-sources"><ul><li>Defined in api/build/src/api/trace.d.ts:35</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="getactivespan" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Active<wbr/>Span</span><a href="#getactivespan" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">getActiveSpan</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <a href="../modules/_opentelemetry_sdk-node._opentelemetry_api.html" class="tsd-signature-type tsd-kind-namespace">@opentelemetry/api</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/_opentelemetry_sdk-node._opentelemetry_api.Span.html" class="tsd-signature-type tsd-kind-interface">Span</a></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <a href="../modules/_opentelemetry_sdk-node._opentelemetry_api.html" class="tsd-signature-type tsd-kind-namespace">@opentelemetry/api</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/_opentelemetry_sdk-node._opentelemetry_api.Span.html" class="tsd-signature-type tsd-kind-interface">Span</a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Gets the span from the current context, if one exists.</p>
|
||
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <a href="../modules/_opentelemetry_sdk-node._opentelemetry_api.html" class="tsd-signature-type tsd-kind-namespace">@opentelemetry/api</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/_opentelemetry_sdk-node._opentelemetry_api.Span.html" class="tsd-signature-type tsd-kind-interface">Span</a></h4><div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><aside class="tsd-sources"><ul><li>Defined in api/build/src/api/trace.d.ts:37</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="getspan" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Span</span><a href="#getspan" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">getSpan</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">context</span><span class="tsd-signature-symbol">:</span> <a href="../modules/_opentelemetry_sdk-node._opentelemetry_api.html" class="tsd-signature-type tsd-kind-namespace">@opentelemetry/api</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/_opentelemetry_sdk-node._opentelemetry_api.Context.html" class="tsd-signature-type tsd-kind-interface">Context</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <a href="../modules/_opentelemetry_sdk-node._opentelemetry_api.html" class="tsd-signature-type tsd-kind-namespace">@opentelemetry/api</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/_opentelemetry_sdk-node._opentelemetry_api.Span.html" class="tsd-signature-type tsd-kind-interface">Span</a></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">context</span><span class="tsd-signature-symbol">:</span> <a href="../modules/_opentelemetry_sdk-node._opentelemetry_api.html" class="tsd-signature-type tsd-kind-namespace">@opentelemetry/api</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/_opentelemetry_sdk-node._opentelemetry_api.Context.html" class="tsd-signature-type tsd-kind-interface">Context</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <a href="../modules/_opentelemetry_sdk-node._opentelemetry_api.html" class="tsd-signature-type tsd-kind-namespace">@opentelemetry/api</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/_opentelemetry_sdk-node._opentelemetry_api.Span.html" class="tsd-signature-type tsd-kind-interface">Span</a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Return the span if one exists</p>
|
||
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">context</span>: <a href="../modules/_opentelemetry_sdk-node._opentelemetry_api.html" class="tsd-signature-type tsd-kind-namespace">@opentelemetry/api</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/_opentelemetry_sdk-node._opentelemetry_api.Context.html" class="tsd-signature-type tsd-kind-interface">Context</a></span><div class="tsd-comment tsd-typography"><p>context to get span from</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <a href="../modules/_opentelemetry_sdk-node._opentelemetry_api.html" class="tsd-signature-type tsd-kind-namespace">@opentelemetry/api</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/_opentelemetry_sdk-node._opentelemetry_api.Span.html" class="tsd-signature-type tsd-kind-interface">Span</a></h4><div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><aside class="tsd-sources"><ul><li>Defined in api/build/src/api/trace.d.ts:36</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="getspancontext" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Span<wbr/>Context</span><a href="#getspancontext" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">getSpanContext</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">context</span><span class="tsd-signature-symbol">:</span> <a href="../modules/_opentelemetry_sdk-node._opentelemetry_api.html" class="tsd-signature-type tsd-kind-namespace">@opentelemetry/api</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/_opentelemetry_sdk-node._opentelemetry_api.Context.html" class="tsd-signature-type tsd-kind-interface">Context</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <a href="../modules/_opentelemetry_sdk-node._opentelemetry_api.html" class="tsd-signature-type tsd-kind-namespace">@opentelemetry/api</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/_opentelemetry_sdk-node._opentelemetry_api.SpanContext.html" class="tsd-signature-type tsd-kind-interface">SpanContext</a></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">context</span><span class="tsd-signature-symbol">:</span> <a href="../modules/_opentelemetry_sdk-node._opentelemetry_api.html" class="tsd-signature-type tsd-kind-namespace">@opentelemetry/api</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/_opentelemetry_sdk-node._opentelemetry_api.Context.html" class="tsd-signature-type tsd-kind-interface">Context</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <a href="../modules/_opentelemetry_sdk-node._opentelemetry_api.html" class="tsd-signature-type tsd-kind-namespace">@opentelemetry/api</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/_opentelemetry_sdk-node._opentelemetry_api.SpanContext.html" class="tsd-signature-type tsd-kind-interface">SpanContext</a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get the span context of the span if it exists.</p>
|
||
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">context</span>: <a href="../modules/_opentelemetry_sdk-node._opentelemetry_api.html" class="tsd-signature-type tsd-kind-namespace">@opentelemetry/api</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/_opentelemetry_sdk-node._opentelemetry_api.Context.html" class="tsd-signature-type tsd-kind-interface">Context</a></span><div class="tsd-comment tsd-typography"><p>context to get values from</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <a href="../modules/_opentelemetry_sdk-node._opentelemetry_api.html" class="tsd-signature-type tsd-kind-namespace">@opentelemetry/api</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/_opentelemetry_sdk-node._opentelemetry_api.SpanContext.html" class="tsd-signature-type tsd-kind-interface">SpanContext</a></h4><div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><aside class="tsd-sources"><ul><li>Defined in api/build/src/api/trace.d.ts:38</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="isspancontextvalid" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Span<wbr/>Context<wbr/>Valid</span><a href="#isspancontextvalid" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">isSpanContextValid</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">spanContext</span><span class="tsd-signature-symbol">:</span> <a href="../modules/_opentelemetry_sdk-node._opentelemetry_api.html" class="tsd-signature-type tsd-kind-namespace">@opentelemetry/api</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/_opentelemetry_sdk-node._opentelemetry_api.SpanContext.html" class="tsd-signature-type tsd-kind-interface">SpanContext</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">spanContext</span><span class="tsd-signature-symbol">:</span> <a href="../modules/_opentelemetry_sdk-node._opentelemetry_api.html" class="tsd-signature-type tsd-kind-namespace">@opentelemetry/api</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/_opentelemetry_sdk-node._opentelemetry_api.SpanContext.html" class="tsd-signature-type tsd-kind-interface">SpanContext</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns true if this <a href="../interfaces/_opentelemetry_sdk-node._opentelemetry_api.SpanContext.html" class="tsd-kind-interface">SpanContext</a> is valid.</p>
|
||
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">spanContext</span>: <a href="../modules/_opentelemetry_sdk-node._opentelemetry_api.html" class="tsd-signature-type tsd-kind-namespace">@opentelemetry/api</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/_opentelemetry_sdk-node._opentelemetry_api.SpanContext.html" class="tsd-signature-type tsd-kind-interface">SpanContext</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p>true if this <a href="../interfaces/_opentelemetry_sdk-node._opentelemetry_api.SpanContext.html" class="tsd-kind-interface">SpanContext</a> is valid.</p>
|
||
<div class="tsd-comment tsd-typography"><div class="tsd-tag-since"><h4 class="tsd-anchor-link"><a id="since-1" class="tsd-anchor"></a>Since<a href="#since-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>1.0.0</p>
|
||
</div></div></li></ul></li></ul></div><aside class="tsd-sources"><ul><li>Defined in api/build/src/api/trace.d.ts:34</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="setspan" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Span</span><a href="#setspan" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">setSpan</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">context</span><span class="tsd-signature-symbol">:</span> <a href="../modules/_opentelemetry_sdk-node._opentelemetry_api.html" class="tsd-signature-type tsd-kind-namespace">@opentelemetry/api</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/_opentelemetry_sdk-node._opentelemetry_api.Context.html" class="tsd-signature-type tsd-kind-interface">Context</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">span</span><span class="tsd-signature-symbol">:</span> <a href="../modules/_opentelemetry_sdk-node._opentelemetry_api.html" class="tsd-signature-type tsd-kind-namespace">@opentelemetry/api</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/_opentelemetry_sdk-node._opentelemetry_api.Span.html" class="tsd-signature-type tsd-kind-interface">Span</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <a href="../modules/_opentelemetry_sdk-node._opentelemetry_api.html" class="tsd-signature-type tsd-kind-namespace">@opentelemetry/api</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/_opentelemetry_sdk-node._opentelemetry_api.Context.html" class="tsd-signature-type tsd-kind-interface">Context</a></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">context</span><span class="tsd-signature-symbol">:</span> <a href="../modules/_opentelemetry_sdk-node._opentelemetry_api.html" class="tsd-signature-type tsd-kind-namespace">@opentelemetry/api</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/_opentelemetry_sdk-node._opentelemetry_api.Context.html" class="tsd-signature-type tsd-kind-interface">Context</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">span</span><span class="tsd-signature-symbol">:</span> <a href="../modules/_opentelemetry_sdk-node._opentelemetry_api.html" class="tsd-signature-type tsd-kind-namespace">@opentelemetry/api</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/_opentelemetry_sdk-node._opentelemetry_api.Span.html" class="tsd-signature-type tsd-kind-interface">Span</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="../modules/_opentelemetry_sdk-node._opentelemetry_api.html" class="tsd-signature-type tsd-kind-namespace">@opentelemetry/api</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/_opentelemetry_sdk-node._opentelemetry_api.Context.html" class="tsd-signature-type tsd-kind-interface">Context</a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Set the span on a context</p>
|
||
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">context</span>: <a href="../modules/_opentelemetry_sdk-node._opentelemetry_api.html" class="tsd-signature-type tsd-kind-namespace">@opentelemetry/api</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/_opentelemetry_sdk-node._opentelemetry_api.Context.html" class="tsd-signature-type tsd-kind-interface">Context</a></span><div class="tsd-comment tsd-typography"><p>context to use as parent</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">span</span>: <a href="../modules/_opentelemetry_sdk-node._opentelemetry_api.html" class="tsd-signature-type tsd-kind-namespace">@opentelemetry/api</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/_opentelemetry_sdk-node._opentelemetry_api.Span.html" class="tsd-signature-type tsd-kind-interface">Span</a></span><div class="tsd-comment tsd-typography"><p>span to set active</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../modules/_opentelemetry_sdk-node._opentelemetry_api.html" class="tsd-signature-type tsd-kind-namespace">@opentelemetry/api</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/_opentelemetry_sdk-node._opentelemetry_api.Context.html" class="tsd-signature-type tsd-kind-interface">Context</a></h4><div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><aside class="tsd-sources"><ul><li>Defined in api/build/src/api/trace.d.ts:39</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="setspancontext" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Span<wbr/>Context</span><a href="#setspancontext" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">setSpanContext</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">context</span><span class="tsd-signature-symbol">:</span> <a href="../modules/_opentelemetry_sdk-node._opentelemetry_api.html" class="tsd-signature-type tsd-kind-namespace">@opentelemetry/api</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/_opentelemetry_sdk-node._opentelemetry_api.Context.html" class="tsd-signature-type tsd-kind-interface">Context</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">spanContext</span><span class="tsd-signature-symbol">:</span> <a href="../modules/_opentelemetry_sdk-node._opentelemetry_api.html" class="tsd-signature-type tsd-kind-namespace">@opentelemetry/api</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/_opentelemetry_sdk-node._opentelemetry_api.SpanContext.html" class="tsd-signature-type tsd-kind-interface">SpanContext</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <a href="../modules/_opentelemetry_sdk-node._opentelemetry_api.html" class="tsd-signature-type tsd-kind-namespace">@opentelemetry/api</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/_opentelemetry_sdk-node._opentelemetry_api.Context.html" class="tsd-signature-type tsd-kind-interface">Context</a></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">context</span><span class="tsd-signature-symbol">:</span> <a href="../modules/_opentelemetry_sdk-node._opentelemetry_api.html" class="tsd-signature-type tsd-kind-namespace">@opentelemetry/api</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/_opentelemetry_sdk-node._opentelemetry_api.Context.html" class="tsd-signature-type tsd-kind-interface">Context</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">spanContext</span><span class="tsd-signature-symbol">:</span> <a href="../modules/_opentelemetry_sdk-node._opentelemetry_api.html" class="tsd-signature-type tsd-kind-namespace">@opentelemetry/api</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/_opentelemetry_sdk-node._opentelemetry_api.SpanContext.html" class="tsd-signature-type tsd-kind-interface">SpanContext</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="../modules/_opentelemetry_sdk-node._opentelemetry_api.html" class="tsd-signature-type tsd-kind-namespace">@opentelemetry/api</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/_opentelemetry_sdk-node._opentelemetry_api.Context.html" class="tsd-signature-type tsd-kind-interface">Context</a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Wrap span context in a NoopSpan and set as span in a new
|
||
context</p>
|
||
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">context</span>: <a href="../modules/_opentelemetry_sdk-node._opentelemetry_api.html" class="tsd-signature-type tsd-kind-namespace">@opentelemetry/api</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/_opentelemetry_sdk-node._opentelemetry_api.Context.html" class="tsd-signature-type tsd-kind-interface">Context</a></span><div class="tsd-comment tsd-typography"><p>context to set active span on</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">spanContext</span>: <a href="../modules/_opentelemetry_sdk-node._opentelemetry_api.html" class="tsd-signature-type tsd-kind-namespace">@opentelemetry/api</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/_opentelemetry_sdk-node._opentelemetry_api.SpanContext.html" class="tsd-signature-type tsd-kind-interface">SpanContext</a></span><div class="tsd-comment tsd-typography"><p>span context to be wrapped</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../modules/_opentelemetry_sdk-node._opentelemetry_api.html" class="tsd-signature-type tsd-kind-namespace">@opentelemetry/api</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/_opentelemetry_sdk-node._opentelemetry_api.Context.html" class="tsd-signature-type tsd-kind-interface">Context</a></h4><div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><aside class="tsd-sources"><ul><li>Defined in api/build/src/api/trace.d.ts:40</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="wrapspancontext" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>wrap<wbr/>Span<wbr/>Context</span><a href="#wrapspancontext" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">wrapSpanContext</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">spanContext</span><span class="tsd-signature-symbol">:</span> <a href="../modules/_opentelemetry_sdk-node._opentelemetry_api.html" class="tsd-signature-type tsd-kind-namespace">@opentelemetry/api</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/_opentelemetry_sdk-node._opentelemetry_api.SpanContext.html" class="tsd-signature-type tsd-kind-interface">SpanContext</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <a href="../modules/_opentelemetry_sdk-node._opentelemetry_api.html" class="tsd-signature-type tsd-kind-namespace">@opentelemetry/api</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/_opentelemetry_sdk-node._opentelemetry_api.Span.html" class="tsd-signature-type tsd-kind-interface">Span</a></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">spanContext</span><span class="tsd-signature-symbol">:</span> <a href="../modules/_opentelemetry_sdk-node._opentelemetry_api.html" class="tsd-signature-type tsd-kind-namespace">@opentelemetry/api</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/_opentelemetry_sdk-node._opentelemetry_api.SpanContext.html" class="tsd-signature-type tsd-kind-interface">SpanContext</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="../modules/_opentelemetry_sdk-node._opentelemetry_api.html" class="tsd-signature-type tsd-kind-namespace">@opentelemetry/api</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/_opentelemetry_sdk-node._opentelemetry_api.Span.html" class="tsd-signature-type tsd-kind-interface">Span</a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Wrap the given <a href="../interfaces/_opentelemetry_sdk-node._opentelemetry_api.SpanContext.html" class="tsd-kind-interface">SpanContext</a> in a new non-recording <a href="../interfaces/_opentelemetry_sdk-node._opentelemetry_api.Span.html" class="tsd-kind-interface">Span</a></p>
|
||
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">spanContext</span>: <a href="../modules/_opentelemetry_sdk-node._opentelemetry_api.html" class="tsd-signature-type tsd-kind-namespace">@opentelemetry/api</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/_opentelemetry_sdk-node._opentelemetry_api.SpanContext.html" class="tsd-signature-type tsd-kind-interface">SpanContext</a></span><div class="tsd-comment tsd-typography"><p>span context to be wrapped</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../modules/_opentelemetry_sdk-node._opentelemetry_api.html" class="tsd-signature-type tsd-kind-namespace">@opentelemetry/api</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/_opentelemetry_sdk-node._opentelemetry_api.Span.html" class="tsd-signature-type tsd-kind-interface">Span</a></h4><p>a new non-recording <a href="../interfaces/_opentelemetry_sdk-node._opentelemetry_api.Span.html" class="tsd-kind-interface">Span</a> with the provided context</p>
|
||
<div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><aside class="tsd-sources"><ul><li>Defined in api/build/src/api/trace.d.ts:33</li></ul></aside></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Methods</h2></summary><section><section class="tsd-panel tsd-member"><a id="disable" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>disable</span><a href="#disable" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="disable-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">disable</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#disable-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Remove the global tracer provider</p>
|
||
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in api/build/src/api/trace.d.ts:32</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="gettracer" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Tracer</span><a href="#gettracer" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="gettracer-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getTracer</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">version</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="../modules/_opentelemetry_sdk-node._opentelemetry_api.html" class="tsd-signature-type tsd-kind-namespace">@opentelemetry/api</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/_opentelemetry_sdk-node._opentelemetry_api.Tracer.html" class="tsd-signature-type tsd-kind-interface">Tracer</a><a href="#gettracer-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns a tracer from the global tracer provider.</p>
|
||
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">version</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../modules/_opentelemetry_sdk-node._opentelemetry_api.html" class="tsd-signature-type tsd-kind-namespace">@opentelemetry/api</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/_opentelemetry_sdk-node._opentelemetry_api.Tracer.html" class="tsd-signature-type tsd-kind-interface">Tracer</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in api/build/src/api/trace.d.ts:30</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="gettracerprovider" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Tracer<wbr/>Provider</span><a href="#gettracerprovider" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="gettracerprovider-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getTracerProvider</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="../modules/_opentelemetry_sdk-node._opentelemetry_api.html" class="tsd-signature-type tsd-kind-namespace">@opentelemetry/api</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/_opentelemetry_sdk-node._opentelemetry_api.TracerProvider.html" class="tsd-signature-type tsd-kind-interface">TracerProvider</a><a href="#gettracerprovider-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the global tracer provider.</p>
|
||
</div><h4 class="tsd-returns-title">Returns <a href="../modules/_opentelemetry_sdk-node._opentelemetry_api.html" class="tsd-signature-type tsd-kind-namespace">@opentelemetry/api</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/_opentelemetry_sdk-node._opentelemetry_api.TracerProvider.html" class="tsd-signature-type tsd-kind-interface">TracerProvider</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in api/build/src/api/trace.d.ts:26</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="setglobaltracerprovider" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Global<wbr/>Tracer<wbr/>Provider</span><a href="#setglobaltracerprovider" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="setglobaltracerprovider-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">setGlobalTracerProvider</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">provider</span><span class="tsd-signature-symbol">:</span> <a href="../modules/_opentelemetry_sdk-node._opentelemetry_api.html" class="tsd-signature-type tsd-kind-namespace">@opentelemetry/api</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/_opentelemetry_sdk-node._opentelemetry_api.TracerProvider.html" class="tsd-signature-type tsd-kind-interface">TracerProvider</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><a href="#setglobaltracerprovider-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Set the current global tracer.</p>
|
||
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">provider</span>: <a href="../modules/_opentelemetry_sdk-node._opentelemetry_api.html" class="tsd-signature-type tsd-kind-namespace">@opentelemetry/api</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/_opentelemetry_sdk-node._opentelemetry_api.TracerProvider.html" class="tsd-signature-type tsd-kind-interface">TracerProvider</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p>true if the tracer provider was successfully registered, else false</p>
|
||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in api/build/src/api/trace.d.ts:22</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="getinstance" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>get<wbr/>Instance</span><a href="#getinstance" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="getinstance-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getInstance</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="../modules/_opentelemetry_sdk-node._opentelemetry_api.html" class="tsd-signature-type tsd-kind-namespace">@opentelemetry/api</a><span class="tsd-signature-symbol">.</span><a href="_opentelemetry_sdk-node._opentelemetry_api.TraceAPI.html" class="tsd-signature-type tsd-kind-class">TraceAPI</a><a href="#getinstance-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get the singleton instance of the Trace API</p>
|
||
</div><h4 class="tsd-returns-title">Returns <a href="../modules/_opentelemetry_sdk-node._opentelemetry_api.html" class="tsd-signature-type tsd-kind-namespace">@opentelemetry/api</a><span class="tsd-signature-symbol">.</span><a href="_opentelemetry_sdk-node._opentelemetry_api.TraceAPI.html" class="tsd-signature-type tsd-kind-class">TraceAPI</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in api/build/src/api/trace.d.ts:16</li></ul></aside></div></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#deletespan" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>delete<wbr/>Span</span></a><a href="#getactivespan" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>get<wbr/>Active<wbr/>Span</span></a><a href="#getspan" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>get<wbr/>Span</span></a><a href="#getspancontext" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>get<wbr/>Span<wbr/>Context</span></a><a href="#isspancontextvalid" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is<wbr/>Span<wbr/>Context<wbr/>Valid</span></a><a href="#setspan" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>set<wbr/>Span</span></a><a href="#setspancontext" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>set<wbr/>Span<wbr/>Context</span></a><a href="#wrapspancontext" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>wrap<wbr/>Span<wbr/>Context</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#disable" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>disable</span></a><a href="#gettracer" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Tracer</span></a><a href="#gettracerprovider" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Tracer<wbr/>Provider</span></a><a href="#setglobaltracerprovider" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Global<wbr/>Tracer<wbr/>Provider</span></a><a href="#getinstance" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Instance</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html">OpenTelemetry SDK</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|