Add StatsControl support by mayankkumar12345 · Pull Request #68 · oracle/nosql-node-sdk

mayankkumar12345 · 2026-06-22T08:01:21Z

Adds Java SDK parity StatsControl support to the Node.js SDK.

Includes:

StatsControl public API
stats profile, interval, pretty print, enable log, handler, start/stop
request, retry, latency, request size, result size, connection stats
query stats under ALL profile
p95/p99 latency support
HttpClient.execute() stats integration
stats examples and load-check helper
unit and functional test coverage
README documentation

Validation:

npm run test:mocha -- --no-config --reporter dot test/unit/stats.js test/unit/stats_control.js
npm run test:stats-functional:cloudsim
npm run test:tsc
npm pack --dry-run

Notes:

CloudSim stats load check should use:
node examples/javascript/stats_load_check.js --config examples/config/cloudsim.json --operation fullFlow --table Users --profile ALL --total 1 --concurrency 1
KV proxy/KVLite stats load check should use:
node examples/javascript/stats_load_check.js --config examples/config/kvlite.json --operation fullFlow --table Users --profile ALL --total 1 --concurrency 1
ALL profile can include query text and query plans, matching Java SDK behaviour.

oracle-contributor-agreement · 2026-06-22T08:01:27Z

Thank you for your pull request and welcome to our community! To contribute, please sign the Oracle Contributor Agreement (OCA).
The following contributors of this PR have not signed the OCA:

To sign the OCA, please create an Oracle account and sign the OCA in Oracle's Contributor Agreement Application.

When signing the OCA, please provide your GitHub username. After signing the OCA and getting an OCA approval from Oracle, this PR will be automatically updated.

If you are an Oracle employee, please make sure that you are a member of the main Oracle GitHub organization, and your membership in this organization is public.

…ol is exposed to the client

… resolved that

…statscontrol

mayankkumar12345 · 2026-06-26T06:49:13Z

I updated the PR based on the Java parity review.

Main changes:

Cleaned up the public client API so stats are accessed through getStatsControl(), instead of exposing extra stats helper methods directly on NoSQLClient.
Restored Java-style chaining for StatsControl setters: setProfile(), setPrettyPrint(), and setStatsHandler().
Kept start() and stop() as void methods, matching Java.
Moved logical query stats collection so it happens only after query defaults and validation succeed.
Fixed interval behavior so setProfile() alone does not start interval logging; start() is what activates it, like Java.
Added regression tests for the query validation case and interval-start behavior.

Validation:
npm run test:mocha -- --no-config --reporter dot test/unit/stats.js test/unit/stats_control.js
npm run test:tsc

connelly38 · 2026-06-29T19:51:25Z

@mayankkumar12345 @Akshay-Sundarraj I recommend you add @cezarfx as a reviewer.

Akshay-Sundarraj · 2026-06-23T07:25:34Z

+     * or the statistics were last cleared.
+     * @returns {object} Statistics object
+     */
+    getStats(): object;


In Java user register StatsHandler and get a call-back periodically. How it works in nodejs? Why client has methods to expose stats?

Now client is exposed to the statscontrol only.

Akshay-Sundarraj · 2026-06-23T09:21:06Z

