36 lines
20 KiB
HTML
36 lines
20 KiB
HTML
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>SpanContext | 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.SpanContext.html">SpanContext</a></li></ul><h1>Interface SpanContext </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>A SpanContext represents the portion of a <a href="_opentelemetry_api.Span.html">Span</a> which must be
|
|
serialized and propagated along side of a <a href="_opentelemetry_api.Baggage.html">Baggage</a>.</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">SpanContext</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>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_opentelemetry_api.SpanContext.html#isRemote" class="tsd-kind-icon">is<wbr/>Remote</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_opentelemetry_api.SpanContext.html#spanId" class="tsd-kind-icon">span<wbr/>Id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_opentelemetry_api.SpanContext.html#traceFlags" class="tsd-kind-icon">trace<wbr/>Flags</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_opentelemetry_api.SpanContext.html#traceId" class="tsd-kind-icon">trace<wbr/>Id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_opentelemetry_api.SpanContext.html#traceState" class="tsd-kind-icon">trace<wbr/>State</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="isRemote" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> is<wbr/>Remote<a href="#isRemote" 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><div class="tsd-signature tsd-kind-icon">is<wbr/>Remote<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/open-telemetry/opentelemetry-js/blob/e97cc2e/api/src/trace/span_context.ts#L42">api/src/trace/span_context.ts:42</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Only true if the SpanContext was propagated from a remote parent.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="spanId" class="tsd-anchor"></a><h3 class="tsd-anchor-link">span<wbr/>Id<a href="#spanId" 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><div class="tsd-signature tsd-kind-icon">span<wbr/>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/open-telemetry/opentelemetry-js/blob/e97cc2e/api/src/trace/span_context.ts#L38">api/src/trace/span_context.ts:38</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The ID of the Span. It is globally unique with practically sufficient
|
|
probability by being made as 8 randomly generated bytes, encoded as a 16
|
|
lowercase hex characters corresponding to 64 bits.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="traceFlags" class="tsd-anchor"></a><h3 class="tsd-anchor-link">trace<wbr/>Flags<a href="#traceFlags" 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><div class="tsd-signature tsd-kind-icon">trace<wbr/>Flags<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/open-telemetry/opentelemetry-js/blob/e97cc2e/api/src/trace/span_context.ts#L53">api/src/trace/span_context.ts:53</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Trace flags to propagate.</p>
|
|
</div><div><p>It is represented as 1 byte (bitmap). Bit to represent whether trace is
|
|
sampled or not. When set, the least significant bit documents that the
|
|
caller may have recorded trace data. A caller who does not record trace
|
|
data out-of-band leaves this flag unset.</p>
|
|
<p>see <a href="../enums/_opentelemetry_api.TraceFlags.html">TraceFlags</a> for valid flag values.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="traceId" class="tsd-anchor"></a><h3 class="tsd-anchor-link">trace<wbr/>Id<a href="#traceId" 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><div class="tsd-signature tsd-kind-icon">trace<wbr/>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/open-telemetry/opentelemetry-js/blob/e97cc2e/api/src/trace/span_context.ts#L32">api/src/trace/span_context.ts:32</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The ID of the trace that this span belongs to. It is worldwide unique
|
|
with practically sufficient probability by being made as 16 randomly
|
|
generated bytes, encoded as a 32 lowercase hex characters corresponding to
|
|
128 bits.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="traceState" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> trace<wbr/>State<a href="#traceState" 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><div class="tsd-signature tsd-kind-icon">trace<wbr/>State<span class="tsd-signature-symbol">?:</span> <a href="_opentelemetry_api.TraceState.html" class="tsd-signature-type" data-tsd-kind="Interface">TraceState</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/open-telemetry/opentelemetry-js/blob/e97cc2e/api/src/trace/span_context.ts#L70">api/src/trace/span_context.ts:70</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Tracing-system-specific info to propagate.</p>
|
|
</div><div><p>The tracestate field value is a <code>list</code> as defined below. The <code>list</code> is a
|
|
series of <code>list-members</code> separated by commas <code>,</code>, and a list-member is a
|
|
key/value pair separated by an equals sign <code>=</code>. Spaces and horizontal tabs
|
|
surrounding <code>list-members</code> are ignored. There can be a maximum of 32
|
|
<code>list-members</code> in a <code>list</code>.
|
|
More Info: <a href="https://www.w3.org/TR/trace-context/#tracestate-field">https://www.w3.org/TR/trace-context/#tracestate-field</a></p>
|
|
<p>Examples:
|
|
Single tracing system (generic format):
|
|
tracestate: rojo=00f067aa0ba902b7
|
|
Multiple tracing systems (with different formatting):
|
|
tracestate: rojo=00f067aa0ba902b7,congo=t61rcWkgMzE</p>
|
|
</div></div></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.SpanContext.html" class="tsd-kind-icon">Span<wbr/>Context</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_opentelemetry_api.SpanContext.html#isRemote" class="tsd-kind-icon">is<wbr/>Remote</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_opentelemetry_api.SpanContext.html#spanId" class="tsd-kind-icon">span<wbr/>Id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_opentelemetry_api.SpanContext.html#traceFlags" class="tsd-kind-icon">trace<wbr/>Flags</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_opentelemetry_api.SpanContext.html#traceId" class="tsd-kind-icon">trace<wbr/>Id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_opentelemetry_api.SpanContext.html#traceState" class="tsd-kind-icon">trace<wbr/>State</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-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</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> |