Trace

Методы класса

constructor()

Конструктор для создания экземпляра Trace.

Сигнатура

  • constructor(options?: TraceOptions)

Тип

export type TraceOptions = {
  tracerName?: string;
  version?: string;
  processorName?: string | string[];
};

Подробности

СвойствоТипОписаниеЗначение по умолчанию
tracerNamestringИдентификатор Tracenocobase-trace
versionstringТекущая версия NocoBase
processorNamestring | string[]Идентификатор(ы) зарегистрированного SpanProcessor-

init()

Инициализирует NodeTracerProvider.

Сигнатура

  • init(): void

registerProcessor()

Регистрирует SpanProcessor.

Сигнатура

  • registerProcessor(name: string, processor: GetSpanProcessor)

Тип

import { SpanProcessor } from '@opentelemetry/sdk-trace-base';

type GetSpanProcessor = () => SpanProcessor;

Подробности

ПараметрТипОписание
namestringУникальный идентификатор SpanProcessor
processor() => SpanProcessorФункция для получения SpanProcessor

getTracer()

Возвращает Tracer.

Сигнатура

  • getTracer(name?: string, version?: string)

Подробности

ПараметрТипОписаниеЗначение по умолчанию
namestringИдентификатор Tracenocobase-trace
versionstringТекущая версия NocoBase

start()

Запускает SpanProcessor.

Сигнатура

  • start(): void

shutdown()

Останавливает SpanProcessor.

Сигнатура

  • shutdown(): Promise<void>