Class ProxyTracer

constructor

• new ProxyTracer(
      provider: @opentelemetry/api.TracerDelegator,
      name: string,
      version?: string,
      options?: @opentelemetry/api.TracerOptions,
  ): @opentelemetry/api.ProxyTracer

  Parameters

  • provider: @opentelemetry/api.TracerDelegator
  • name: string
  • Optionalversion: string
  • Optionaloptions: @opentelemetry/api.TracerOptions

  Returns @opentelemetry/api.ProxyTracer

Readonlyname

Optional Readonlyoptions

Optional Readonlyversion

startActiveSpan

• startActiveSpan<F extends (span: @opentelemetry/api.Span) => unknown>(
      _name: string,
      _options: @opentelemetry/api.SpanOptions | F,
      _context?: @opentelemetry/api.Context | F,
      _fn?: F,
  ): ReturnType<F>

  Starts a new Span and calls the given function passing it the created span as first argument. Additionally the new span gets set in context and this context is activated for the duration of the function call.

  Important: The callback function is responsible for calling span.end() to finish the span. Unlike some other OpenTelemetry implementations, the span is NOT automatically ended when the callback returns. If span.end() is not called, the span will never be exported and will be silently lost.

  Type Parameters

  • F extends (span: @opentelemetry/api.Span) => unknown

  Parameters

  • _name: string

    The name of the span

  • _options: @opentelemetry/api.SpanOptions | F

    function called in the context of the span and receives the newly created span as an argument

  • Optional_context: @opentelemetry/api.Context | F
  • Optional_fn: F

  Returns ReturnType<F>

  return value of fn

  Example

  const something = tracer.startActiveSpan('op', span => {
        try {
          do some work
          span.setStatus({code: SpanStatusCode.OK});
          return something;
        } catch (err) {
          span.setStatus({
            code: SpanStatusCode.ERROR,
            message: err.message,
          });
          throw err;
        } finally {
          span.end();
        }
      });
  Copy

  Example

  const span = tracer.startActiveSpan('op', span => {
        try {
          do some work
          return span;
        } catch (err) {
          span.setStatus({
            code: SpanStatusCode.ERROR,
            message: err.message,
          });
          throw err;
        }
      });
      do some more work
      span.end();
  Copy

startSpan

• startSpan(
      name: string,
      options?: @opentelemetry/api.SpanOptions,
      context?: @opentelemetry/api.Context,
  ): @opentelemetry/api.Span

  Starts a new Span. Start the span without setting it on context.

  This method do NOT modify the current Context.

  Parameters

  • name: string

    The name of the span

  • Optionaloptions: @opentelemetry/api.SpanOptions

    SpanOptions used for span creation

  • Optionalcontext: @opentelemetry/api.Context

    Context to use to extract parent

  Returns @opentelemetry/api.Span

  Span The newly created span

  Example

  const span = tracer.startSpan('op');
      span.setAttribute('key', 'value');
      span.end();
  Copy