Skip to content

Commit 1c0fff1

Browse files
committed
chore: move telemetry MD docs to follow-up PR
Remove docs/TELEMETRY.md, spec/telemetry-design.md, spec/telemetry-sprint-plan.md, spec/telemetry-test-completion-summary.md and revert README.md — these ~4.9k lines of markdown are being split into a stacked docs-only PR on top of this branch to keep the [4/7] diff focused on code. Co-authored-by: Isaac Signed-off-by: samikshya-chand_data <samikshya.chand@databricks.com>
1 parent 457b67d commit 1c0fff1

5 files changed

Lines changed: 0 additions & 4906 deletions

File tree

README.md

Lines changed: 0 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -51,53 +51,6 @@ client
5151
});
5252
```
5353

54-
## Telemetry
55-
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).
100-
10154
## Run Tests
10255

10356
### Unit tests

0 commit comments

Comments
 (0)