Use the MethodName enum instead of string

googleapis · Jan 28, 2025 · e7c5b5f · e7c5b5f
1 parent 66c4ab1
commit e7c5b5f
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 3 deletions.
diff --git a/common/client-side-metrics-attributes.ts b/common/client-side-metrics-attributes.ts
@@ -78,3 +78,12 @@ export interface OnAttemptCompleteAttributes
 export interface OnAttemptCompleteInfo extends AttemptOnlyAttributes {
   connectivityErrorCount: number;
 }
+
+export enum MethodName {
+  READ_ROWS = 'readRows',
+  MUTATE_ROW = 'mutateRow',
+  CHECK_AND_MUTATE_ROW = 'checkAndMutateRow',
+  READ_MODIFY_WRITE_ROW = 'readModifyWriteRow',
+  SAMPLE_ROW_KEYS = 'sampleRowKeys',
+  MUTATE_ROWS = 'mutateRows',
+}
diff --git a/src/client-side-metrics/metrics-collector.ts b/src/client-side-metrics/metrics-collector.ts
@@ -16,6 +16,7 @@ import * as fs from 'fs';
 import {IMetricsHandler} from './metrics-handler';
 import {
   AttemptOnlyAttributes,
+  MethodName,
   OnAttemptCompleteInfo,
   OnOperationCompleteAttributes,
   OperationOnlyAttributes,
@@ -83,7 +84,7 @@ export class MetricsCollector {
   private zone: string | undefined;
   private cluster: string | undefined;
   private tabularApiSurface: ITabularApiSurface;
-  private methodName: string;
+  private methodName: MethodName;
   private projectId?: string;
   private attemptCount = 0;
   private receivedFirstResponse: boolean;
@@ -96,14 +97,14 @@ export class MetricsCollector {
   /**
    * @param {ITabularApiSurface} tabularApiSurface Information about the Bigtable table being accessed.
    * @param {IMetricsHandler[]} metricsHandlers The metrics handlers used for recording metrics.
-   * @param {string} methodName The name of the method being traced.
+   * @param {MethodName} methodName The name of the method being traced.
    * @param {string} projectId The id of the project.
    * @param {DateProvider} dateProvider A provider for date/time information (for testing).
    */
   constructor(
     tabularApiSurface: ITabularApiSurface,
     metricsHandlers: IMetricsHandler[],
-    methodName: string,
+    methodName: MethodName,
     projectId?: string,
     dateProvider?: DateProvider
   ) {