• Tiếng Việt

      • Telemetry

      Lưu ý

      Chức năng này hiện đang là chức năng thử nghiệm.

      Module Telemetry của NocoBase được đóng gói dựa trên OpenTelemetry, dùng để thu thập dữ liệu Trace và Metric, tăng cường khả năng quan sát (Observability) của NocoBase.

      Instrumentation

      Số liệu

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

      Cách dùng chi tiết xem tại OpenTelemetry - Acquiring a Meter.

      Truy vết

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

      Cách dùng chi tiết xem tại OpenTelemetry - Acquiring a Tracer.

      Thư viện công cụ

      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());
    });
  }
}
      Lưu ý

      Vị trí khởi tạo module telemetry trong NocoBase là app.beforeLoad, do đó không phải tất cả các thư viện instrumentation đều phù hợp với NocoBase. Ví dụ instrumentation-koa cần được import trước khi Koa được khởi tạo, nhưng Application của NocoBase mặc dù dựa trên Koa, module telemetry chỉ được khởi tạo sau khi Application được khởi tạo, nên không thể dùng được.

      Cách dùng chi tiết xem tại OpenTelemetry - Libraries.

      Thu thập

      Số liệu

      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(),
          }),
      );
    });
  }
}

      Truy vết

      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()),
      );
    });
  }
}

      Cách dùng chi tiết xem tại OpenTelemetry - Exporters.

      Liên kết liên quan

      • Logger — Log kết hợp với telemetry để hoàn thiện phương án khả năng quan sát
      • Plugin — Đăng ký instrumentation telemetry và bộ thu thập trong Plugin
      • Tổng quan phát triển server — Vị trí của module telemetry trong kiến trúc server
      • Event — Khởi tạo telemetry trong beforeLoad thông qua cơ chế sự kiện
      • Middleware — Kết hợp telemetry để truy vết link request trong middleware