Telemetria

Visão Geral

Telemetry é o módulo de telemetria do NocoBase, baseado no OpenTelemetry, com suporte para registro de métricas (Metric) e rastreamento (Trace) dentro do ecossistema OpenTelemetry.

Métodos da Classe

constructor()

Construtor para criar uma instância de Telemetry.

Assinatura

  • constructor(options?: TelemetryOptions)

Tipo

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

Detalhes

PropriedadeTipoDescriçãoValor Padrão
serviceNamestringOpcional, consulte as Semantic Conventionsnocobase
versionstringOpcional, consulte as Semantic ConventionsOpcional, versão atual do NocoBase
traceTraceOptionsOpcional, consulte Trace-
metricMetricOptionsOpcional, consulte Metric-

init()

Registra a instrumentação e inicializa Trace e Metric.

Assinatura

  • init(): void

start()

Inicia o processamento de dados relacionados a Trace e Metric, como a exportação para o Prometheus.

Assinatura

  • start(): void

shutdown()

Interrompe o processamento de dados relacionados a Trace e Metric.

Assinatura

  • shutdown(): Promise<void>

addInstrumentation()

Adiciona bibliotecas de instrumentação.

Assinatura

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