#Telemetry

#Обзор

Telemetry — это модуль телеметрии NocoBase, построенный на базе OpenTelemetry. Он поддерживает регистрацию инструментов для метрик (Metric) и трассировок (Trace) в экосистеме OpenTelemetry.

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

#constructor()

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

#Сигнатура

• constructor(options?: TelemetryOptions)

#Тип

export interface TelemetryOptions {
  serviceName?: string;
  version?: string;
  trace?: TraceOptions;
  metric?: MetricOptions;
}

#Подробная информация

#init()

Регистрирует инструментацию (instrumentation), инициализирует Trace и Metric.

#Сигнатура

• init(): void

#start()

Запускает обработчики данных, связанных с Trace и Metric, например: экспорт в Prometheus.

#Сигнатура

• start(): void

#shutdown()

Останавливает обработчики данных Trace и Metric.

#Сигнатура

• shutdown(): Promise<void>

#addInstrumentation()

Добавляет библиотеки инструментирования.

#Сигнатура

• addInstrumentation(...instrumentation: InstrumentationOption[])