Skip to content

Commit bc2e4e4

Browse files
committed
docs: shorten README telemetry section
Replace the verbose bulleted overview with a tight three-sentence blurb that names what's collected, where the opt-outs live, and points readers to docs/TELEMETRY.md for everything else. Co-authored-by: Isaac
1 parent ca55f0c commit bc2e4e4

1 file changed

Lines changed: 9 additions & 44 deletions

File tree

README.md

Lines changed: 9 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -53,50 +53,15 @@ client
5353

5454
## Telemetry
5555

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
64-
65-
### What Data is Collected?
66-
67-
When enabled, the driver collects:
68-
69-
- ✅ Driver version and configuration settings
70-
- ✅ Query performance metrics (latency, chunk counts, bytes downloaded)
71-
- ✅ Error types and status codes
72-
- ✅ Feature usage (CloudFetch, Arrow format, compression)
73-
74-
**Never collected**:
75-
76-
- ❌ SQL query text
77-
- ❌ Query results or data values
78-
- ❌ Table/column names or schema information
79-
- ❌ User credentials or personal information
80-
81-
### Configuration
82-
83-
To enable or disable telemetry explicitly:
84-
85-
```javascript
86-
const client = new DBSQLClient({
87-
telemetryEnabled: true, // Enable telemetry (default: false)
88-
});
89-
90-
// Or override per connection:
91-
await client.connect({
92-
host: '********.databricks.com',
93-
path: '/sql/2.0/warehouses/****************',
94-
token: 'dapi********************************',
95-
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).
56+
The driver emits connection, statement, and CloudFetch metrics plus
57+
redacted error events to help Databricks improve driver reliability. No
58+
SQL text, parameter values, or row data is ever collected. Emission is
59+
gated by a server-side feature flag and can be disabled per-connection
60+
with `telemetryEnabled: false` or globally with the
61+
`DATABRICKS_TELEMETRY_DISABLED` env var.
62+
63+
See [docs/TELEMETRY.md](docs/TELEMETRY.md) for the full event payloads,
64+
tuning knobs, multi-tenant guidance, and troubleshooting.
10065

10166
## Run Tests
10267

0 commit comments

Comments
 (0)