mirror of
https://github.com/Kaelio/ktx.git
synced 2026-07-13 11:22:11 +02:00
feat(telemetry): anonymous posthog usage telemetry across node cli and python daemon (#205)
* 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
This commit is contained in:
parent
c87d14a554
commit
b0dd13ce7c
73 changed files with 6576 additions and 48 deletions
151
packages/cli/src/telemetry/identity.ts
Normal file
151
packages/cli/src/telemetry/identity.ts
Normal file
|
|
@ -0,0 +1,151 @@
|
|||
import { createHash, randomUUID } from 'node:crypto';
|
||||
import { mkdir, readFile, writeFile } from 'node:fs/promises';
|
||||
import { homedir } from 'node:os';
|
||||
import { dirname, join, resolve } from 'node:path';
|
||||
import { z } from 'zod';
|
||||
|
||||
/** @internal */
|
||||
export const TELEMETRY_NOTICE =
|
||||
'ktx collects anonymous usage data to improve the product. Opt out: set KTX_TELEMETRY_DISABLED=1.';
|
||||
|
||||
const NOTICE_VERSION = 1;
|
||||
|
||||
const telemetryFileSchema = z
|
||||
.object({
|
||||
installId: z.uuid(),
|
||||
enabled: z.boolean(),
|
||||
noticeShownAt: z.string().optional(),
|
||||
noticeShownVersion: z.number().int().optional(),
|
||||
createdAt: z.string(),
|
||||
})
|
||||
.strict();
|
||||
|
||||
/** @internal */
|
||||
export interface TelemetryIdentityEnv {
|
||||
KTX_TELEMETRY_DISABLED?: string;
|
||||
DO_NOT_TRACK?: string;
|
||||
CI?: string;
|
||||
NO_COLOR?: string;
|
||||
TERM?: string;
|
||||
}
|
||||
|
||||
function styleNotice(notice: string, env: TelemetryIdentityEnv): string {
|
||||
if (env.NO_COLOR || env.TERM === 'dumb') return notice;
|
||||
return `[2m${notice}[22m`;
|
||||
}
|
||||
|
||||
export interface LoadTelemetryIdentityOptions {
|
||||
homeDir?: string;
|
||||
env?: TelemetryIdentityEnv;
|
||||
stdoutIsTTY: boolean;
|
||||
stderr: { write(chunk: string): void };
|
||||
now?: () => Date;
|
||||
}
|
||||
|
||||
export interface TelemetryIdentityState {
|
||||
installId?: string;
|
||||
enabled: boolean;
|
||||
createdFile: boolean;
|
||||
noticeShown: boolean;
|
||||
path: string;
|
||||
}
|
||||
|
||||
function telemetryPath(homeDir: string): string {
|
||||
return join(homeDir, '.ktx', 'telemetry.json');
|
||||
}
|
||||
|
||||
function envDisablesTelemetry(env: TelemetryIdentityEnv): boolean {
|
||||
return Boolean(env.KTX_TELEMETRY_DISABLED || env.DO_NOT_TRACK || env.CI);
|
||||
}
|
||||
|
||||
async function readTelemetryFile(path: string): Promise<z.infer<typeof telemetryFileSchema> | null> {
|
||||
try {
|
||||
return telemetryFileSchema.parse(JSON.parse(await readFile(path, 'utf-8')));
|
||||
} catch {
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
async function writeTelemetryFile(path: string, value: z.infer<typeof telemetryFileSchema>): Promise<void> {
|
||||
await mkdir(dirname(path), { recursive: true });
|
||||
await writeFile(path, `${JSON.stringify(value, null, 2)}\n`, 'utf-8');
|
||||
}
|
||||
|
||||
export async function loadTelemetryIdentity(options: LoadTelemetryIdentityOptions): Promise<TelemetryIdentityState> {
|
||||
const env = options.env ?? process.env;
|
||||
const path = telemetryPath(options.homeDir ?? homedir());
|
||||
|
||||
if (envDisablesTelemetry(env) || options.stdoutIsTTY !== true) {
|
||||
const existing = await readTelemetryFile(path);
|
||||
return {
|
||||
installId: existing?.installId,
|
||||
enabled: false,
|
||||
createdFile: false,
|
||||
noticeShown: false,
|
||||
path,
|
||||
};
|
||||
}
|
||||
|
||||
const existing = await readTelemetryFile(path);
|
||||
if (existing) {
|
||||
return {
|
||||
installId: existing.installId,
|
||||
enabled: existing.enabled,
|
||||
createdFile: false,
|
||||
noticeShown: false,
|
||||
path,
|
||||
};
|
||||
}
|
||||
|
||||
const timestamp = (options.now ?? (() => new Date()))().toISOString();
|
||||
const next = {
|
||||
installId: randomUUID(),
|
||||
enabled: true,
|
||||
noticeShownAt: timestamp,
|
||||
noticeShownVersion: NOTICE_VERSION,
|
||||
createdAt: timestamp,
|
||||
};
|
||||
|
||||
try {
|
||||
await writeTelemetryFile(path, next);
|
||||
} catch {
|
||||
return {
|
||||
enabled: false,
|
||||
createdFile: false,
|
||||
noticeShown: false,
|
||||
path,
|
||||
};
|
||||
}
|
||||
|
||||
options.stderr.write(`${styleNotice(TELEMETRY_NOTICE, env)}\n`);
|
||||
|
||||
return {
|
||||
installId: next.installId,
|
||||
enabled: true,
|
||||
createdFile: true,
|
||||
noticeShown: true,
|
||||
path,
|
||||
};
|
||||
}
|
||||
|
||||
export function computeTelemetryProjectId(installId: string, projectDir: string): string {
|
||||
return createHash('sha256').update(`${installId}:${resolve(projectDir)}`).digest('hex');
|
||||
}
|
||||
|
||||
export async function readExistingTelemetryProjectId(options: {
|
||||
projectDir: string;
|
||||
homeDir?: string;
|
||||
env?: Pick<TelemetryIdentityEnv, 'KTX_TELEMETRY_DISABLED' | 'DO_NOT_TRACK'>;
|
||||
}): Promise<string | undefined> {
|
||||
const env = options.env ?? process.env;
|
||||
if (env.KTX_TELEMETRY_DISABLED || env.DO_NOT_TRACK) {
|
||||
return undefined;
|
||||
}
|
||||
|
||||
const existing = await readTelemetryFile(telemetryPath(options.homeDir ?? homedir()));
|
||||
if (!existing?.enabled) {
|
||||
return undefined;
|
||||
}
|
||||
|
||||
return computeTelemetryProjectId(existing.installId, options.projectDir);
|
||||
}
|
||||
Loading…
Add table
Add a link
Reference in a new issue