mirror of
https://github.com/Kaelio/ktx.git
synced 2026-06-10 08:05:14 +02:00
* 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
199 lines
6.7 KiB
TypeScript
199 lines
6.7 KiB
TypeScript
import { KtxIngestEmbeddingPortAdapter } from './context/llm/embedding-port.js';
|
|
import type { KtxEmbeddingPort } from './context/core/embedding.js';
|
|
import { loadKtxProject } from './context/project/project.js';
|
|
import { type LocalKnowledgeSearchResult, type LocalKnowledgeSummary, listLocalKnowledgePages, searchLocalKnowledgePages as defaultSearchLocalKnowledgePages } from './context/wiki/local-knowledge.js';
|
|
import {
|
|
resolveProjectEmbeddingProvider,
|
|
type EmbeddingProviderResolution,
|
|
} from './embedding-resolution.js';
|
|
import { resolveOutputMode } from './io/mode.js';
|
|
import { createRankBadgeFormatter, printList, type PrintListColumn } from './io/print-list.js';
|
|
import { emitTelemetryEvent } from './telemetry/index.js';
|
|
|
|
export type KtxKnowledgeArgs =
|
|
| { command: 'list'; projectDir: string; userId: string; output?: string; json?: boolean; cliVersion: string }
|
|
| {
|
|
command: 'search';
|
|
projectDir: string;
|
|
query: string;
|
|
userId: string;
|
|
output?: string;
|
|
json?: boolean;
|
|
limit?: number;
|
|
debug?: boolean;
|
|
cliVersion: string;
|
|
};
|
|
|
|
type KtxKnowledgeIo = import('./cli-runtime.js').KtxCliIo;
|
|
|
|
const WIKI_LIST_COLUMNS: ReadonlyArray<PrintListColumn<LocalKnowledgeSummary>> = [
|
|
{ key: 'scope', label: 'SCOPE', plain: '' },
|
|
{ key: 'key', label: 'KEY', plain: '' },
|
|
{ key: 'summary', label: 'SUMMARY', plain: '', optional: true, dim: true },
|
|
];
|
|
|
|
function wikiSearchColumns(
|
|
rows: ReadonlyArray<LocalKnowledgeSearchResult>,
|
|
): ReadonlyArray<PrintListColumn<LocalKnowledgeSearchResult>> {
|
|
return [
|
|
{
|
|
key: 'score',
|
|
label: 'SCORE',
|
|
plain: 'score=',
|
|
role: 'badge',
|
|
prettyFormat: createRankBadgeFormatter(rows),
|
|
dim: true,
|
|
},
|
|
{ key: 'scope', label: 'SCOPE', plain: '' },
|
|
{ key: 'key', label: 'KEY', plain: '' },
|
|
{ key: 'summary', label: 'SUMMARY', plain: '', optional: true, dim: true },
|
|
];
|
|
}
|
|
|
|
interface KtxKnowledgeDeps {
|
|
embeddingService?: KtxEmbeddingPort | null;
|
|
resolveEmbeddingProvider?: typeof resolveProjectEmbeddingProvider;
|
|
searchLocalKnowledgePages?: typeof defaultSearchLocalKnowledgePages;
|
|
}
|
|
|
|
function resolutionToEmbeddingPort(resolution: EmbeddingProviderResolution): KtxEmbeddingPort | null {
|
|
if (
|
|
resolution.kind === 'configured' ||
|
|
resolution.kind === 'managed-running' ||
|
|
resolution.kind === 'managed-started'
|
|
) {
|
|
return new KtxIngestEmbeddingPortAdapter(resolution.provider);
|
|
}
|
|
return null;
|
|
}
|
|
|
|
async function wikiSearchEmbeddingService(
|
|
project: Awaited<ReturnType<typeof loadKtxProject>>,
|
|
deps: KtxKnowledgeDeps,
|
|
args: { cliVersion: string },
|
|
io: KtxKnowledgeIo,
|
|
): Promise<KtxEmbeddingPort | null> {
|
|
if ('embeddingService' in deps) {
|
|
return deps.embeddingService ?? null;
|
|
}
|
|
const resolution = await (deps.resolveEmbeddingProvider ?? resolveProjectEmbeddingProvider)(project, {
|
|
mode: 'use-if-running',
|
|
cliVersion: args.cliVersion,
|
|
io,
|
|
});
|
|
return resolutionToEmbeddingPort(resolution);
|
|
}
|
|
|
|
function writeWikiSearchDebug(
|
|
io: KtxKnowledgeIo,
|
|
input: {
|
|
mode: string;
|
|
embeddingConfigured: boolean;
|
|
results: LocalKnowledgeSearchResult[];
|
|
},
|
|
): void {
|
|
io.stderr.write(
|
|
`[debug] wiki search mode=${input.mode} embedding=${input.embeddingConfigured ? 'configured' : 'unconfigured'} results=${input.results.length}\n`,
|
|
);
|
|
const lanes = input.results[0]?.lanes ?? [];
|
|
for (const lane of lanes) {
|
|
const reason = lane.reason ? ` reason=${lane.reason}` : '';
|
|
io.stderr.write(
|
|
`[debug] wiki search lane=${lane.lane} status=${lane.status} returned=${lane.returnedCandidateCount} weight=${lane.weight}${reason}\n`,
|
|
);
|
|
}
|
|
}
|
|
|
|
export async function runKtxKnowledge(
|
|
args: KtxKnowledgeArgs,
|
|
io: KtxKnowledgeIo = process,
|
|
deps: KtxKnowledgeDeps = {},
|
|
): Promise<number> {
|
|
const startedAt = performance.now();
|
|
try {
|
|
const project = await loadKtxProject({ projectDir: args.projectDir });
|
|
if (args.command === 'list') {
|
|
const pages = await listLocalKnowledgePages(project, { userId: args.userId });
|
|
const mode = resolveOutputMode({ explicit: args.output, json: args.json, io });
|
|
printList<LocalKnowledgeSummary>({
|
|
rows: pages,
|
|
columns: WIKI_LIST_COLUMNS,
|
|
groupBy: 'scope',
|
|
emptyMessage: `No local wiki pages found in ${project.projectDir}`,
|
|
emptyHint: 'Add Markdown files under wiki/ or run `ktx ingest <connectionId>`.',
|
|
unit: 'page',
|
|
command: 'wiki list',
|
|
mode,
|
|
io,
|
|
});
|
|
return 0;
|
|
}
|
|
if (args.command === 'search') {
|
|
const embeddingService = await wikiSearchEmbeddingService(project, deps, { cliVersion: args.cliVersion }, io);
|
|
const search = deps.searchLocalKnowledgePages ?? defaultSearchLocalKnowledgePages;
|
|
const results = await search(project, {
|
|
query: args.query,
|
|
userId: args.userId,
|
|
embeddingService,
|
|
limit: args.limit,
|
|
});
|
|
await emitTelemetryEvent({
|
|
name: 'wiki_query_completed',
|
|
projectDir: args.projectDir,
|
|
io,
|
|
fields: {
|
|
queryLength: args.query.length,
|
|
resultCount: results.length,
|
|
durationMs: Math.max(0, performance.now() - startedAt),
|
|
outcome: 'ok',
|
|
},
|
|
});
|
|
if (args.debug) {
|
|
writeWikiSearchDebug(io, {
|
|
mode: project.config.storage.search,
|
|
embeddingConfigured: embeddingService !== null,
|
|
results,
|
|
});
|
|
}
|
|
const mode = resolveOutputMode({ explicit: args.output, json: args.json, io });
|
|
let emptyMessage = `No local wiki pages matched "${args.query}"`;
|
|
let emptyHint = 'Run `ktx wiki` to inspect available pages.';
|
|
if (results.length === 0 && mode !== 'json') {
|
|
const pages = await listLocalKnowledgePages(project, { userId: args.userId });
|
|
if (pages.length === 0) {
|
|
emptyMessage = `No local wiki pages found in ${project.projectDir}`;
|
|
emptyHint = 'Add Markdown files under wiki/ or run `ktx ingest <connectionId>`.';
|
|
}
|
|
}
|
|
printList<LocalKnowledgeSearchResult>({
|
|
rows: results,
|
|
columns: wikiSearchColumns(results),
|
|
groupBy: 'scope',
|
|
emptyMessage,
|
|
emptyHint,
|
|
unit: 'page',
|
|
command: 'wiki search',
|
|
mode,
|
|
io,
|
|
});
|
|
return 0;
|
|
}
|
|
return 0;
|
|
} catch (error) {
|
|
if (args.command === 'search') {
|
|
await emitTelemetryEvent({
|
|
name: 'wiki_query_completed',
|
|
projectDir: args.projectDir,
|
|
io,
|
|
fields: {
|
|
queryLength: args.query.length,
|
|
resultCount: 0,
|
|
durationMs: Math.max(0, performance.now() - startedAt),
|
|
outcome: 'error',
|
|
},
|
|
});
|
|
}
|
|
io.stderr.write(`${error instanceof Error ? error.message : String(error)}\n`);
|
|
return 1;
|
|
}
|
|
}
|