72 lines
38 KiB
HTML
72 lines
38 KiB
HTML
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Span | 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 async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../index.html">OpenTelemetry SDK</a></li><li><a href="../modules/_opentelemetry_api.html">@opentelemetry/api</a></li><li><a href="_opentelemetry_api.Span.html">Span</a></li></ul><h1>Interface Span </h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>An interface that represents a span. A span represents a single operation
|
|
within a trace. Examples of span might include remote procedure calls or a
|
|
in-process function calls to sub-components. A Trace has a single, top-level
|
|
"root" Span that in turn may have zero or more child Spans, which in turn
|
|
may have children.</p>
|
|
</div><div><p>Spans are created by the <a href="_opentelemetry_api.Tracer.html#startSpan">Tracer.startSpan</a> method.</p>
|
|
</div><dl class="tsd-comment-tags"><dt>since</dt><dd><p>1.0.0</p>
|
|
</dd></dl></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">Span</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-interface"><a href="_opentelemetry_api.Span.html#addEvent" class="tsd-kind-icon">add<wbr/>Event</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="_opentelemetry_api.Span.html#addLink" class="tsd-kind-icon">add<wbr/>Link</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="_opentelemetry_api.Span.html#addLinks" class="tsd-kind-icon">add<wbr/>Links</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="_opentelemetry_api.Span.html#end" class="tsd-kind-icon">end</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="_opentelemetry_api.Span.html#isRecording" class="tsd-kind-icon">is<wbr/>Recording</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="_opentelemetry_api.Span.html#recordException" class="tsd-kind-icon">record<wbr/>Exception</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="_opentelemetry_api.Span.html#setAttribute" class="tsd-kind-icon">set<wbr/>Attribute</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="_opentelemetry_api.Span.html#setAttributes" class="tsd-kind-icon">set<wbr/>Attributes</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="_opentelemetry_api.Span.html#setStatus" class="tsd-kind-icon">set<wbr/>Status</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="_opentelemetry_api.Span.html#spanContext" class="tsd-kind-icon">span<wbr/>Context</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="_opentelemetry_api.Span.html#updateName" class="tsd-kind-icon">update<wbr/>Name</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="addEvent" class="tsd-anchor"></a><h3 class="tsd-anchor-link">add<wbr/>Event<a href="#addEvent" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">add<wbr/>Event<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, attributesOrStartTime<span class="tsd-signature-symbol">?: </span><a href="_opentelemetry_api.Attributes.html" class="tsd-signature-type" data-tsd-kind="Interface">Attributes</a><span class="tsd-signature-symbol"> | </span><a href="../modules/_opentelemetry_api.html#TimeInput" class="tsd-signature-type" data-tsd-kind="Type alias">TimeInput</a>, startTime<span class="tsd-signature-symbol">?: </span><a href="../modules/_opentelemetry_api.html#TimeInput" class="tsd-signature-type" data-tsd-kind="Type alias">TimeInput</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_opentelemetry_api.Span.html" class="tsd-signature-type" data-tsd-kind="Interface">Span</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/open-telemetry/opentelemetry-js/blob/e97cc2e/api/src/trace/span.ts#L76">api/src/trace/span.ts:76</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Adds an event to the Span.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>name: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>the name of the event.</p>
|
|
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> attributesOrStartTime: <a href="_opentelemetry_api.Attributes.html" class="tsd-signature-type" data-tsd-kind="Interface">Attributes</a><span class="tsd-signature-symbol"> | </span><a href="../modules/_opentelemetry_api.html#TimeInput" class="tsd-signature-type" data-tsd-kind="Type alias">TimeInput</a></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> startTime: <a href="../modules/_opentelemetry_api.html#TimeInput" class="tsd-signature-type" data-tsd-kind="Type alias">TimeInput</a></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="_opentelemetry_api.Span.html" class="tsd-signature-type" data-tsd-kind="Interface">Span</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="addLink" class="tsd-anchor"></a><h3 class="tsd-anchor-link">add<wbr/>Link<a href="#addLink" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">add<wbr/>Link<span class="tsd-signature-symbol">(</span>link<span class="tsd-signature-symbol">: </span><a href="_opentelemetry_api.Link.html" class="tsd-signature-type" data-tsd-kind="Interface">Link</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_opentelemetry_api.Span.html" class="tsd-signature-type" data-tsd-kind="Interface">Span</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/open-telemetry/opentelemetry-js/blob/e97cc2e/api/src/trace/span.ts#L90">api/src/trace/span.ts:90</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Adds a single link to the span.</p>
|
|
</div><div><p>Links added after the creation will not affect the sampling decision.
|
|
It is preferred span links be added at span creation.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>link: <a href="_opentelemetry_api.Link.html" class="tsd-signature-type" data-tsd-kind="Interface">Link</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>the link to add.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="_opentelemetry_api.Span.html" class="tsd-signature-type" data-tsd-kind="Interface">Span</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="addLinks" class="tsd-anchor"></a><h3 class="tsd-anchor-link">add<wbr/>Links<a href="#addLinks" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">add<wbr/>Links<span class="tsd-signature-symbol">(</span>links<span class="tsd-signature-symbol">: </span><a href="_opentelemetry_api.Link.html" class="tsd-signature-type" data-tsd-kind="Interface">Link</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_opentelemetry_api.Span.html" class="tsd-signature-type" data-tsd-kind="Interface">Span</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/open-telemetry/opentelemetry-js/blob/e97cc2e/api/src/trace/span.ts#L100">api/src/trace/span.ts:100</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Adds multiple links to the span.</p>
|
|
</div><div><p>Links added after the creation will not affect the sampling decision.
|
|
It is preferred span links be added at span creation.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>links: <a href="_opentelemetry_api.Link.html" class="tsd-signature-type" data-tsd-kind="Interface">Link</a><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>the links to add.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="_opentelemetry_api.Span.html" class="tsd-signature-type" data-tsd-kind="Interface">Span</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="end" class="tsd-anchor"></a><h3 class="tsd-anchor-link">end<a href="#end" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">end<span class="tsd-signature-symbol">(</span>endTime<span class="tsd-signature-symbol">?: </span><a href="../modules/_opentelemetry_api.html#TimeInput" class="tsd-signature-type" data-tsd-kind="Type alias">TimeInput</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/open-telemetry/opentelemetry-js/blob/e97cc2e/api/src/trace/span.ts#L135">api/src/trace/span.ts:135</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Marks the end of Span execution.</p>
|
|
</div><div><p>Call to End of a Span MUST not have any effects on child spans. Those may
|
|
still be running and can be ended later.</p>
|
|
<p>Do not return <code>this</code>. The Span generally should not be used after it
|
|
is ended so chaining is not desired in this context.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> endTime: <a href="../modules/_opentelemetry_api.html#TimeInput" class="tsd-signature-type" data-tsd-kind="Type alias">TimeInput</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="isRecording" class="tsd-anchor"></a><h3 class="tsd-anchor-link">is<wbr/>Recording<a href="#isRecording" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">is<wbr/>Recording<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/open-telemetry/opentelemetry-js/blob/e97cc2e/api/src/trace/span.ts#L143">api/src/trace/span.ts:143</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Returns the flag whether this span will be recorded.</p>
|
|
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><div><p>true if this Span is active and recording information like events
|
|
with the <code>AddEvent</code> operation and attributes using <code>setAttributes</code>.</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="recordException" class="tsd-anchor"></a><h3 class="tsd-anchor-link">record<wbr/>Exception<a href="#recordException" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">record<wbr/>Exception<span class="tsd-signature-symbol">(</span>exception<span class="tsd-signature-symbol">: </span><a href="../modules/_opentelemetry_api.html#Exception" class="tsd-signature-type" data-tsd-kind="Type alias">Exception</a>, time<span class="tsd-signature-symbol">?: </span><a href="../modules/_opentelemetry_api.html#TimeInput" class="tsd-signature-type" data-tsd-kind="Type alias">TimeInput</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/open-telemetry/opentelemetry-js/blob/e97cc2e/api/src/trace/span.ts#L151">api/src/trace/span.ts:151</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Sets exception as a span event</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>exception: <a href="../modules/_opentelemetry_api.html#Exception" class="tsd-signature-type" data-tsd-kind="Type alias">Exception</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>the exception the only accepted values are string or Error</p>
|
|
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> time: <a href="../modules/_opentelemetry_api.html#TimeInput" class="tsd-signature-type" data-tsd-kind="Type alias">TimeInput</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="setAttribute" class="tsd-anchor"></a><h3 class="tsd-anchor-link">set<wbr/>Attribute<a href="#setAttribute" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">set<wbr/>Attribute<span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, value<span class="tsd-signature-symbol">: </span><a href="../modules/_opentelemetry_api.html#AttributeValue" class="tsd-signature-type" data-tsd-kind="Type alias">AttributeValue</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_opentelemetry_api.Span.html" class="tsd-signature-type" data-tsd-kind="Interface">Span</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/open-telemetry/opentelemetry-js/blob/e97cc2e/api/src/trace/span.ts#L56">api/src/trace/span.ts:56</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Sets an attribute to the span.</p>
|
|
</div><div><p>Sets a single Attribute with the key and value passed as arguments.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>key: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>the key for this attribute.</p>
|
|
</div></div></li><li><h5>value: <a href="../modules/_opentelemetry_api.html#AttributeValue" class="tsd-signature-type" data-tsd-kind="Type alias">AttributeValue</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>the value for this attribute. Setting a value null or
|
|
undefined is invalid and will result in undefined behavior.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="_opentelemetry_api.Span.html" class="tsd-signature-type" data-tsd-kind="Interface">Span</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="setAttributes" class="tsd-anchor"></a><h3 class="tsd-anchor-link">set<wbr/>Attributes<a href="#setAttributes" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">set<wbr/>Attributes<span class="tsd-signature-symbol">(</span>attributes<span class="tsd-signature-symbol">: </span><a href="_opentelemetry_api.Attributes.html" class="tsd-signature-type" data-tsd-kind="Interface">Attributes</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_opentelemetry_api.Span.html" class="tsd-signature-type" data-tsd-kind="Interface">Span</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/open-telemetry/opentelemetry-js/blob/e97cc2e/api/src/trace/span.ts#L65">api/src/trace/span.ts:65</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Sets attributes to the span.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>attributes: <a href="_opentelemetry_api.Attributes.html" class="tsd-signature-type" data-tsd-kind="Interface">Attributes</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>the attributes that will be added.
|
|
null or undefined attribute values
|
|
are invalid and will result in undefined behavior.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="_opentelemetry_api.Span.html" class="tsd-signature-type" data-tsd-kind="Interface">Span</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="setStatus" class="tsd-anchor"></a><h3 class="tsd-anchor-link">set<wbr/>Status<a href="#setStatus" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">set<wbr/>Status<span class="tsd-signature-symbol">(</span>status<span class="tsd-signature-symbol">: </span><a href="_opentelemetry_api.SpanStatus.html" class="tsd-signature-type" data-tsd-kind="Interface">SpanStatus</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_opentelemetry_api.Span.html" class="tsd-signature-type" data-tsd-kind="Interface">Span</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/open-telemetry/opentelemetry-js/blob/e97cc2e/api/src/trace/span.ts#L109">api/src/trace/span.ts:109</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Sets a status to the span. If used, this will override the default Span
|
|
status. Default is <a href="../enums/_opentelemetry_api.SpanStatusCode.html#UNSET">SpanStatusCode.UNSET</a>. SetStatus overrides the value
|
|
of previous calls to SetStatus on the Span.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>status: <a href="_opentelemetry_api.SpanStatus.html" class="tsd-signature-type" data-tsd-kind="Interface">SpanStatus</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>the SpanStatus to set.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="_opentelemetry_api.Span.html" class="tsd-signature-type" data-tsd-kind="Interface">Span</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="spanContext" class="tsd-anchor"></a><h3 class="tsd-anchor-link">span<wbr/>Context<a href="#spanContext" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">span<wbr/>Context<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_opentelemetry_api.SpanContext.html" class="tsd-signature-type" data-tsd-kind="Interface">SpanContext</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/open-telemetry/opentelemetry-js/blob/e97cc2e/api/src/trace/span.ts#L45">api/src/trace/span.ts:45</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Returns the <a href="_opentelemetry_api.SpanContext.html">SpanContext</a> object associated with this Span.</p>
|
|
</div><div><p>Get an immutable, serializable identifier for this span that can be used
|
|
to create new child spans. Returned SpanContext is usable even after the
|
|
span ends.</p>
|
|
</div></div><h4 class="tsd-returns-title">Returns <a href="_opentelemetry_api.SpanContext.html" class="tsd-signature-type" data-tsd-kind="Interface">SpanContext</a></h4><div><p>the SpanContext object associated with this Span.</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="updateName" class="tsd-anchor"></a><h3 class="tsd-anchor-link">update<wbr/>Name<a href="#updateName" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">update<wbr/>Name<span class="tsd-signature-symbol">(</span>name<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="_opentelemetry_api.Span.html" class="tsd-signature-type" data-tsd-kind="Interface">Span</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/open-telemetry/opentelemetry-js/blob/e97cc2e/api/src/trace/span.ts#L121">api/src/trace/span.ts:121</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Updates the Span name.</p>
|
|
</div><div><p>This will override the name provided via <a href="_opentelemetry_api.Tracer.html#startSpan">Tracer.startSpan</a>.</p>
|
|
<p>Upon this update, any sampling behavior based on Span name will depend on
|
|
the implementation.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>name: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>the Span name.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="_opentelemetry_api.Span.html" class="tsd-signature-type" data-tsd-kind="Interface">Span</a></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../index.html">Modules</a></li><li class="current tsd-kind-module"><a href="../modules/_opentelemetry_api.html">@opentelemetry/api</a><ul><li class=" tsd-kind-module tsd-parent-kind-module"><a href="../modules/_opentelemetry_api._internal_.html"><internal></a></li></ul></li><li class=" tsd-kind-module"><a href="../modules/_opentelemetry_api_events.html">@opentelemetry/api-<wbr/>events</a></li><li class=" tsd-kind-module"><a href="../modules/_opentelemetry_api_logs.html">@opentelemetry/api-<wbr/>logs</a></li><li class=" tsd-kind-module"><a href="../modules/_opentelemetry_context_async_hooks.html">@opentelemetry/context-<wbr/>async-<wbr/>hooks</a></li><li class=" tsd-kind-module"><a href="../modules/_opentelemetry_context_zone.html">@opentelemetry/context-<wbr/>zone</a></li><li class=" tsd-kind-module"><a href="../modules/_opentelemetry_context_zone_peer_dep.html">@opentelemetry/context-<wbr/>zone-<wbr/>peer-<wbr/>dep</a></li><li class=" tsd-kind-module"><a href="../modules/_opentelemetry_core.html">@opentelemetry/core</a></li><li class=" tsd-kind-module"><a href="../modules/_opentelemetry_exporter_jaeger.html">@opentelemetry/exporter-<wbr/>jaeger</a></li><li class=" tsd-kind-module"><a href="../modules/_opentelemetry_exporter_logs_otlp_grpc.html">@opentelemetry/exporter-<wbr/>logs-<wbr/>otlp-<wbr/>grpc</a></li><li class=" tsd-kind-module"><a href="../modules/_opentelemetry_exporter_logs_otlp_http.html">@opentelemetry/exporter-<wbr/>logs-<wbr/>otlp-<wbr/>http</a></li><li class=" tsd-kind-module"><a href="../modules/_opentelemetry_exporter_logs_otlp_proto.html">@opentelemetry/exporter-<wbr/>logs-<wbr/>otlp-<wbr/>proto</a></li><li class=" tsd-kind-module"><a href="../modules/_opentelemetry_exporter_metrics_otlp_grpc.html">@opentelemetry/exporter-<wbr/>metrics-<wbr/>otlp-<wbr/>grpc</a></li><li class=" tsd-kind-module"><a href="../modules/_opentelemetry_exporter_metrics_otlp_http.html">@opentelemetry/exporter-<wbr/>metrics-<wbr/>otlp-<wbr/>http</a></li><li class=" tsd-kind-module"><a href="../modules/_opentelemetry_exporter_metrics_otlp_proto.html">@opentelemetry/exporter-<wbr/>metrics-<wbr/>otlp-<wbr/>proto</a></li><li class=" tsd-kind-module"><a href="../modules/_opentelemetry_exporter_prometheus.html">@opentelemetry/exporter-<wbr/>prometheus</a></li><li class=" tsd-kind-module"><a href="../modules/_opentelemetry_exporter_trace_otlp_grpc.html">@opentelemetry/exporter-<wbr/>trace-<wbr/>otlp-<wbr/>grpc</a></li><li class=" tsd-kind-module"><a href="../modules/_opentelemetry_exporter_trace_otlp_http.html">@opentelemetry/exporter-<wbr/>trace-<wbr/>otlp-<wbr/>http</a></li><li class=" tsd-kind-module"><a href="../modules/_opentelemetry_exporter_trace_otlp_proto.html">@opentelemetry/exporter-<wbr/>trace-<wbr/>otlp-<wbr/>proto</a></li><li class=" tsd-kind-module"><a href="../modules/_opentelemetry_exporter_zipkin.html">@opentelemetry/exporter-<wbr/>zipkin</a></li><li class=" tsd-kind-module"><a href="../modules/_opentelemetry_instrumentation.html">@opentelemetry/instrumentation</a></li><li class=" tsd-kind-module"><a href="../modules/_opentelemetry_instrumentation_fetch.html">@opentelemetry/instrumentation-<wbr/>fetch</a></li><li class=" tsd-kind-module"><a href="../modules/_opentelemetry_instrumentation_grpc.html">@opentelemetry/instrumentation-<wbr/>grpc</a></li><li class=" tsd-kind-module"><a href="../modules/_opentelemetry_instrumentation_http.html">@opentelemetry/instrumentation-<wbr/>http</a></li><li class=" tsd-kind-module"><a href="../modules/_opentelemetry_instrumentation_xml_http_request.html">@opentelemetry/instrumentation-<wbr/>xml-<wbr/>http-<wbr/>request</a></li><li class=" tsd-kind-module"><a href="../modules/_opentelemetry_opentelemetry_browser_detector.html">@opentelemetry/opentelemetry-<wbr/>browser-<wbr/>detector</a></li><li class=" tsd-kind-module"><a href="../modules/_opentelemetry_otlp_exporter_base.html">@opentelemetry/otlp-<wbr/>exporter-<wbr/>base</a></li><li class=" tsd-kind-module"><a href="../modules/_opentelemetry_otlp_grpc_exporter_base.html">@opentelemetry/otlp-<wbr/>grpc-<wbr/>exporter-<wbr/>base</a></li><li class=" tsd-kind-module"><a href="../modules/_opentelemetry_otlp_transformer.html">@opentelemetry/otlp-<wbr/>transformer</a></li><li class=" tsd-kind-module"><a href="../modules/_opentelemetry_propagator_b3.html">@opentelemetry/propagator-<wbr/>b3</a></li><li class=" tsd-kind-module"><a href="../modules/_opentelemetry_propagator_jaeger.html">@opentelemetry/propagator-<wbr/>jaeger</a></li><li class=" tsd-kind-module"><a href="../modules/_opentelemetry_resources.html">@opentelemetry/resources</a></li><li class=" tsd-kind-module"><a href="../modules/_opentelemetry_sampler_jaeger_remote.html">@opentelemetry/sampler-<wbr/>jaeger-<wbr/>remote</a></li><li class=" tsd-kind-module"><a href="../modules/_opentelemetry_sdk_events.html">@opentelemetry/sdk-<wbr/>events</a></li><li class=" tsd-kind-module"><a href="../modules/_opentelemetry_sdk_logs.html">@opentelemetry/sdk-<wbr/>logs</a></li><li class=" tsd-kind-module"><a href="../modules/_opentelemetry_sdk_metrics.html">@opentelemetry/sdk-<wbr/>metrics</a></li><li class=" tsd-kind-module"><a href="../modules/_opentelemetry_sdk_node.html">@opentelemetry/sdk-<wbr/>node</a></li><li class=" tsd-kind-module"><a href="../modules/_opentelemetry_sdk_trace_base.html">@opentelemetry/sdk-<wbr/>trace-<wbr/>base</a></li><li class=" tsd-kind-module"><a href="../modules/_opentelemetry_sdk_trace_node.html">@opentelemetry/sdk-<wbr/>trace-<wbr/>node</a></li><li class=" tsd-kind-module"><a href="../modules/_opentelemetry_sdk_trace_web.html">@opentelemetry/sdk-<wbr/>trace-<wbr/>web</a></li><li class=" tsd-kind-module"><a href="../modules/_opentelemetry_semantic_conventions.html">@opentelemetry/semantic-<wbr/>conventions</a></li><li class=" tsd-kind-module"><a href="../modules/_opentelemetry_shim_opencensus.html">@opentelemetry/shim-<wbr/>opencensus</a></li><li class=" tsd-kind-module"><a href="../modules/_opentelemetry_shim_opentracing.html">@opentelemetry/shim-<wbr/>opentracing</a></li><li class=" tsd-kind-module"><a href="../modules/_opentelemetry_web_common.html">@opentelemetry/web-<wbr/>common</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface tsd-parent-kind-module"><a href="_opentelemetry_api.Span.html" class="tsd-kind-icon">Span</a><ul><li class="tsd-kind-method tsd-parent-kind-interface"><a href="_opentelemetry_api.Span.html#addEvent" class="tsd-kind-icon">add<wbr/>Event</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="_opentelemetry_api.Span.html#addLink" class="tsd-kind-icon">add<wbr/>Link</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="_opentelemetry_api.Span.html#addLinks" class="tsd-kind-icon">add<wbr/>Links</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="_opentelemetry_api.Span.html#end" class="tsd-kind-icon">end</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="_opentelemetry_api.Span.html#isRecording" class="tsd-kind-icon">is<wbr/>Recording</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="_opentelemetry_api.Span.html#recordException" class="tsd-kind-icon">record<wbr/>Exception</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="_opentelemetry_api.Span.html#setAttribute" class="tsd-kind-icon">set<wbr/>Attribute</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="_opentelemetry_api.Span.html#setAttributes" class="tsd-kind-icon">set<wbr/>Attributes</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="_opentelemetry_api.Span.html#setStatus" class="tsd-kind-icon">set<wbr/>Status</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="_opentelemetry_api.Span.html#spanContext" class="tsd-kind-icon">span<wbr/>Context</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="_opentelemetry_api.Span.html#updateName" class="tsd-kind-icon">update<wbr/>Name</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li><li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li><li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li><li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li><li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li><li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li><li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html> |