This is an automated email from the ASF dual-hosted git repository.
xiazcy pushed a commit to branch 3.7-dev
in repository https://gitbox.apache.org/repos/asf/tinkerpop.git
The following commit(s) were added to refs/heads/3.7-dev by this push:
new b305bc9a29 CTR logging docs for javascript
b305bc9a29 is described below
commit b305bc9a294f1953d904478c70fb1f4e18545fd9
Author: Yang Xia <[email protected]>
AuthorDate: Fri Dec 5 10:04:47 2025 -0800
CTR logging docs for javascript
---
docs/src/reference/gremlin-variants.asciidoc | 50 ++++++++++++++++++++++++++++
1 file changed, 50 insertions(+)
diff --git a/docs/src/reference/gremlin-variants.asciidoc
b/docs/src/reference/gremlin-variants.asciidoc
index dd013b642f..100c0013a4 100644
--- a/docs/src/reference/gremlin-variants.asciidoc
+++ b/docs/src/reference/gremlin-variants.asciidoc
@@ -1520,6 +1520,56 @@ can be passed in the constructor of a new `Client` or
`DriverRemoteConnection` :
|options.pongTimeout |Number |Timeout of pong response in ms after sending a
ping. |30000
|=========================================================
+[[gremlin-javascript-logging]]
+=== Logging
+
+The Gremlin-JavaScript driver emits connection events for logging and
monitoring, but these events are silently ignored unless a listener is
attached. Use the `addListener()` method to subscribe to events after creating
a `DriverRemoteConnection` or `Client`:
+
+[source,javascript]
+----
+// Using DriverRemoteConnection
+const dc = new DriverRemoteConnection('ws://localhost:8182/gremlin');
+
+dc.addListener('log', (message) => {
+ console.log('[Gremlin Log]', message);
+});
+
+dc.addListener('socketError', (err) => {
+ console.error('[Gremlin Error]', err);
+});
+
+dc.addListener('close', (code, message) => {
+ console.warn('[Gremlin Close]', code, message);
+});
+
+const g = traversal().withRemote(dc);
+
+// Using Client
+const client = new Client('ws://localhost:8182/gremlin', { traversalSource:
'g' });
+
+client.addListener('log', (message) => {
+ console.log('[Gremlin Log]', message);
+});
+
+client.addListener('socketError', (err) => {
+ console.error('[Gremlin Error]', err);
+});
+
+client.addListener('close', (code, message) => {
+ console.warn('[Gremlin Close]', code, message);
+});
+
+await client.open();
+----
+
+Available events:
+
+* `log` - General connection logs (open, ping, pong, close, errors)
+* `socketError` - WebSocket errors
+* `close` - Connection close with status code and message
+
+To remove a listener, use `removeListener(event, handler)` with the same
handler reference.
+
[[gremlin-javascript-transactions]]
=== Transactions
