You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: add telemetry design, test summary, and user guide
Rebases the docs PR onto main now that #327 has landed. Drops all code
changes from the diff; keeps only the new docs (docs/TELEMETRY.md,
spec/telemetry-design.md, spec/telemetry-test-completion-summary.md) and
swaps README's telemetry section to a short pointer to docs/TELEMETRY.md.
Co-authored-by: Isaac
-`telemetryCloseTimeoutMs` — bound on `await client.close()` waiting for
132
-
the final flush.
133
-
134
-
> **Note for short-lived processes**: always `await client.close()`
135
-
> before `process.exit(0)` so the final batch is flushed. Without an
136
-
> explicit close, the periodic flush timer is `unref()`'d to avoid
137
-
> holding the event loop open, so any unflushed events are dropped.
56
+
The Databricks SQL Driver for Node.js includes an **opt-in telemetry system** that collects driver usage metrics and performance data to help improve the driver. Telemetry is **disabled by default** and follows a **privacy-first design**.
57
+
58
+
### Key Features
59
+
60
+
-**Privacy-first**: No SQL queries, results, or sensitive data is ever collected
61
+
-**Opt-in**: Controlled by server-side feature flag (disabled by default)
62
+
-**Non-blocking**: All telemetry operations are asynchronous and never impact your queries
63
+
-**Resilient**: Circuit breaker protection prevents telemetry failures from affecting your application
telemetryEnabled:false, // Disable for this connection
96
+
});
97
+
```
98
+
99
+
For detailed documentation including configuration options, event types, troubleshooting, and privacy details, see [docs/TELEMETRY.md](docs/TELEMETRY.md).
0 commit comments