Skip to content

feat: Collect client side metrics for sampleRowKeys calls #1660

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
gcf-merge-on-green merged 4 commits into from
Aug 7, 2025
Merged

feat: Collect client side metrics for sampleRowKeys calls #1660

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3b95036
Attach metadata to the request stream
danieljbruce Jul 31, 2025
cd7bff3
Merge branch 'main' of https://github.com/googleapis/nodejs-bigtable …
danieljbruce Aug 1, 2025
c30e375
Merge branch 'main' into 359913994-sample-row-keys-with-timed-stream
danieljbruce Aug 5, 2025
b403202
Merge branch 'main' into 359913994-sample-row-keys-with-timed-stream
danieljbruce Aug 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 23 additions & 10 deletions src/tabular-api-surface.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -462,16 +462,29 @@ Please use the format 'prezzy' or '${instance.name}/tables/prezzy'.`);
},
objectMode: true,
});

return pumpify.obj([
this.bigtable.request({
client: 'BigtableClient',
method: 'sampleRowKeys',
reqOpts,
gaxOpts: Object.assign({}, gaxOptions),
}),
rowKeysStream,
]);
const metricsCollector =
this.bigtable._metricsConfigManager.createOperation(
MethodName.SAMPLE_ROW_KEYS,
StreamingState.STREAMING,
this,
);
metricsCollector.onOperationStart();
metricsCollector.onAttemptStart();
const requestStream = this.bigtable.request({
client: 'BigtableClient',
method: 'sampleRowKeys',
reqOpts,
gaxOpts: Object.assign({}, gaxOptions),
});
metricsCollector.wrapRequest(requestStream);
const stream = pumpify.obj([requestStream, rowKeysStream]);
stream.on('end', () => {
metricsCollector.onOperationComplete(0);
});
stream.on('error', (err: ServiceError) => {
metricsCollector.onOperationComplete(err.code);
});
return stream;
}
}

Expand Down
228 changes: 227 additions & 1 deletion system-test/client-side-metrics-all-methods.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -215,6 +215,18 @@ function checkMutateRowsCall(
);
}

function checkSampleRowKeysCall(
projectId: string,
requestsHandled: (OnOperationCompleteData | OnAttemptCompleteData)[] = [],
) {
readRowsAssertionCheck(
projectId,
requestsHandled,
'Bigtable.SampleRowKeys',
'true',
);
}

function checkMutateRowCall(
projectId: string,
requestsHandled: (OnOperationCompleteData | OnAttemptCompleteData)[] = [],
Expand Down Expand Up @@ -440,6 +452,86 @@ describe('Bigtable/ClientSideMetricsAllMethods', () => {
);
}

describe('SampleRowKeys', () => {
it('should send the metrics to Google Cloud Monitoring for a SampleRowKeys call', done => {
(async () => {
try {
const bigtable = await mockBigtable(defaultProjectId, done);
for (const instanceId of [instanceId1, instanceId2]) {
await setupBigtableWithInsert(
bigtable,
columnFamilyId,
instanceId,
[tableId1, tableId2],
);
const instance = bigtable.instance(instanceId);
const table = instance.table(tableId1);
await table.sampleRowKeys();
const table2 = instance.table(tableId2);
await table2.sampleRowKeys();
}
} catch (e) {
done(new Error('An error occurred while running the script'));
done(e);
}
})().catch(err => {
throw err;
});
});
it('should send the metrics to Google Cloud Monitoring for a custom endpoint', done => {
(async () => {
try {
const bigtable = await mockBigtable(
defaultProjectId,
done,
'bogus-endpoint',
);
const instance = bigtable.instance(instanceId1);
const table = instance.table(tableId1);
try {
// This call will fail because we are trying to hit a bogus endpoint.
// The idea here is that we just want to record at least one metric
// so that the exporter gets executed.
await table.sampleRowKeys();
} catch (e: unknown) {
// Try blocks just need a catch/finally block.
}
} catch (e) {
done(new Error('An error occurred while running the script'));
done(e);
}
})().catch(err => {
throw err;
});
});
it('should send the metrics to Google Cloud Monitoring for a SampleRowKeys call with a second project', done => {
(async () => {
try {
// This is the second project the test is configured to work with:
const projectId = SECOND_PROJECT_ID;
const bigtable = await mockBigtable(projectId, done);
for (const instanceId of [instanceId1, instanceId2]) {
await setupBigtableWithInsert(
bigtable,
columnFamilyId,
instanceId,
[tableId1, tableId2],
);
const instance = bigtable.instance(instanceId);
const table = instance.table(tableId1);
await table.sampleRowKeys();
const table2 = instance.table(tableId2);
await table2.sampleRowKeys();
}
} catch (e) {
done(new Error('An error occurred while running the script'));
done(e);
}
})().catch(err => {
throw err;
});
});
});
describe('ReadRows', () => {
it('should send the metrics to Google Cloud Monitoring for a ReadRows call', done => {
(async () => {
Expand Down Expand Up @@ -825,6 +917,107 @@ describe('Bigtable/ClientSideMetricsAllMethods', () => {
return getFakeBigtable(projectId, getHandlerFromExporter(TestExporter));
}

describe('SampleRowKeys', () => {
it('should send the metrics to Google Cloud Monitoring for a SampleRowKeys call', done => {
let testFinished = false;
/*
We need to create a timeout here because if we don't then mocha shuts down
the test as it is sleeping before the GCPMetricsHandler has a chance to
export the data. When the timeout is finished, if there were no export
errors then the test passes.
*/
setTimeout(() => {
testFinished = true;
done();
}, 120000);
(async () => {
try {
const bigtable1 = await mockBigtable(defaultProjectId, done);
const bigtable2 = await mockBigtable(defaultProjectId, done);
for (const bigtable of [bigtable1, bigtable2]) {
for (const instanceId of [instanceId1, instanceId2]) {
await setupBigtableWithInsert(
bigtable,
columnFamilyId,
instanceId,
[tableId1, tableId2],
);
const instance = bigtable.instance(instanceId);
const table = instance.table(tableId1);
await table.sampleRowKeys();
const table2 = instance.table(tableId2);
await table2.sampleRowKeys();
}
}
} catch (e) {
done(new Error('An error occurred while running the script'));
done(e);
}
})().catch(err => {
throw err;
});
});
it('should send the metrics to Google Cloud Monitoring for a SampleRowKeys call with thirty clients', done => {
/*
We need to create a timeout here because if we don't then mocha shuts down
the test as it is sleeping before the GCPMetricsHandler has a chance to
export the data. When the timeout is finished, if there were no export
errors then the test passes.
*/
const testTimeout = setTimeout(() => {
done(new Error('The test timed out'));
}, 480000);
let testComplete = false;
const numClients = 30;
(async () => {
try {
const bigtableList = [];
const completedSet = new Set();
for (
let bigtableCount = 0;
bigtableCount < numClients;
bigtableCount++
) {
const currentCount = bigtableCount;
const onExportSuccess = () => {
completedSet.add(currentCount);
if (completedSet.size === numClients) {
// If every client has completed the export then pass the test.
clearTimeout(testTimeout);
if (!testComplete) {
testComplete = true;
done();
}
}
};
bigtableList.push(
await mockBigtable(defaultProjectId, done, onExportSuccess),
);
}
for (const bigtable of bigtableList) {
for (const instanceId of [instanceId1, instanceId2]) {
await setupBigtableWithInsert(
bigtable,
columnFamilyId,
instanceId,
[tableId1, tableId2],
);
const instance = bigtable.instance(instanceId);
const table = instance.table(tableId1);
await table.sampleRowKeys();
const table2 = instance.table(tableId2);
await table2.sampleRowKeys();
}
}
} catch (e) {
done(e);
done(new Error('An error occurred while running the script'));
}
})().catch(err => {
throw err;
});
});
});
describe('ReadRows', () => {
it('should send the metrics to Google Cloud Monitoring for a ReadRows call', done => {
let testFinished = false;
Expand Down Expand Up @@ -1295,7 +1488,40 @@ describe('Bigtable/ClientSideMetricsAllMethods', () => {
]);
return bigtable;
}

describe('SampleRowKeys', () => {
it('should send the metrics to the metrics handler for a SampleRowKeys call', done => {
(async () => {
const bigtable = await mockBigtableWithNoInserts(
defaultProjectId,
done,
checkSampleRowKeysCall,
);
const instance = bigtable.instance(instanceId1);
const table = instance.table(tableId1);
await table.sampleRowKeys();
const table2 = instance.table(tableId2);
await table2.sampleRowKeys();
})().catch(err => {
throw err;
});
});
it('should pass the projectId to the metrics handler properly', done => {
(async () => {
const bigtable = await mockBigtableWithNoInserts(
defaultProjectId,
done,
checkSampleRowKeysCall,
);
const instance = bigtable.instance(instanceId1);
const table = instance.table(tableId1);
await table.sampleRowKeys();
const table2 = instance.table(tableId2);
await table2.sampleRowKeys();
})().catch(err => {
throw err;
});
});
});
describe('ReadRows', () => {
it('should send the metrics to the metrics handler for a ReadRows call', done => {
(async () => {
Expand Down
Loading