UNPKG

2.56 kBTypeScriptView Raw
1/**
2 * The FORMAT_BINARY format represents SpanContexts in an opaque binary
3 * carrier.
4 *
5 * Tracer.inject() will set the buffer field to an Array-like (Array,
6 * ArrayBuffer, or TypedBuffer) object containing the injected binary data.
7 * Any valid Object can be used as long as the buffer field of the object
8 * can be set.
9 *
10 * Tracer.extract() will look for `carrier.buffer`, and that field is
11 * expected to be an Array-like object (Array, ArrayBuffer, or
12 * TypedBuffer).
13 */
14export declare const FORMAT_BINARY = "binary";
15/**
16 * The FORMAT_TEXT_MAP format represents SpanContexts using a
17 * string->string map (backed by a Javascript Object) as a carrier.
18 *
19 * NOTE: Unlike FORMAT_HTTP_HEADERS, FORMAT_TEXT_MAP places no restrictions
20 * on the characters used in either the keys or the values of the map
21 * entries.
22 *
23 * The FORMAT_TEXT_MAP carrier map may contain unrelated data (e.g.,
24 * arbitrary gRPC metadata); as such, the Tracer implementation should use
25 * a prefix or other convention to distinguish Tracer-specific key:value
26 * pairs.
27 */
28export declare const FORMAT_TEXT_MAP = "text_map";
29/**
30 * The FORMAT_HTTP_HEADERS format represents SpanContexts using a
31 * character-restricted string->string map (backed by a Javascript Object)
32 * as a carrier.
33 *
34 * Keys and values in the FORMAT_HTTP_HEADERS carrier must be suitable for
35 * use as HTTP headers (without modification or further escaping). That is,
36 * the keys have a greatly restricted character set, casing for the keys
37 * may not be preserved by various intermediaries, and the values should be
38 * URL-escaped.
39 *
40 * The FORMAT_HTTP_HEADERS carrier map may contain unrelated data (e.g.,
41 * arbitrary HTTP headers); as such, the Tracer implementation should use a
42 * prefix or other convention to distinguish Tracer-specific key:value
43 * pairs.
44 */
45export declare const FORMAT_HTTP_HEADERS = "http_headers";
46/**
47 * A Span may be the "child of" a parent Span. In a “child of” reference,
48 * the parent Span depends on the child Span in some capacity.
49 *
50 * See more about reference types at https://github.com/opentracing/specification
51 */
52export declare const REFERENCE_CHILD_OF = "child_of";
53/**
54 * Some parent Spans do not depend in any way on the result of their child
55 * Spans. In these cases, we say merely that the child Span “follows from”
56 * the parent Span in a causal sense.
57 *
58 * See more about reference types at https://github.com/opentracing/specification
59 */
60export declare const REFERENCE_FOLLOWS_FROM = "follows_from";
61//# sourceMappingURL=constants.d.ts.map
\No newline at end of file