Class OpenTelemetry

Static init

• init(config): void

• Initializes node-redis OpenTelemetry observability.

  This bootstraps node-redis metrics instrumentation and registers the internal client registry used by metric collectors.

  Call this once during application startup, before creating Redis clients you want to observe.

  Parameters

  • config: ObservabilityConfig

    Observability configuration.

  Returns void

  Remarks

  Requires Node.js >= 18.19.0.

  Throws

  If OpenTelemetry is already initialized.

  Throws

  If @opentelemetry/api is not installed.

  Example

  import { metrics } from "@opentelemetry/api";
  import {
    ConsoleMetricExporter,
    MeterProvider,
    PeriodicExportingMetricReader
  } from "@opentelemetry/sdk-metrics";
  import { OpenTelemetry } from "redis";
  
  const reader = new PeriodicExportingMetricReader({
    exporter: new ConsoleMetricExporter()
  });
  
  const provider = new MeterProvider({ readers: [reader] });
  metrics.setGlobalMeterProvider(provider);
  
  OpenTelemetry.init({
    metrics: {
      enabled: true,
      enabledMetricGroups: ["pubsub", "connection-basic", "resiliency"],
      includeCommands: ["GET", "SET"],
      hidePubSubChannelNames: true
    }
  });
  Copy