Telemetrie

Übersicht

Telemetry ist das Telemetrie-Modul von NocoBase, das auf OpenTelemetry basiert. Es unterstützt die Registrierung von Metriken (Metric) und Traces (Trace) innerhalb des OpenTelemetry-Ökosystems.

Klassenmethoden

constructor()

Konstruktor zum Erstellen einer Telemetry-Instanz.

Signatur

  • constructor(options?: TelemetryOptions)

Typ

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

Details

EigenschaftTypBeschreibungStandardwert
serviceNamestringOptional, siehe Semantic Conventionsnocobase
versionstringOptional, siehe Semantic ConventionsOptional, aktuelle NocoBase-Versionsnummer
traceTraceOptionsOptional, siehe Trace-
metricMetricOptionsOptional, siehe Metric-

init()

Registriert die Instrumentierung und initialisiert Trace sowie Metric.

Signatur

  • init(): void

start()

Startet die Verarbeitung von Trace- und Metric-bezogenen Daten, wie z. B. den Export nach Prometheus.

Signatur

  • start(): void

shutdown()

Stoppt die Verarbeitung von Trace- und Metric-bezogenen Daten.

Signatur

  • shutdown(): Promise<void>

addInstrumentation()

Fügt Instrumentierungs-Bibliotheken hinzu.

Signatur

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