perf(metrics): optimize command metrics with factory pattern and inline attributes

Author: PavelPashov

packages/client/lib/client/index.ts

@@ -1076,8 +1076,11 @@ export default class RedisClient<
     args: ReadonlyArray<RedisArgument>,
     options?: CommandOptions
   ): Promise<T> {
-    const clientAttributes = this._self._getClientOTelAttributes();
-    const recordOperation = OTelMetrics.instance.commandMetrics.createRecordOperationDuration(args, clientAttributes);
+    const recordOperation = OTelMetrics.instance.commandMetrics.createRecordOperationDuration(args, {
+      host: this._self.#socket.host,
+      port: this._self.#socket.port,
+      db: this._self.#selectedDB,
+    });
 
     if (!this._self.#socket.isOpen) {
       recordOperation(new ClientClosedError());
@@ -1098,27 +1101,40 @@ export default class RedisClient<
 
     const promise = this._self.#queue.addCommand<T>(args, opts);
 
-    if (OTelMetrics.isInitialized()) {
-      OTelMetrics.instance.connectionAdvancedMetrics.recordPendingRequests(1, clientAttributes);
+    OTelMetrics.instance.connectionAdvancedMetrics.recordPendingRequests(1, {
+      host: this._self.#socket.host,
+      port: this._self.#socket.port,
+      db: this._self.#selectedDB,
+    });
 
-      const trackedPromise = promise
-        .then((reply) => {
-          recordOperation();
-          OTelMetrics.instance.connectionAdvancedMetrics.recordPendingRequests(-1, clientAttributes);
-          return reply;
-        })
-        .catch((err) => {
-          recordOperation(err);
-          OTelMetrics.instance.connectionAdvancedMetrics.recordPendingRequests(-1, clientAttributes);
-          throw err;
-        });
+    const trackedPromise = promise
+      .then((reply) => {
+        recordOperation();
+        OTelMetrics.instance.connectionAdvancedMetrics.recordPendingRequests(
+          -1,
+          {
+            host: this._self.#socket.host,
+            port: this._self.#socket.port,
+            db: this._self.#selectedDB,
+          }
+        );
+        return reply;
+      })
+      .catch((err) => {
+        recordOperation(err);
+        OTelMetrics.instance.connectionAdvancedMetrics.recordPendingRequests(
+          -1,
+          {
+            host: this._self.#socket.host,
+            port: this._self.#socket.port,
+            db: this._self.#selectedDB,
+          }
+        );
+        throw err;
+      });
 
-      this._self.#scheduleWrite();
-      return trackedPromise;
-    } else {
-      this._self.#scheduleWrite();
-      return promise;
-    }
+    this._self.#scheduleWrite();
+    return trackedPromise;
   }
 
   async SELECT(db: number): Promise<void> {

packages/client/lib/opentelemetry/metrics.ts

@@ -34,23 +34,26 @@ import {
 class OTelCommandMetrics implements IOTelCommandMetrics {
   readonly #instruments: MetricInstruments;
   readonly #options: MetricOptions;
+  public readonly createRecordOperationDuration: (
+    args: ReadonlyArray<RedisArgument>,
+    clientAttributes?: OTelClientAttributes
+  ) => (error?: Error) => void;
 
   constructor(options: MetricOptions, instruments: MetricInstruments) {
     this.#options = options;
     this.#instruments = instruments;
-  }
 
-  private isCommandExcluded(commandName: string) {
-    return (
-      // It's not explicitly included
-      (this.#options.hasIncludeCommands &&
-        !this.#options.includeCommands[commandName]) ||
-      // it's explicitly excluded
-      this.#options.excludeCommands[commandName]
-    );
+    // Build the appropriate function based on options
+    if (options.hasIncludeCommands || options.hasExcludeCommands) {
+      // Version with filtering
+      this.createRecordOperationDuration = this.#createWithFiltering.bind(this);
+    } else {
+      this.createRecordOperationDuration =
+        this.#createWithoutFiltering.bind(this);
+    }
   }
 
-  public createRecordOperationDuration(
+  #createWithFiltering(
     args: ReadonlyArray<RedisArgument>,
     clientAttributes?: OTelClientAttributes
   ): (error?: Error) => void {
@@ -60,25 +63,45 @@ class OTelCommandMetrics implements IOTelCommandMetrics {
       return noopFunction;
     }
 
-    const startTime = performance.now();
+    return this.#recordOperation(commandName, clientAttributes);
+  }
 
-    const baseAttributes = {
-      [OTEL_ATTRIBUTES.dbOperationName]: commandName,
-      ...parseClientAttributes(clientAttributes),
-    };
+  #createWithoutFiltering(
+    args: ReadonlyArray<RedisArgument>,
+    clientAttributes?: OTelClientAttributes
+  ): (error?: Error) => void {
+    const commandName = args[0]?.toString() || "UNKNOWN";
+    return this.#recordOperation(commandName, clientAttributes);
+  }
+
+  #recordOperation(
+    commandName: string,
+    clientAttributes?: OTelClientAttributes
+  ): (error?: Error) => void {
+    const startTime = performance.now();
 
     return (error?: Error) => {
       this.#instruments.dbClientOperationDuration.record(
-        (performance.now() - startTime) / 1000, // convert to seconds
+        (performance.now() - startTime) / 1000,
         {
           ...this.#options.attributes,
-          ...baseAttributes,
-          // TODO add error types
+          [OTEL_ATTRIBUTES.dbOperationName]: commandName,
+          [OTEL_ATTRIBUTES.dbNamespace]: clientAttributes?.db,
+          [OTEL_ATTRIBUTES.serverAddress]: clientAttributes?.host,
+          [OTEL_ATTRIBUTES.serverPort]: clientAttributes?.port,
           ...(error ? { [OTEL_ATTRIBUTES.errorType]: error.message } : {}),
         }
       );
     };
   }
+
+  private isCommandExcluded(commandName: string) {
+    return (
+      (this.#options.hasIncludeCommands &&
+        !this.#options.includeCommands[commandName]) ||
+      this.#options.excludeCommands[commandName]
+    );
+  }
 }
 
 class OTelConnectionBasicMetrics implements IOTelConnectionBasicMetrics {
@@ -92,6 +115,7 @@ class OTelConnectionBasicMetrics implements IOTelConnectionBasicMetrics {
 
   public recordConnectionCount(
     value: number,
+
     clientAttributes?: OTelClientAttributes
   ) {
     this.#instruments.dbClientConnectionCount.add(value, {

packages/client/lib/opentelemetry/types.ts

@@ -251,9 +251,7 @@ export interface IOTelResiliencyMetrics {
     type: MetricErrorType,
     clientAttributes?: OTelClientAttributes
   ): void;
-  recordMaintenanceNotifications(
-    clientAttributes?: OTelClientAttributes
-  ): void;
+  recordMaintenanceNotifications(clientAttributes?: OTelClientAttributes): void;
 }
 
 export interface IOTelMetrics {