Telemetry - Телеметрия

Обзор

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

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

constructor()

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

Сигнатура

  • constructor(options?: TelemetryOptions)

Тип

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

Подробности

СвойствоТипОписаниеЗначение по умолчанию
serviceNamestringНеобязательный параметр. См. Semantic Conventions.nocobase
versionstringНеобязательный параметр. См. Semantic Conventions.Необязательный, текущая версия NocoBase
traceTraceOptionsНеобязательный параметр. См. Trace.-
metricMetricOptionsНеобязательный параметр. См. Metric.-

init()

Регистрирует инструментацию и инициализирует модули Trace и Metric.

Сигнатура

  • init(): void

start()

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

Сигнатура

  • start(): void

shutdown()

Останавливает обработку данных, связанных с Trace и Metric.

Сигнатура

  • shutdown(): Promise<void>

addInstrumentation()

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

Сигнатура

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