Options
All
  • Public
  • Public/Protected
  • All
Menu

opentracing

Index

Variables

COMPONENT

COMPONENT: "component" = "component"

COMPONENT (string) ia s low-cardinality identifier of the module, library, or package that is generating a span.

DB_INSTANCE

DB_INSTANCE: "db.instance" = "db.instance"

DB_INSTANCE (string) Database instance name. E.g., In java, if the jdbc.url="jdbc:mysql://127.0.0.1:3306/customers", the instance name is "customers".

DB_STATEMENT

DB_STATEMENT: "db.statement" = "db.statement"

DB_STATEMENT (string) A database statement for the given database type. E.g., for db.type="SQL", "SELECT * FROM wuser_table"; for db.type="redis", "SET mykey 'WuValue'".

DB_TYPE

DB_TYPE: "db.type" = "db.type"

DB_TYPE (string) Database type. For any SQL database, "sql". For others, the lower-case database category, e.g. "cassandra", "hbase", or "redis".

DB_USER

DB_USER: "db.user" = "db.user"

DB_USER (string) Username for accessing database. E.g., "readonly_user" or "reporting_user"

ERROR

ERROR: "error" = "error"

ERROR (boolean) true if and only if the application considers the operation represented by the Span to have failed

FORMAT_BINARY

FORMAT_BINARY: "binary" = "binary"

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).

FORMAT_HTTP_HEADERS

FORMAT_HTTP_HEADERS: "http_headers" = "http_headers"

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.

FORMAT_TEXT_MAP

FORMAT_TEXT_MAP: "text_map" = "text_map"

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.

HTTP_METHOD

HTTP_METHOD: "http.method" = "http.method"

HTTP_METHOD (string) HTTP method of the request for the associated Span. E.g., "GET", "POST"

HTTP_STATUS_CODE

HTTP_STATUS_CODE: "http.status_code" = "http.status_code"

HTTP_STATUS_CODE (number) HTTP response status code for the associated Span. E.g., 200, 503, 404

HTTP_URL

HTTP_URL: "http.url" = "http.url"

HTTP_URL (string) URL of the request being handled in this segment of the trace, in standard URI format. E.g., "https://domain.net/path/to?resource=here"

MESSAGE_BUS_DESTINATION

MESSAGE_BUS_DESTINATION: "message_bus.destination" = "message_bus.destination"

MESSAGE_BUS_DESTINATION (string) An address at which messages can be exchanged. E.g. A Kafka record has an associated "topic name" that can be extracted by the instrumented producer or consumer and stored using this tag.

PEER_ADDRESS

PEER_ADDRESS: "peer.address" = "peer.address"

PEER_ADDRESS (string) Remote "address", suitable for use in a networking client library. This may be a "ip:port", a bare "hostname", a FQDN, or even a JDBC substring like "mysql://prod-db:3306"

PEER_HOSTNAME

PEER_HOSTNAME: "peer.hostname" = "peer.hostname"

PEER_HOSTNAME (string) Remote hostname. E.g., "opentracing.io", "internal.dns.name"

PEER_HOST_IPV4

PEER_HOST_IPV4: "peer.ipv4" = "peer.ipv4"

PEER_HOST_IPV4 (number) Remote IPv4 address as a .-separated tuple. E.g., "127.0.0.1"

PEER_HOST_IPV6

PEER_HOST_IPV6: "peer.ipv6" = "peer.ipv6"

PEER_PORT

PEER_PORT: "peer.port" = "peer.port"

PEER_SERVICE

PEER_SERVICE: "peer.service" = "peer.service"

PEER_SERVICE (string) Remote service name (for some unspecified definition of "service"). E.g., "elasticsearch", "a_custom_microservice", "memcache"

REFERENCE_CHILD_OF

REFERENCE_CHILD_OF: "child_of" = "child_of"

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/

REFERENCE_FOLLOWS_FROM

REFERENCE_FOLLOWS_FROM: "follows_from" = "follows_from"

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/

SAMPLING_PRIORITY

SAMPLING_PRIORITY: "sampling.priority" = "sampling.priority"

SAMPLING_PRIORITY (number) determines the priority of sampling this Span. If greater than 0, a hint to the Tracer to do its best to capture the trace. If 0, a hint to the trace to not-capture the trace. If absent, the Tracer should use its default sampling mechanism.

SPAN_KIND

SPAN_KIND: "span.kind" = "span.kind"

SPAN_KIND hints at relationship between spans, e.g. client/server

SPAN_KIND_MESSAGING_CONSUMER

SPAN_KIND_MESSAGING_CONSUMER: "consumer" = "consumer"

Marks a span representing the consuming-side within a messaging system or other remote call

SPAN_KIND_MESSAGING_PRODUCER

SPAN_KIND_MESSAGING_PRODUCER: "producer" = "producer"

Marks a span representing the producing-side within a messaging system or other remote call

SPAN_KIND_RPC_CLIENT

SPAN_KIND_RPC_CLIENT: "client" = "client"

Marks a span representing the client-side of an RPC or other remote call

SPAN_KIND_RPC_SERVER

SPAN_KIND_RPC_SERVER: "server" = "server"

Marks a span representing the server-side of an RPC or other remote call

_globalTracer

_globalTracer: Tracer | null = null

globalTracerDelegate

globalTracerDelegate: GlobalTracerDelegate = new GlobalTracerDelegate()

noopTracer

noopTracer: Tracer = new Tracer()

parent

parent: Span = tracer.startSpan('parent_span')

span

span: Span | null = null

spanContext

spanContext: SpanContext | null = null

tracer

tracer: MockTracer = new MockTracer()

Functions

apiCompatibilityChecks

  • A function that takes a tracer factory, and tests wheter the initialized tracer fulfills Opentracing's api requirements.

    Parameters

    • Default value createTracer: (Anonymous function) = () => new Tracer()

      a factory function that allocates a tracer.

    • Default value options: ApiCompatibilityChecksOptions = {}

    Returns void

childOf

  • Return a new REFERENCE_CHILD_OF reference.

    Parameters

    • spanContext: SpanContext | Span

      the parent SpanContext instance to reference.

    Returns Reference

    a REFERENCE_CHILD_OF reference pointing to spanContext

followsFrom

  • Return a new REFERENCE_FOLLOWS_FROM reference.

    Parameters

    • spanContext: SpanContext

      the parent SpanContext instance to reference.

    Returns Reference

    a REFERENCE_FOLLOWS_FROM reference pointing to spanContext

globalTracer

initGlobalTracer

  • initGlobalTracer(tracer: Tracer): void
  • Set the global Tracer.

    The behavior is undefined if this function is called more than once.

    Parameters

    • tracer: Tracer

      the Tracer implementation

    Returns void

initialize

  • initialize(): void

noopImplementationTests

  • noopImplementationTests(createTracer?: (Anonymous function)): void

opentracingAPITests

  • opentracingAPITests(): void

Generated using TypeDoc