Skip to content
This repository was archived by the owner on Mar 26, 2026. It is now read-only.

Commit 2129312

Browse files
danieljbrucedanieljbruce
authored
feat: Add client side metrics for readModifyWriteRow calls (#1656)
## Description This PR collects client side metrics for readModifyWriteRow calls and collects all the right types of metrics for these unary calls. They leverage the plumbing provided for unary calls to add interceptors to those calls so that we can record metrics for the right zone/cluster/server time. ## Impact This PR collects client side metrics for readModifyWriteRow calls. ## Testing For each readRows/mutateRows/mutateRow test we add a corresponding test for readModifyWriteRow.
1 parent 99cf5a6 commit 2129312

7 files changed

Lines changed: 299 additions & 28 deletions

src/interceptor.ts renamed to src/client-side-metrics/metric-interceptor.ts

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
// limitations under the License.
1414

1515
import {CallOptions} from 'google-gax';
16-
import {OperationMetricsCollector} from './client-side-metrics/operation-metrics-collector';
16+
import {OperationMetricsCollector} from './operation-metrics-collector';
1717

1818
// Mock Server Implementation
1919
import * as grpcJs from '@grpc/grpc-js';
@@ -49,16 +49,21 @@ function createMetricsInterceptorProvider(
4949
collector.onStatusMetadataReceived(
5050
status as unknown as ServerStatus,
5151
);
52+
collector.onAttemptComplete(status.code);
5253
nextStat(status);
5354
},
5455
};
5556
next(metadata, newListener);
5657
},
58+
sendMessage: function (message, next) {
59+
collector.onAttemptStart();
60+
next(message);
61+
},
5762
});
5863
};
5964
}
6065

61-
export function withInterceptors(
66+
export function withMetricInterceptors(
6267
gaxOptions: CallOptions,
6368
metricsCollector?: OperationMetricsCollector,
6469
) {

‎src/client-side-metrics/operation-metrics-collector.ts‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -286,8 +286,15 @@ export class OperationMetricsCollector {
286286
finalOperationStatus: grpc.status,
287287
applicationLatency?: number,
288288
) {
289-
this.onAttemptComplete(finalOperationStatus);
290289
withMetricsDebug(() => {
290+
if (
291+
this.state ===
292+
MetricsCollectorState.OPERATION_STARTED_ATTEMPT_IN_PROGRESS_NO_ROWS_YET ||
293+
this.state ===
294+
MetricsCollectorState.OPERATION_STARTED_ATTEMPT_IN_PROGRESS_SOME_ROWS_RECEIVED
295+
) {
296+
this.onAttemptComplete(finalOperationStatus);
297+
}
291298
checkState(this.state, [
292299
MetricsCollectorState.OPERATION_STARTED_ATTEMPT_NOT_IN_PROGRESS,
293300
]);

‎src/row-data-utils.ts‎

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@
1212
// See the License for the specific language governing permissions and
1313
// limitations under the License.
1414

15+
import {OperationMetricsCollector} from './client-side-metrics/operation-metrics-collector';
16+
1517
const dotProp = require('dot-prop');
1618
import {Filter, RawFilter} from './filter';
1719
import {
@@ -30,6 +32,11 @@ import {TabularApiSurface} from './tabular-api-surface';
3032
import arrify = require('arrify');
3133
import {Bigtable} from './index';
3234
import {CallOptions} from 'google-gax';
35+
import {
36+
MethodName,
37+
StreamingState,
38+
} from './client-side-metrics/client-side-metrics-attributes';
39+
import {withMetricInterceptors} from './client-side-metrics/metric-interceptor';
3340

3441
interface TabularApiSurfaceRequest {
3542
tableName?: string;
@@ -193,14 +200,31 @@ class RowDataUtils {
193200
properties.reqOpts,
194201
);
195202
properties.requestData.data = {};
203+
// 1. Create a metrics collector.
204+
const metricsCollector = new OperationMetricsCollector(
205+
properties.requestData.table,
206+
MethodName.READ_MODIFY_WRITE_ROW,
207+
StreamingState.UNARY,
208+
(
209+
properties.requestData.table as any
210+
).bigtable._metricsConfigManager!.metricsHandlers,
211+
);
212+
// 2. Tell the metrics collector an attempt has been started.
213+
metricsCollector.onOperationStart();
214+
// 3. Make a unary call with gax options that include interceptors. The
215+
// interceptors are built from a method that hooks them up to the
216+
// metrics collector
196217
properties.requestData.bigtable.request<google.bigtable.v2.IReadModifyWriteRowResponse>(
197218
{
198219
client: 'BigtableClient',
199220
method: 'readModifyWriteRow',
200221
reqOpts,
201-
gaxOpts: gaxOptions,
222+
gaxOpts: withMetricInterceptors(gaxOptions, metricsCollector),
223+
},
224+
(err, ...args) => {
225+
metricsCollector.onOperationComplete(err ? err.code : 0);
226+
callback(err, ...args);
202227
},
203-
callback,
204228
);
205229
}
206230

‎src/utils/createReadStreamInternal.ts‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -420,7 +420,6 @@ export function createReadStreamInternal(
420420
})
421421
.on('end', () => {
422422
activeRequestStream = null;
423-
const applicationLatency = userStream.getTotalDurationMs();
424423
metricsCollector.onOperationComplete(
425424
grpc.status.OK,
426425
userStream.getTotalDurationMs(),

0 commit comments

Comments
 (0)