• Русский

      • Телеметрия

      Экспериментальная функция

      Модуль телеметрии NocoBase построен на основе OpenTelemetry. В этой статье рассказывается, как использовать модуль телеметрии для сбора данных трассировки и метрик, чтобы повысить наблюдаемость системы NocoBase.

      Инструментарий

      Метрики

      const meter = app.telemetry.metric.getMeter();
const counter = meter.createCounter('event_counter', {});
counter.add(1);

      Ссылки:

      Трассировки

      const tracer = app.telemetry.trace.getTracer();
tracer.startActiveSpan();
tracer.startSpan();

      Ссылки:

      Библиотеки

      import { Plugin } from '@nocobase/server';
import { getNodeAutoInstrumentations } from '@opentelemetry/auto-instrumentations-node';

class InstrumentationPlugin extends Plugin {
  afterAdd() {
    this.app.on('beforeLoad', (app) => {
      app.telemetry.addInstrumentation(getNodeAutoInstrumentations());
    });
  }
}
      Внимание

      В NocoBase модуль телеметрии инициализируется в app.beforeLoad. Поэтому не все библиотеки инструментирования подходят для NocoBase.
      Например, instrumentation-koa нужно подключать до создания экземпляра Koa, но хотя Application в NocoBase основан на Koa, модуль телеметрии инициализируется уже после создания Application, поэтому эту библиотеку применить нельзя.

      Ссылки:

      Сбор

      Метрики

      import { Plugin } from '@nocobase/server';
import {
  PeriodicExportingMetricReader,
  ConsoleMetricExporter,
} from '@opentelemetry/sdk-metrics';

class MetricReaderPlugin extends Plugin {
  afterAdd() {
    this.app.on('beforeLoad', (app) => {
      app.telemetry.metric.registerReader(
        'console',
        () =>
          new PeriodicExportingMetricReader({
            exporter: new ConsoleMetricExporter(),
          }),
      );
    });
  }
}

      Трассировки

      import { Plugin } from '@nocobase/server';
import {
  BatchSpanProcessor,
  ConsoleSpanExporter,
} from '@opentelemetry/sdk-trace-base';

class TraceSpanProcessorPlugin extends Plugin {
  afterAdd() {
    this.app.on('beforeLoad', (app) => {
      app.telemetry.trace.registerProcessor(
        'console',
        () => new BatchSpanProcessor(new ConsoleSpanExporter()),
      );
    });
  }
}

      Ссылки: