Variable
Static Public Summary | ||
public |
The FORMAT_BINARY format represents SpanContexts in an opaque binary carrier. |
|
public |
The FORMAT_HTTP_HEADERS format represents SpanContexts using a character-restricted string->string map (backed by a Javascript Object) as a carrier. |
|
public |
The FORMAT_TEXT_MAP format represents SpanContexts using a string->string map (backed by a Javascript Object) as a carrier. |
|
public |
A Span may be the "child of" a parent Span. |
|
public |
Some parent Spans do not depend in any way on the result of their child Spans. |
Static Public
public FORMAT_BINARY: string source
import {FORMAT_BINARY} from 'opentracing/src/constants.js'
The FORMAT_BINARY format represents SpanContexts in an opaque binary carrier.
Tracer.inject() will set the buffer field to an Array-like (Array, ArrayBuffer, or TypedBuffer) object containing the injected binary data. Any valid Object can be used as long as the buffer field of the object can be set.
Tracer.extract() will look for carrier.buffer
, and that field is
expected to be an Array-like object (Array, ArrayBuffer, or
TypedBuffer).
public FORMAT_HTTP_HEADERS: string source
import {FORMAT_HTTP_HEADERS} from 'opentracing/src/constants.js'
The FORMAT_HTTP_HEADERS format represents SpanContexts using a character-restricted string->string map (backed by a Javascript Object) as a carrier.
Keys and values in the FORMAT_HTTP_HEADERS carrier must be suitable for use as HTTP headers (without modification or further escaping). That is, the keys have a greatly restricted character set, casing for the keys may not be preserved by various intermediaries, and the values should be URL-escaped.
The FORMAT_HTTP_HEADERS carrier map may contain unrelated data (e.g., arbitrary HTTP headers); as such, the Tracer implementation should use a prefix or other convention to distinguish Tracer-specific key:value pairs.
public FORMAT_TEXT_MAP: string source
import {FORMAT_TEXT_MAP} from 'opentracing/src/constants.js'
The FORMAT_TEXT_MAP format represents SpanContexts using a string->string map (backed by a Javascript Object) as a carrier.
NOTE: Unlike FORMAT_HTTP_HEADERS, FORMAT_TEXT_MAP places no restrictions on the characters used in either the keys or the values of the map entries.
The FORMAT_TEXT_MAP carrier map may contain unrelated data (e.g., arbitrary gRPC metadata); as such, the Tracer implementation should use a prefix or other convention to distinguish Tracer-specific key:value pairs.
public REFERENCE_CHILD_OF: string source
import {REFERENCE_CHILD_OF} from 'opentracing/src/constants.js'
A Span may be the "child of" a parent Span. In a “child of” reference, the parent Span depends on the child Span in some capacity.
See more about reference types at http://opentracing.io/spec/
public REFERENCE_FOLLOWS_FROM: string source
import {REFERENCE_FOLLOWS_FROM} from 'opentracing/src/constants.js'
Some parent Spans do not depend in any way on the result of their child Spans. In these cases, we say merely that the child Span “follows from” the parent Span in a causal sense.
See more about reference types at http://opentracing.io/spec/