Logo for jsDocs.io

@opencensus/propagation-b3

  • Version 0.1.0
  • Published
  • 24.8 kB
  • 2 dependencies
  • Apache-2.0 license

Install

npm i @opencensus/propagation-b3
yarn add @opencensus/propagation-b3
pnpm add @opencensus/propagation-b3

Overview

Opencensus propagation package for B3 format.

Index

Variables

Classes

Variables

variable NOT_SAMPLED_VALUE

const NOT_SAMPLED_VALUE: number;

    variable SAMPLED_VALUE

    const SAMPLED_VALUE: number;

      variable X_B3_PARENT_SPAN_ID

      const X_B3_PARENT_SPAN_ID: string;

        variable X_B3_SAMPLED

        const X_B3_SAMPLED: string;

          variable X_B3_SPAN_ID

          const X_B3_SPAN_ID: string;

            variable X_B3_TRACE_ID

            const X_B3_TRACE_ID: string;

              Classes

              class B3Format

              class B3Format implements Propagation {}

              • Propagates span context through B3 Format propagation.

              method extract

              extract: (getter: HeaderGetter) => SpanContext | null;

              • Gets the trace context from a request headers. If there is no trace context in the headers, null is returned.

                Parameter getter

              method generate

              generate: () => SpanContext;

              • Generate SpanContexts

              method inject

              inject: (setter: HeaderSetter, spanContext: SpanContext) => void;

              • Adds a trace context in a request headers.

                Parameter setter

                Parameter spanContext

              Package Files (2)

              Dependencies (2)

              Dev Dependencies (11)

              Peer Dependencies (0)

              No peer dependencies.

              Badge

              To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

              You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@opencensus/propagation-b3.

              • Markdown
                [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@opencensus/propagation-b3)
              • HTML
                <a href="https://www.jsdocs.io/package/@opencensus/propagation-b3"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>