Skip to content

feat(telemetry): add consolidated VITE flags and OTEL debug logs #46

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
BP602 merged 1 commit into from
Sep 23, 2025
Merged

feat(telemetry): add consolidated VITE flags and OTEL debug logs #46

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 40 additions & 5 deletions src/main/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,33 @@ try {
console.warn('[Telemetry]: Failed to set service.version from package/app version:', e?.message || e);
}

// Telemetry debug configuration for main process
const getTelemetryDebug = () => {
try {
// Check consolidated VITE_ vars first (available to all processes), then fall back to old vars
return import.meta.env.VITE_TELEMETRY_DEBUG === 'true' ||
import.meta.env.MAIN_VITE_TELEMETRY_DEBUG === 'true';
} catch {
return false;
}
};

const getTelemetryLevel = () => {
try {
// Check consolidated VITE_ vars first (available to all processes), then fall back to old vars
const level = import.meta.env.VITE_TELEMETRY_LEVEL ||
import.meta.env.MAIN_VITE_TELEMETRY_LEVEL ||
'NORMAL';
return level.toUpperCase();
} catch {
return 'NORMAL';
}
};

const shouldLogDebug = () => {
return getTelemetryDebug() || getTelemetryLevel() === 'VERBOSE';
};

// Load metrics with fallback
let metrics = null;
try {
Expand Down Expand Up @@ -686,8 +713,10 @@ ipcMain.handle("otel:trace-export-json", async (_e, exportJson) => {
const startedAt = Date.now();

try {
console.log(`[OTEL IPC Relay][${requestId}] Received trace export from renderer`);
console.log(`[OTEL IPC Relay][${requestId}] Payload size: ${JSON.stringify(exportJson || {}).length} chars`);
if (shouldLogDebug()) {
console.log(`[OTEL IPC Relay][${requestId}] Received trace export from renderer`);
console.log(`[OTEL IPC Relay][${requestId}] Payload size: ${JSON.stringify(exportJson || {}).length} chars`);
}

const base = import.meta.env.MAIN_VITE_OTEL_EXPORTER_OTLP_ENDPOINT || process.env.OTEL_EXPORTER_OTLP_ENDPOINT || "";
const endpoint = import.meta.env.MAIN_VITE_OTEL_EXPORTER_OTLP_TRACES_ENDPOINT ||
Expand Down Expand Up @@ -732,7 +761,9 @@ ipcMain.handle("otel:trace-export-json", async (_e, exportJson) => {
timeout: 15000,
};

console.log(`[OTEL IPC Relay][${requestId}] → POST ${url.hostname}${options.path}`);
if (shouldLogDebug()) {
console.log(`[OTEL IPC Relay][${requestId}] → POST ${url.hostname}${options.path}`);
}

const result = await new Promise((resolve, reject) => {
const req = https.request(options, (res) => {
Expand All @@ -742,7 +773,9 @@ ipcMain.handle("otel:trace-export-json", async (_e, exportJson) => {
const ms = Date.now() - startedAt;
const responseBody = Buffer.concat(chunks).toString("utf8");

console.log(`[OTEL IPC Relay][${requestId}] ← ${res.statusCode} (${ms}ms)`);
if (shouldLogDebug()) {
console.log(`[OTEL IPC Relay][${requestId}] ← ${res.statusCode} (${ms}ms)`);
}
resolve({ statusCode: res.statusCode || 0, responseBody });
});
});
Expand All @@ -762,7 +795,9 @@ ipcMain.handle("otel:trace-export-json", async (_e, exportJson) => {
});

const success = result.statusCode >= 200 && result.statusCode < 300;
console.log(`[OTEL IPC Relay][${requestId}] Result: ${success ? 'success' : 'failed'}`);
if (shouldLogDebug()) {
console.log(`[OTEL IPC Relay][${requestId}] Result: ${success ? 'success' : 'failed'}`);
}

return { ok: success, status: result.statusCode, requestId };
} catch (e) {
Expand Down
189 changes: 109 additions & 80 deletions src/renderer/src/telemetry/webTracing.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -198,13 +198,30 @@ if (!telemetryEnabled && typeof window !== 'undefined') {
// Telemetry Level Configuration and Sampling Utilities
const getTelemetryLevel = () => {
try {
const level = import.meta.env.RENDERER_VITE_TELEMETRY_LEVEL || 'NORMAL';
// Check consolidated VITE_ vars first (available to all processes), then fall back to old vars
const level = import.meta.env.VITE_TELEMETRY_LEVEL ||
import.meta.env.RENDERER_VITE_TELEMETRY_LEVEL ||
'NORMAL';
return level.toUpperCase();
} catch {
return 'NORMAL';
}
};

const getTelemetryDebug = () => {
try {
// Check consolidated VITE_ vars first (available to all processes), then fall back to old vars
return import.meta.env.VITE_TELEMETRY_DEBUG === 'true' ||
import.meta.env.RENDERER_VITE_TELEMETRY_DEBUG === 'true';
} catch {
return false;
}
};

const shouldLogDebug = () => {
return getTelemetryDebug() || getTelemetryLevel() === 'VERBOSE';
};

const TELEMETRY_LEVELS = {
MINIMAL: {
priority: 1,
Expand Down Expand Up @@ -291,6 +308,8 @@ const checkStartupPhase = () => {
// Export utilities for use in components
window.__KT_TELEMETRY_UTILS__ = {
getTelemetryLevel,
getTelemetryDebug,
shouldLogDebug,
shouldEmitTelemetry,
shouldSampleMessageParser,
shouldEmitLexicalUpdate,
Expand Down Expand Up @@ -654,45 +673,51 @@ if (!window.__KT_RENDERER_OTEL_INITIALIZED__ && telemetryEnabled) {
} catch {}
}

console.log(`[Renderer OTEL][${exportId}] IPCSpanExporter.export() called:`, {
exportId,
exportCount: this.exportCount,
spanCount: spanArray.length,
serviceName: this.serviceName,
deploymentEnv: this.deploymentEnv,
traceIds: traceInfo.traceIds,
spanIds: traceInfo.spanIds.slice(0, 3), // First 3 span IDs
spanNames: traceInfo.spanNames,
parentSpanIds: traceInfo.parentSpanIds.slice(0, 3)
});
if (shouldLogDebug()) {
console.log(`[Renderer OTEL][${exportId}] IPCSpanExporter.export() called:`, {
exportId,
exportCount: this.exportCount,
spanCount: spanArray.length,
serviceName: this.serviceName,
deploymentEnv: this.deploymentEnv,
traceIds: traceInfo.traceIds,
spanIds: traceInfo.spanIds.slice(0, 3), // First 3 span IDs
spanNames: traceInfo.spanNames,
parentSpanIds: traceInfo.parentSpanIds.slice(0, 3)
});
}

const req = this._toOtlpJson(spans);
const reqSize = JSON.stringify(req).length;

console.log(`[Renderer OTEL][${exportId}] Converted to OTLP JSON:`, {
exportId,
requestSize: reqSize,
resourceSpansCount: req.resourceSpans?.length || 0,
traceIds: traceInfo.traceIds,
actualTraceIds: traceInfo.traceIds,
traceIdLengths: traceInfo.traceIds.map(id => id?.length || 0)
});
if (shouldLogDebug()) {
console.log(`[Renderer OTEL][${exportId}] Converted to OTLP JSON:`, {
exportId,
requestSize: reqSize,
resourceSpansCount: req.resourceSpans?.length || 0,
traceIds: traceInfo.traceIds,
actualTraceIds: traceInfo.traceIds,
traceIdLengths: traceInfo.traceIds.map(id => id?.length || 0)
});
}

const res = await window.telemetry.exportTracesJson(req);
const duration = performance.now() - startTime;

const ok = !!res?.ok && (!res.status || (res.status >= 200 && res.status < 300));

console.log(`[Renderer OTEL][${exportId}] IPC export result:`, {
exportId,
success: ok,
duration: `${Math.round(duration)}ms`,
responseStatus: res?.status,
responseOk: res?.ok,
requestId: res?.requestId,
traceIds: traceInfo.traceIds,
returnedTraceIds: res?.traceIds
});
if (shouldLogDebug()) {
console.log(`[Renderer OTEL][${exportId}] IPC export result:`, {
exportId,
success: ok,
duration: `${Math.round(duration)}ms`,
responseStatus: res?.status,
responseOk: res?.ok,
requestId: res?.requestId,
traceIds: traceInfo.traceIds,
returnedTraceIds: res?.traceIds
});
}

resultCallback({ code: ok ? 0 : 1 });
} catch (e) {
Expand Down Expand Up @@ -883,50 +908,52 @@ if (!window.__KT_RENDERER_OTEL_INITIALIZED__ && telemetryEnabled) {
const directConversion = rawSec * 1000000000n + rawNs;
const directDate = new Date(Number(directConversion) / 1e6);

console.log(`[Renderer OTEL] Span validation debug:`, {
traceId,
traceIdHexLength: traceId.length,
spanId,
spanIdHexLength: spanId.length,
parentSpanId,
parentSpanIdHexLength: parentSpanId.length,
// For visibility when debugging, also show base64 versions
traceIdBase64: hexToBase64(traceIdHex),
spanIdBase64: hexToBase64(spanIdHex),
parentSpanIdBase64: parentSpanIdHex ? hexToBase64(parentSpanIdHex) : '',
startTimeUnixNano: startNs.toString(),
endTimeUnixNano: endNs.toString(),
startDate: startDate.toISOString(),
endDate: endDate.toISOString(),
startYear: startDate.getFullYear(),
endYear: endDate.getFullYear(),
isStartTimeReasonable: startDate.getFullYear() >= 2020 && startDate.getFullYear() <= 2030,
isEndTimeReasonable: endDate.getFullYear() >= 2020 && endDate.getFullYear() <= 2030,
duration: (endNs - startNs).toString() + ' nanos',
durationMs: Number(endNs - startNs) / 1e6,
kind: Number(s.kind) || 0,
name: s.name || 'span',
nowMs,
nowNs: nowNs.toString(),
timeDiffFromNow: Number(nowNs - startNs),
statusCode: s.status?.code,
statusMessage: s.status?.message,
statusWillBeIncluded: !!(s.status?.code && s.status.code > 0),
statusExists: !!s.status,
statusCodeType: typeof s.status?.code,
// Raw hrtime debugging
rawStartTime: s.startTime,
rawEndTime: s.endTime,
performanceTimeOrigin: performance?.timeOrigin,
performanceNow: performance?.now?.(),
// Step-by-step conversion debugging
rawSecBigInt: rawSec.toString(),
rawNsBigInt: rawNs.toString(),
directConversion: directConversion.toString(),
directDate: directDate.toISOString(),
directYear: directDate.getFullYear(),
directVsCalculated: directConversion.toString() === startNs.toString()
});
if (shouldLogDebug()) {
console.log(`[Renderer OTEL] Span validation debug:`, {
traceId,
traceIdHexLength: traceId.length,
spanId,
spanIdHexLength: spanId.length,
parentSpanId,
parentSpanIdHexLength: parentSpanId.length,
// For visibility when debugging, also show base64 versions
traceIdBase64: hexToBase64(traceIdHex),
spanIdBase64: hexToBase64(spanIdHex),
parentSpanIdBase64: parentSpanIdHex ? hexToBase64(parentSpanIdHex) : '',
startTimeUnixNano: startNs.toString(),
endTimeUnixNano: endNs.toString(),
startDate: startDate.toISOString(),
endDate: endDate.toISOString(),
startYear: startDate.getFullYear(),
endYear: endDate.getFullYear(),
isStartTimeReasonable: startDate.getFullYear() >= 2020 && startDate.getFullYear() <= 2030,
isEndTimeReasonable: endDate.getFullYear() >= 2020 && endDate.getFullYear() <= 2030,
duration: (endNs - startNs).toString() + ' nanos',
durationMs: Number(endNs - startNs) / 1e6,
kind: Number(s.kind) || 0,
name: s.name || 'span',
nowMs,
nowNs: nowNs.toString(),
timeDiffFromNow: Number(nowNs - startNs),
statusCode: s.status?.code,
statusMessage: s.status?.message,
statusWillBeIncluded: !!(s.status?.code && s.status.code > 0),
statusExists: !!s.status,
statusCodeType: typeof s.status?.code,
// Raw hrtime debugging
rawStartTime: s.startTime,
rawEndTime: s.endTime,
performanceTimeOrigin: performance?.timeOrigin,
performanceNow: performance?.now?.(),
// Step-by-step conversion debugging
rawSecBigInt: rawSec.toString(),
rawNsBigInt: rawNs.toString(),
directConversion: directConversion.toString(),
directDate: directDate.toISOString(),
directYear: directDate.getFullYear(),
directVsCalculated: directConversion.toString() === startNs.toString()
});
}

// Warn if timestamps are too far in the future (>5m) or in the past (>24h)
try {
Expand Down Expand Up @@ -969,12 +996,14 @@ if (!window.__KT_RENDERER_OTEL_INITIALIZED__ && telemetryEnabled) {
};
}

console.log(`[Renderer OTEL] Status filtering debug:`, {
originalStatusCode: statusCode,
originalStatusMessage: s.status?.message,
isError,
willAddStatus: isError
});
if (shouldLogDebug()) {
console.log(`[Renderer OTEL] Status filtering debug:`, {
originalStatusCode: statusCode,
originalStatusMessage: s.status?.message,
isError,
willAddStatus: isError
});
}

const spanName = (s.name || 'span');
const spanOut = {
Expand Down
Loading
Loading