+        console.error(err);
+    } finally {
+        if (client != null) {
+            const stats = client.getStats();


In java and python client does not expose stats directly. Also, do we have a way to start and stop collection like in statsControl.start(); and statsControl.stop();

Now client is exposed to the statscontrol only so the client.getstats() is removed.Yes there is the way to start and stop the collections using start() and stop() functions.

Akshay-Sundarraj · 2026-06-29T14:23:56Z

+  * log output should be pretty-printed.
+  * @property {boolean} [statsEnableLog=true] Whether interval statistics
+  * should be logged.
+  * @property {function|object} [statsHandler] Handler called with a statistics


Can statsHandler be concrete class instead of object?

Yes we can but this implementation supports a function callback or an object with accept(stats), matching Java’s handler.accept(stats) style that's why I kept it like this.

I updated the JSDoc to document this as StatsHandler instead of generic function|object, so its clear that plain objects are not valid unless they implement accept(stats).

… recording logical query stats. - Updated examples/docs to prefer StatsControl.Profile constants instead of raw profile strings. - Added JSDoc for StatsHandler to show it accepts either a callback function or an object with accept(stats). - Added short comments in stats.js and stats_control.js to explain the main stats classes and flow. - Added top-level comments in stats-related test files.

…ckets

mayankkumar12345

Addressed review comments and added replies for the remaining points.

mayankkumar12345 · 2026-06-30T07:24:43Z

+            throw new NoSQLArgumentError(
+                `Invalid statsEnableLog value: ${cfg.statsEnableLog}`, cfg);
+        }
+        if (cfg.statsHandler != null &&


but user can pass anything in stats handler so this check would be necessary.

mayankkumar12345 · 2026-06-30T07:32:58Z

+  * log output should be pretty-printed.
+  * @property {boolean} [statsEnableLog=true] Whether interval statistics
+  * should be logged.
+  * @property {function|object} [statsHandler] Handler called with a statistics


Yes we can but this implementation supports a function callback or an object with accept(stats), matching Java’s handler.accept(stats) style that's why I kept it like this.

I updated the JSDoc to document this as StatsHandler instead of generic function|object, so its clear that plain objects are not valid unless they implement accept(stats).

mayankkumar12345 · 2026-06-30T08:15:08Z

+     * or the statistics were last cleared.
+     * @returns {object} Statistics object
+     */
+    getStats(): object;


Now client is exposed to the statscontrol only.

mayankkumar12345 · 2026-06-30T08:16:36Z

+        console.error(err);
+    } finally {
+        if (client != null) {
+            const stats = client.getStats();


Now client is exposed to the statscontrol only so the client.getstats() is removed.Yes there is the way to start and stop the collections using start() and stop() functions.

Akshay-Sundarraj

I've checked basic flow and formatting. Looks fine to me. Get approval from @cezarfx and merge

Akshay-Sundarraj · 2026-07-01T08:58:27Z

Please check with cezar on git commit. Ideally we should have only 1 commit log for this entire PR

oracle-contributor-agreement Bot added the OCA Required At least one contributor does not have an approved Oracle Contributor Agreement. label Jun 22, 2026

Add Java-parity StatsControl support

8ea3457

mayankkumar12345 force-pushed the statscontrol-port branch from 2582b0c to 8ea3457 Compare June 22, 2026 08:15

oracle-contributor-agreement Bot added OCA Verified All contributors have signed the Oracle Contributor Agreement. and removed OCA Required At least one contributor does not have an approved Oracle Contributor Agreement. labels Jun 22, 2026

Mayank Kumar added 4 commits June 25, 2026 16:21

extra apis that are exposed to client are removed and only statscontr…

b5b8904

…ol is exposed to the client

in query count and httprequest count were showing the same result so…

eba92b1

… resolved that

start and stop functions are void in the java but node was returning …

6a5b5c0

…statscontrol

minute changes

6c9d84e

mayankkumar12345 requested a review from Akshay-Sundarraj June 29, 2026 09:43

Akshay-Sundarraj reviewed Jun 30, 2026

View reviewed changes

Mayank Kumar added 2 commits June 30, 2026 13:49

connection count was including the freesockets also so removed freeso…

2a9f13c

…ckets

mayankkumar12345 requested review from Akshay-Sundarraj and cezarfx June 30, 2026 09:50

now start()function is aligned to java

857eec7

mayankkumar12345 commented Jul 1, 2026

View reviewed changes

connection count was giving wrong result so resolved

f71fc9c

Akshay-Sundarraj previously approved these changes Jul 1, 2026

View reviewed changes

important commands to start kvlite in non secure mode

4cad5fc

mayankkumar12345 dismissed Akshay-Sundarraj’s stale review via 4cad5fc July 3, 2026 10:17

mayankkumar12345 requested a review from Akshay-Sundarraj July 3, 2026 10:17

Uh oh!

Conversation

mayankkumar12345 commented Jun 22, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

oracle-contributor-agreement Bot commented Jun 22, 2026

Uh oh!

mayankkumar12345 commented Jun 26, 2026

Uh oh!

connelly38 commented Jun 29, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mayankkumar12345 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Akshay-Sundarraj left a comment

Choose a reason for hiding this comment

Uh oh!

Akshay-Sundarraj commented Jul 1, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

mayankkumar12345 commented Jun 22, 2026 •

edited

Loading