Telemetry

Tổng quan

Telemetry là module telemetry của NocoBase, được đóng gói trên nền OpenTelemetry, hỗ trợ đăng ký các công cụ Metric và Trace trong hệ sinh thái OpenTelemetry.

Phương thức của lớp

constructor()

Constructor, tạo một instance Telemetry.

Chữ ký

  • constructor(options?: TelemetryOptions)

Kiểu

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

Thông tin chi tiết

Thuộc tínhKiểuMô tảGiá trị mặc định
serviceNamestringTùy chọn, tham khảo Semantic Conventionsnocobase
versionstringTùy chọn, tham khảo Semantic ConventionsTùy chọn, phiên bản NocoBase hiện tại
traceTraceOptionsTùy chọn, tham khảo Trace
metricMetricOptionsTùy chọn, tham khảo Metric

init()

Đăng ký Instrumention, khởi tạo Trace, Metric.

Chữ ký

  • init(): void

start()

Khởi động chương trình xử lý dữ liệu liên quan đến Trace, Metric, ví dụ: xuất sang Prometheus.

Chữ ký

  • start(): void

shutdown()

Dừng các chương trình xử lý dữ liệu liên quan đến Trace, Metric.

Chữ ký

  • shutdown(): Promise<void>

addInstrumentation()

Thêm thư viện công cụ instrumentation.

Chữ ký

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