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
114 lines
3.5 KiB
Python
114 lines
3.5 KiB
Python
from __future__ import annotations
|
|
|
|
import json
|
|
import time
|
|
from pathlib import Path
|
|
|
|
from ktx_daemon.telemetry.emitter import track_telemetry_event
|
|
from ktx_daemon.telemetry.events import build_telemetry_event
|
|
from ktx_daemon.telemetry.identity import load_telemetry_identity, reset_identity_cache
|
|
|
|
|
|
def write_identity(home: Path, *, enabled: bool = True) -> None:
|
|
target = home / ".ktx" / "telemetry.json"
|
|
target.parent.mkdir(parents=True, exist_ok=True)
|
|
target.write_text(
|
|
json.dumps(
|
|
{
|
|
"installId": "00000000-0000-4000-8000-000000000000",
|
|
"enabled": enabled,
|
|
"noticeShownAt": "2026-05-22T14:33:02.000Z",
|
|
"noticeShownVersion": 1,
|
|
"createdAt": "2026-05-22T14:33:02.000Z",
|
|
}
|
|
)
|
|
+ "\n",
|
|
encoding="utf-8",
|
|
)
|
|
|
|
|
|
def test_identity_reads_file_with_ttl_cache(tmp_path: Path) -> None:
|
|
reset_identity_cache()
|
|
write_identity(tmp_path)
|
|
|
|
first = load_telemetry_identity(home_dir=tmp_path, env={}, now=lambda: 100.0)
|
|
assert first.enabled is True
|
|
assert first.install_id == "00000000-0000-4000-8000-000000000000"
|
|
|
|
write_identity(tmp_path, enabled=False)
|
|
cached = load_telemetry_identity(home_dir=tmp_path, env={}, now=lambda: 120.0)
|
|
assert cached.enabled is True
|
|
|
|
refreshed = load_telemetry_identity(home_dir=tmp_path, env={}, now=lambda: 161.0)
|
|
assert refreshed.enabled is False
|
|
|
|
|
|
def test_identity_honors_python_env_kill_switches(tmp_path: Path) -> None:
|
|
for kill_switch in ("KTX_TELEMETRY_DISABLED", "DO_NOT_TRACK", "CI"):
|
|
reset_identity_cache()
|
|
write_identity(tmp_path)
|
|
|
|
disabled = load_telemetry_identity(
|
|
home_dir=tmp_path,
|
|
env={kill_switch: "1"},
|
|
now=lambda: time.monotonic(),
|
|
)
|
|
|
|
assert disabled.enabled is False, f"{kill_switch} should disable telemetry"
|
|
assert disabled.install_id == "00000000-0000-4000-8000-000000000000"
|
|
|
|
|
|
def test_event_builder_rejects_unknown_fields() -> None:
|
|
event = build_telemetry_event(
|
|
"sql_gen_completed",
|
|
{
|
|
"outcome": "ok",
|
|
"dialect": "postgres",
|
|
"durationMs": 5,
|
|
},
|
|
)
|
|
|
|
assert event["event"] == "sql_gen_completed"
|
|
assert event["properties"]["runtime"] == "daemon-py"
|
|
|
|
try:
|
|
build_telemetry_event(
|
|
"sql_gen_completed",
|
|
{
|
|
"outcome": "ok",
|
|
"dialect": "postgres",
|
|
"durationMs": 5,
|
|
"sql": "select * from private_table",
|
|
},
|
|
)
|
|
except ValueError as error:
|
|
assert "unknown telemetry fields" in str(error)
|
|
else:
|
|
raise AssertionError("expected unknown field rejection")
|
|
|
|
|
|
def test_debug_emitter_writes_payload_without_network(tmp_path: Path, capsys) -> None:
|
|
reset_identity_cache()
|
|
write_identity(tmp_path)
|
|
|
|
track_telemetry_event(
|
|
"sl_plan_completed",
|
|
{
|
|
"outcome": "ok",
|
|
"stage": "transpile",
|
|
"durationMs": 12,
|
|
"sourceCount": 1,
|
|
"joinCount": 0,
|
|
},
|
|
project_id="a" * 64,
|
|
home_dir=tmp_path,
|
|
env={"KTX_TELEMETRY_DEBUG": "1"},
|
|
)
|
|
|
|
captured = capsys.readouterr()
|
|
assert '"event": "sl_plan_completed"' in captured.err
|
|
assert (
|
|
'"groups": {"project": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"}'
|
|
in captured.err
|
|
)
|
|
assert "private_table" not in captured.err
|