Telemetría

Generalidades

Telemetry es el módulo de telemetría de NocoBase, basado en OpenTelemetry, que permite registrar herramientas de métricas (Metric) y trazas (Trace) dentro del ecosistema de OpenTelemetry.

Métodos de clase

constructor()

Constructor para crear una instancia de Telemetry.

Firma

  • constructor(options?: TelemetryOptions)

Tipo

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

Detalles

PropiedadTipoDescripciónValor por defecto
serviceNamestringOpcional. Consulte las Convenciones Semánticasnocobase
versionstringOpcional. Consulte las Convenciones SemánticasOpcional, versión actual de NocoBase
traceTraceOptionsOpcional. Consulte Trace-
metricMetricOptionsOpcional. Consulte Metric-

init()

Registra la instrumentación e inicializa Trace y Metric.

Firma

  • init(): void

start()

Inicia los procesadores de datos relacionados con Trace y Metric, como por ejemplo, la exportación a Prometheus.

Firma

  • start(): void

shutdown()

Detiene los procesadores de datos relacionados con Trace y Metric.

Firma

  • shutdown(): Promise<void>

addInstrumentation()

Añade bibliotecas de instrumentación.

Firma

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