Change metrics handler interface to support each metric

Author: danieljbruce

common/client-side-metrics-attributes.ts

@@ -38,7 +38,7 @@ export enum StreamingState {
  * Attributes associated with operation latency metrics for Bigtable client operations.
  * These attributes provide context about the Bigtable environment and the completed operation.
  */
-interface OperationLatencyAttributes extends StandardAttributes {
+export interface OperationLatencyAttributes extends StandardAttributes {
   finalOperationStatus: FinalOperationStatus;
   streamingOperation: StreamingState;
 }
@@ -47,7 +47,7 @@ interface OperationLatencyAttributes extends StandardAttributes {
  * Attributes associated with attempt latency metrics for Bigtable client operations.
  * These attributes provide context about the Bigtable environment, the specific attempt, and whether the operation was streaming.
  */
-interface AttemptLatencyAttributes extends StandardAttributes {
+export interface AttemptLatencyAttributes extends StandardAttributes {
   attemptStatus: AttemptStatus;
   streamingOperation: StreamingState;
 }
@@ -56,7 +56,7 @@ interface AttemptLatencyAttributes extends StandardAttributes {
  * Attributes associated with retry count metrics for Bigtable client operations.  These attributes
  * provide context about the Bigtable environment and the final status of the operation.
  */
-interface RetryCountAttributes extends StandardAttributes {
+export interface RetryCountAttributes extends StandardAttributes {
   finalOperationStatus: FinalOperationStatus;
 }
 
@@ -70,15 +70,15 @@ type ApplicationBlockingLatenciesAttributes = StandardAttributes;
  * Attributes associated with first response latency metrics for Bigtable client operations.
  * These attributes provide context about the Bigtable environment and the final status of the operation.
  */
-interface FirstResponseLatencyAttributes extends StandardAttributes {
+export interface FirstResponseLatencyAttributes extends StandardAttributes {
   finalOperationStatus: FinalOperationStatus;
 }
 
 /**
  * Attributes associated with server latency metrics for Bigtable client operations.
  * These attributes provide context about the Bigtable environment, the specific attempt, and whether the operation was streaming.
  */
-interface ServerLatenciesAttributes extends StandardAttributes {
+export interface ServerLatenciesAttributes extends StandardAttributes {
   attemptStatus: AttemptStatus;
   streamingOperation: StreamingState;
 }
@@ -87,7 +87,7 @@ interface ServerLatenciesAttributes extends StandardAttributes {
  * Attributes associated with connectivity error count metrics for Bigtable client operations.
  * These attributes provide context about the Bigtable environment and the status of the attempt.
  */
-interface ConnectivityErrorCountAttributes extends StandardAttributes {
+export interface ConnectivityErrorCountAttributes extends StandardAttributes {
   attemptStatus: AttemptStatus;
 }
 
@@ -118,10 +118,9 @@ export type AttemptStatus = grpc.status;
  * operation, and its final status.  They are used for recording metrics such as
  * operation latency, first response latency, and retry count.
  */
-export type OnOperationCompleteAttributes =
-  | OperationLatencyAttributes
-  | FirstResponseLatencyAttributes
-  | RetryCountAttributes;
+export type OnOperationCompleteAttributes = OperationLatencyAttributes &
+  FirstResponseLatencyAttributes &
+  RetryCountAttributes;
 
 /**
  * Attributes associated with the completion of a single attempt of a Bigtable
@@ -130,11 +129,10 @@ export type OnOperationCompleteAttributes =
  * are used for recording metrics such as attempt latency, server latency, and
  * connectivity errors.
  */
-export type OnAttemptCompleteAttributes =
-  | AttemptLatencyAttributes
-  | ConnectivityErrorCountAttributes
-  | ServerLatenciesAttributes
-  | ClientBlockingLatenciesAttributes;
+export type OnAttemptCompleteAttributes = AttemptLatencyAttributes &
+  ConnectivityErrorCountAttributes &
+  ServerLatenciesAttributes &
+  ClientBlockingLatenciesAttributes;
 
 /**
  * Represents the names of Bigtable methods. These are used as attributes for

common/test-metrics-handler.ts

@@ -14,46 +14,69 @@
 
 import {WithLogger} from './logger';
 import {
-  OnAttemptCompleteMetrics,
-  OnOperationCompleteMetrics,
-} from '../src/client-side-metrics/metrics-handler';
-import {
-  OnAttemptCompleteAttributes,
-  OnOperationCompleteAttributes,
+  AttemptLatencyAttributes,
+  ConnectivityErrorCountAttributes,
+  FirstResponseLatencyAttributes,
+  OperationLatencyAttributes,
+  RetryCountAttributes,
+  ServerLatenciesAttributes,
 } from './client-side-metrics-attributes';
 
 /**
  * A test implementation of the IMetricsHandler interface.  Used for testing purposes.
  * It logs the metrics and attributes received by the onOperationComplete and onAttemptComplete methods.
  */
 export class TestMetricsHandler extends WithLogger {
-  /**
-   * Logs the metrics and attributes received for an operation completion.
-   * @param {OnOperationCompleteMetrics} metrics Metrics related to the completed operation.
-   * @param {Attributes} attributes Attributes associated with the completed operation.
-   */
-  onOperationComplete(
-    metrics: OnOperationCompleteMetrics,
-    attributes: OnOperationCompleteAttributes
+  onRecordAttemptLatency(
+    attemptLatency: number,
+    attributes: AttemptLatencyAttributes
+  ) {
+    this.logger.log(
+      `Recording parameters for AttemptLatency: ${attemptLatency}:`
+    );
+    this.logger.log(`attributes: ${JSON.stringify(attributes)}`);
+  }
+
+  onRecordConnectivityErrorCount(
+    connectivityErrorCount: number,
+    attributes: ConnectivityErrorCountAttributes
+  ) {
+    this.logger.log(
+      `Recording parameters for ConnectivityErrorCount: ${connectivityErrorCount}:`
+    );
+    this.logger.log(`attributes: ${JSON.stringify(attributes)}`);
+  }
+
+  onRecordServerLatency(
+    serverLatency: number,
+    attributes: ServerLatenciesAttributes
+  ) {
+    this.logger.log(`Recording parameters for ServerLatency: ${serverLatency}`);
+    this.logger.log(`attributes: ${JSON.stringify(attributes)}`);
+  }
+
+  onRecordOperationLatency(
+    operationLatency: number,
+    attributes: OperationLatencyAttributes
   ) {
-    attributes.clientName = 'nodejs-bigtable';
-    this.logger.log('Recording parameters for onOperationComplete:');
-    this.logger.log(`metrics: ${JSON.stringify(metrics)}`);
+    this.logger.log(
+      `Recording parameters for OperationLatency: ${operationLatency}`
+    );
+    this.logger.log(`attributes: ${JSON.stringify(attributes)}`);
+  }
+
+  onRecordRetryCount(retryCount: number, attributes: RetryCountAttributes) {
+    this.logger.log(`Recording parameters for RetryCount: ${retryCount}`);
     this.logger.log(`attributes: ${JSON.stringify(attributes)}`);
   }
 
-  /**
-   * Logs the metrics and attributes received for an attempt completion.
-   * @param {OnAttemptCompleteMetrics} metrics Metrics related to the completed attempt.
-   * @param {Attributes} attributes Attributes associated with the completed attempt.
-   */
-  onAttemptComplete(
-    metrics: OnAttemptCompleteMetrics,
-    attributes: OnAttemptCompleteAttributes
+  onRecordFirstResponseLatency(
+    firstResponseLatency: number,
+    attributes: FirstResponseLatencyAttributes
   ) {
-    attributes.clientName = 'nodejs-bigtable';
-    this.logger.log('Recording parameters for onAttemptComplete:');
-    this.logger.log(`metrics: ${JSON.stringify(metrics)}`);
+    this.logger.log(
+      `Recording parameters for FirstResponseLatency: ${firstResponseLatency}`
+    );
     this.logger.log(`attributes: ${JSON.stringify(attributes)}`);
   }
 }

src/client-side-metrics/gcp-metrics-handler.ts

@@ -12,17 +12,17 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-import {
-  IMetricsHandler,
-  OnAttemptCompleteMetrics,
-  OnOperationCompleteMetrics,
-} from './metrics-handler';
+import {IMetricsHandler} from './metrics-handler';
 import * as Resources from '@opentelemetry/resources';
 import * as ResourceUtil from '@google-cloud/opentelemetry-resource-util';
 import {MetricExporter} from '@google-cloud/opentelemetry-cloud-monitoring-exporter';
 import {
-  OnAttemptCompleteAttributes,
-  OnOperationCompleteAttributes,
+  AttemptLatencyAttributes,
+  ConnectivityErrorCountAttributes,
+  FirstResponseLatencyAttributes,
+  OperationLatencyAttributes,
+  RetryCountAttributes,
+  ServerLatenciesAttributes,
 } from '../../common/client-side-metrics-attributes';
 import {View} from '@opentelemetry/sdk-metrics';
 const {
@@ -161,48 +161,54 @@ export class GCPMetricsHandler implements IMetricsHandler {
     }
   }
 
-  /**
-   * Records metrics for a completed Bigtable operation.
-   * This method records the operation latency and retry count, associating them with provided attributes.
-   * @param {OnOperationCompleteMetrics} metrics Metrics related to the completed operation.
-   * @param {OnOperationCompleteAttributes} attributes Attributes associated with the completed operation.
-   */
-  onOperationComplete(
-    metrics: OnOperationCompleteMetrics,
-    attributes: OnOperationCompleteAttributes
+  onRecordAttemptLatency(
+    attemptLatency: number,
+    attributes: AttemptLatencyAttributes
   ) {
     this.initialize();
-    this.otelMetrics?.operationLatencies.record(
-      metrics.operationLatency,
-      attributes
-    );
-    this.otelMetrics?.retryCount.add(metrics.retryCount, attributes);
-    this.otelMetrics?.firstResponseLatencies.record(
-      metrics.firstResponseLatency,
-      attributes
-    );
+    this.otelMetrics?.attemptLatencies.record(attemptLatency, attributes);
   }
 
-  /**
-   * Records metrics for a completed attempt of a Bigtable operation.
-   * This method records attempt latency, connectivity error count, server latency, and first response latency,
-   * along with the provided attributes.
-   * @param {OnAttemptCompleteMetrics} metrics Metrics related to the completed attempt.
-   * @param {OnAttemptCompleteAttributes} attributes Attributes associated with the completed attempt.
-   */
-  onAttemptComplete(
-    metrics: OnAttemptCompleteMetrics,
-    attributes: OnAttemptCompleteAttributes
+  onRecordConnectivityErrorCount(
+    connectivityErrorCount: number,
+    attributes: ConnectivityErrorCountAttributes
   ) {
     this.initialize();
-    this.otelMetrics?.attemptLatencies.record(
-      metrics.attemptLatency,
+    this.otelMetrics?.connectivityErrorCount.record(
+      connectivityErrorCount,
       attributes
     );
-    this.otelMetrics?.connectivityErrorCount.record(
-      metrics.connectivityErrorCount,
+  }
+
+  onRecordServerLatency(
+    serverLatency: number,
+    attributes: ServerLatenciesAttributes
+  ) {
+    this.initialize();
+    this.otelMetrics?.serverLatencies.record(serverLatency, attributes);
+  }
+
+  onRecordOperationLatency(
+    operationLatency: number,
+    attributes: OperationLatencyAttributes
+  ) {
+    this.initialize();
+    this.otelMetrics?.operationLatencies.record(operationLatency, attributes);
+  }
+
+  onRecordRetryCount(retryCount: number, attributes: RetryCountAttributes) {
+    this.initialize();
+    this.otelMetrics?.retryCount.add(retryCount, attributes);
+  }
+
+  onRecordFirstResponseLatency(
+    firstResponseLatency: number,
+    attributes: FirstResponseLatencyAttributes
+  ) {
+    this.initialize();
+    this.otelMetrics?.firstResponseLatencies.record(
+      firstResponseLatency,
       attributes
     );
-    this.otelMetrics?.serverLatencies.record(metrics.serverLatency, attributes);
   }
 }

src/client-side-metrics/metrics-handler.ts

@@ -13,8 +13,12 @@
 // limitations under the License.
 
 import {
-  OnAttemptCompleteAttributes,
-  OnOperationCompleteAttributes,
+  AttemptLatencyAttributes,
+  ConnectivityErrorCountAttributes,
+  FirstResponseLatencyAttributes,
+  OperationLatencyAttributes,
+  RetryCountAttributes,
+  ServerLatenciesAttributes,
 } from '../../common/client-side-metrics-attributes';
 
 /**
@@ -46,22 +50,33 @@ export interface OnAttemptCompleteMetrics {
  * Implementations of this interface can define how metrics are recorded and processed.
  */
 export interface IMetricsHandler {
-  /**
-   * Called when an operation completes (successfully or unsuccessfully).
-   * @param {OnOperationCompleteMetrics} metrics Metrics related to the completed operation.
-   * @param {OnOperationCompleteAttributes} attributes Attributes associated with the completed operation.
-   */
-  onOperationComplete?(
-    metrics: OnOperationCompleteMetrics,
-    attributes: OnOperationCompleteAttributes
+  onRecordAttemptLatency?(
+    attemptLatency: number,
+    attributes: AttemptLatencyAttributes
   ): void;
-  /**
-   * Called when an attempt (e.g., an RPC attempt) completes.
-   * @param {OnAttemptCompleteMetrics} metrics Metrics related to the completed attempt.
-   * @param {OnAttemptCompleteAttributes} attributes Attributes associated with the completed attempt.
-   */
-  onAttemptComplete?(
-    metrics: OnAttemptCompleteMetrics,
-    attributes: OnAttemptCompleteAttributes
+
+  onRecordConnectivityErrorCount?(
+    connectivityErrorCount: number,
+    attributes: ConnectivityErrorCountAttributes
+  ): void;
+
+  onRecordServerLatency?(
+    serverLatency: number,
+    attributes: ServerLatenciesAttributes
+  ): void;
+
+  onRecordOperationLatency?(
+    operationLatency: number,
+    attributes: OperationLatencyAttributes
+  ): void;
+
+  onRecordRetryCount?(
+    retryCount: number,
+    attributes: RetryCountAttributes
+  ): void;
+
+  onRecordFirstResponseLatency?(
+    firstResponseLatency: number,
+    attributes: FirstResponseLatencyAttributes
   ): void;
 }