Telemetry

Ikhtisar

Telemetry adalah modul telemetri NocoBase, di-wrap berdasarkan OpenTelemetry, mendukung pendaftaran tools metric dan trace dari ekosistem OpenTelemetry.

Method Class

constructor()

Constructor, membuat instance Telemetry.

Signature

  • constructor(options?: TelemetryOptions)

Tipe

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

Detail

PropertiTipeDeskripsiDefault
serviceNamestringOpsional, lihat Semantic Conventionsnocobase
versionstringOpsional, lihat Semantic ConventionsOpsional, nomor versi NocoBase saat ini
traceTraceOptionsOpsional, lihat Trace
metricMetricOptionsOpsional, lihat Metric

init()

Mendaftarkan Instrumention, menginisialisasi Trace, Metric.

Signature

  • init(): void

start()

Memulai program pemroses data terkait Trace, Metric, seperti: export ke Prometheus.

Signature

  • start(): void

shutdown()

Menghentikan program pemroses data terkait Trace, Metric.

Signature

  • shutdown(): Promise<void>

addInstrumentation()

Menambahkan tools library instrumentation

Signature

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