mirror of
https://github.com/Kaelio/ktx.git
synced 2026-06-22 08:38:08 +02:00
Merge remote-tracking branch 'origin/snowflake-multiple-schemas' into snowflake-ingest-perf-report
# Conflicts: # packages/cli/src/connectors/snowflake/connector.ts # packages/cli/src/context/scan/local-scan.test.ts # packages/cli/src/context/scan/local-scan.ts # packages/cli/src/setup-databases.test.ts # packages/cli/src/setup-databases.ts
This commit is contained in:
commit
101f80e33b
119 changed files with 8366 additions and 360 deletions
|
|
@ -1,5 +1,5 @@
|
|||
{
|
||||
"title": "Community",
|
||||
"defaultOpen": true,
|
||||
"pages": ["support", "contributing"]
|
||||
"pages": ["support", "contributing", "telemetry"]
|
||||
}
|
||||
|
|
|
|||
42
docs-site/content/docs/community/telemetry.mdx
Normal file
42
docs-site/content/docs/community/telemetry.mdx
Normal file
|
|
@ -0,0 +1,42 @@
|
|||
---
|
||||
title: Telemetry
|
||||
description: Understand what anonymous usage telemetry ktx collects and how to opt out.
|
||||
---
|
||||
|
||||
**ktx** collects anonymous, aggregated usage telemetry from interactive CLI
|
||||
runs so maintainers can see which commands work, where setup fails, and which
|
||||
parts of the data-agent workflow need improvement. Telemetry is opt-out and
|
||||
disabled automatically in CI and non-interactive runs.
|
||||
|
||||
## Opt out
|
||||
|
||||
Use any of these mechanisms to disable telemetry:
|
||||
|
||||
| Mechanism | Effect |
|
||||
|-----------|--------|
|
||||
| `export KTX_TELEMETRY_DISABLED=1` | Disables telemetry for the shell and child processes |
|
||||
| `export DO_NOT_TRACK=1` | Standard do-not-track environment variable |
|
||||
| `CI=1` | Automatic in CI |
|
||||
| Non-TTY output | Automatic for pipes and scripts |
|
||||
| Edit `~/.ktx/telemetry.json` and set `"enabled": false` | Persistent for the machine |
|
||||
|
||||
## What we collect
|
||||
|
||||
High-level signals only: which commands run, how long they take, whether they
|
||||
succeed or fail, and basic environment metadata (CLI version, Node version, OS
|
||||
platform). For project-level analysis, **ktx** sends a salted hash of the
|
||||
project directory — never the raw path.
|
||||
|
||||
## What we never collect
|
||||
|
||||
- File paths, hostnames, environment variable values, or command arguments
|
||||
- `ktx.yaml` contents, connection passwords, API keys, or tokens
|
||||
- Schema names, table names, column names, SQL text, or query results
|
||||
- Error messages or stack traces
|
||||
- Git remote URLs, Git user email, OS user, or hostname
|
||||
|
||||
## Storage and retention
|
||||
|
||||
Telemetry is sent to PostHog, a third-party product-analytics service used by
|
||||
the **ktx** maintainers. Raw event data is retained for 90 days. Aggregated
|
||||
counts may be retained indefinitely.
|
||||
|
|
@ -129,20 +129,18 @@ connections:
|
|||
account: xy12345
|
||||
warehouse: ANALYTICS_WH
|
||||
database: PROD
|
||||
schema_name: PUBLIC
|
||||
schema_names:
|
||||
- PUBLIC
|
||||
- SALES
|
||||
- MARKETING
|
||||
username: KTX_SERVICE
|
||||
password: env:SNOWFLAKE_PASSWORD
|
||||
role: ANALYST
|
||||
```
|
||||
|
||||
For multiple schemas:
|
||||
|
||||
```yaml
|
||||
schema_names:
|
||||
- PUBLIC
|
||||
- ANALYTICS
|
||||
- STAGING
|
||||
```
|
||||
`ktx setup` discovers schemas after the connection is verified and writes the
|
||||
selected list to `schema_names`. You can also set this field manually. For a
|
||||
single schema, `schema_name: PUBLIC` is accepted as an equivalent shorthand.
|
||||
|
||||
### Authentication
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue