mirror of
https://github.com/Kaelio/ktx.git
synced 2026-06-07 07:55:13 +02:00
b0dd13ce7c
* feat: add telemetry phase 1
* feat: add node telemetry event catalog
* feat: add telemetry event helpers
* feat: emit setup and connection telemetry
* feat: emit connection and stack telemetry
* feat: emit ingest and scan telemetry
* feat: emit query telemetry
* feat: emit sampled mcp telemetry
* docs: expand telemetry event catalog
* feat: add telemetry schema sync artifact
* feat: pass telemetry project id to semantic daemon
* feat: add daemon telemetry foundation
* feat: emit semantic daemon telemetry
* feat: emit daemon lifecycle telemetry
* docs: document full telemetry event catalog
* feat(telemetry): dim first-run notice
* feat(telemetry): show first-run notice before command output
* feat(telemetry): wire ktx PostHog project for live ingestion
* docs(telemetry): drop posthog project name and host from storage section
* docs(telemetry): trim to general overview and disclaimer
* docs(agents): add short telemetry guidelines
* feat(telemetry): enable posthog geoip enrichment
* docs(telemetry): drop ip-geoip note from public overview
* refactor(telemetry): drop no-op groupIdentify, rely on capture groups field
* fix(telemetry): respect CI kill switch in python daemon identity
* fix(sql): route table-count analysis to existing analyze-batch endpoint
* fix(telemetry): emit install_first_run from notice path and derive flagsPresent from commander
* fix(telemetry): read package info via getKtxCliPackageInfo to satisfy boundary check
* fix(telemetry): make python identity env={} bypass os.environ and unset CI in tests
* fix(telemetry): unset CI kill switch in cli-program-telemetry tests
42 lines
1.6 KiB
Text
42 lines
1.6 KiB
Text
---
|
|
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.
|