Telemetry

概览

Telemetry は NocoBase のテレメトリモジュールです。OpenTelemetry をベースにラップされており、OpenTelemetry エコシステムのメトリクス (Metric) およびトレース (Trace) ツールの登録をサポートしています。

クラスメソッド

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()

インストルメンテーション(Instrumentation)を登録し、TraceMetric を初期化します。

シグネチャ

  • init(): void

start()

Prometheus へのエクスポートなど、TraceMetric 関連データの処理プログラムを開始します。

シグネチャ

  • start(): void

shutdown()

TraceMetric 関連データの処理プログラムを停止します。

シグネチャ

  • shutdown(): Promise<void>

addInstrumentation()

インストルメンテーションライブラリを追加します。

シグネチャ

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