add noop metrics

Author: PavelPashov

packages/client/lib/opentelemetry/metrics.ts

@@ -15,16 +15,15 @@ import {
   HistogramInstrumentConfig,
   MetricErrorType,
   OTelClientAttributes,
+  IOTelMetrics,
 } from "./types";
 import { createNoopMeter } from "./noop-meter";
 import { noopFunction } from "./utils";
+import { NoopOTelMetrics } from "./noop-metrics";
 
-export class OTelMetrics {
+export class OTelMetrics implements IOTelMetrics {
   // Create a noop instance by default
-  static #instance: OTelMetrics = new OTelMetrics({
-    api: undefined,
-    config: undefined,
-  });
+  static #instance: IOTelMetrics = new NoopOTelMetrics();
   static #initialized = false;
 
   readonly #meter: Meter;
@@ -70,6 +69,10 @@ export class OTelMetrics {
     OTelMetrics.#initialized = false;
   }
 
+  public static isInitialized() {
+    return OTelMetrics.#initialized;
+  }
+
   static get instance() {
     return OTelMetrics.#instance;
   }
@@ -196,11 +199,10 @@ export class OTelMetrics {
   }
 
   private isCommandExcluded(commandName: string) {
-    const upperCommandName = commandName?.toUpperCase();
     return (
       (this.#options.includeCommands.length > 0 &&
-        !this.#options.includeCommands.includes(upperCommandName)) ||
-      this.#options.excludeCommands.includes(upperCommandName)
+        !this.#options.includeCommands.includes(commandName)) ||
+      this.#options.excludeCommands.includes(commandName)
     );
   }
 

packages/client/lib/opentelemetry/noop-metrics.ts

@@ -0,0 +1,41 @@
+import { RedisArgument } from "../..";
+import { MetricErrorType, OTelClientAttributes, IOTelMetrics } from "./types";
+import { noopFunction } from "./utils";
+
+export class NoopOTelMetrics implements IOTelMetrics {
+  createRecordOperationDuration(
+    _args: ReadonlyArray<RedisArgument>,
+    _clientAttributes?: OTelClientAttributes
+  ): (error?: Error) => void {
+    return noopFunction;
+  }
+
+  recordConnectionCount(
+    _value: number,
+    _clientAttributes?: OTelClientAttributes
+  ) {}
+
+  recordConnectionCreateTime(
+    _durationMs: number,
+    _clientAttributes?: OTelClientAttributes
+  ) {}
+
+  recordConnectionRelaxedTimeout(
+    _value: number,
+    _clientAttributes?: OTelClientAttributes
+  ) {}
+
+  recordConnectionHandoff(_clientAttributes: OTelClientAttributes) {}
+
+  recordClientErrorsHandled(
+    _type: MetricErrorType,
+    _clientAttributes?: OTelClientAttributes
+  ) {}
+
+  recordMaintenanceNotifications(_clientAttributes: OTelClientAttributes) {}
+
+  recordPendingRequests(
+    _value: number,
+    _clientAttributes?: OTelClientAttributes
+  ) {}
+}

packages/client/lib/opentelemetry/types.ts

@@ -5,6 +5,7 @@ import {
   MeterProvider,
   UpDownCounter,
 } from "@opentelemetry/api";
+import { RedisArgument } from "../RESP/types";
 
 export const METRIC_GROUP = {
   COMMAND: "command",
@@ -208,3 +209,32 @@ export const METRIC_ERROR_TYPE = {
 
 export type MetricErrorType =
   (typeof METRIC_ERROR_TYPE)[keyof typeof METRIC_ERROR_TYPE];
+
+export interface IOTelMetrics {
+  createRecordOperationDuration(
+    args: ReadonlyArray<RedisArgument>,
+    clientAttributes?: OTelClientAttributes
+  ): (error?: Error) => void;
+  recordConnectionCount(
+    value: number,
+    clientAttributes?: OTelClientAttributes
+  ): void;
+  recordConnectionCreateTime(
+    durationMs: number,
+    clientAttributes?: OTelClientAttributes
+  ): void;
+  recordConnectionRelaxedTimeout(
+    value: number,
+    clientAttributes?: OTelClientAttributes
+  ): void;
+  recordConnectionHandoff(clientAttributes: OTelClientAttributes): void;
+  recordClientErrorsHandled(
+    type: MetricErrorType,
+    clientAttributes?: OTelClientAttributes
+  ): void;
+  recordMaintenanceNotifications(clientAttributes: OTelClientAttributes): void;
+  recordPendingRequests(
+    value: number,
+    clientAttributes?: OTelClientAttributes
+  ): void;
+}