Files
SnapOtter/scripts/bake-analytics.mjs
SnapOtterandGitHub e1b8c24e5d feat(analytics): instance census, full capture, richer error context (#511)
Add a once-per-boot instance_started event (arch, os, deploy_mode,
gpu_present) so the fleet architecture mix is measurable. It reuses the
existing per-instance instance_id and is exempt from the volume sample
rate, since a census that fires once per boot must not be thinned.

Restore useful capture depth now that the sponsored plan removes the
quota pressure behind the earlier hardening:

- PostHog sample rate 0.1 to 1.0 (full analytics when enabled); the
  property allowlist still blocks file data.
- Sentry per-instance ceiling 20 to 500/hr, breadcrumb trail restored
  (sanitized: urls/paths redacted, data payloads dropped), full stack
  paths kept; local vars, request bodies, and PII still dropped. Both
  api and web.

Honor ANALYTICS_ENABLED=false as an opt-out alias: it was documented on
the Docker Hub README but never wired in 2.x, so anyone who set it was
still tracked.

All capture stays behind the analytics opt-out gate.
2026-07-13 14:23:16 +08:00

45 lines
2.1 KiB
JavaScript

import { writeFileSync } from "node:fs";
import { dirname, resolve } from "node:path";
import { fileURLToPath } from "node:url";
const __dirname = dirname(fileURLToPath(import.meta.url));
const outPath = resolve(__dirname, "../packages/shared/src/analytics/baked.ts");
const mode = process.argv[2] || "on";
const on = mode === "on";
// Real telemetry creds are injected at build time from the environment -- the
// official image's CI supplies them from secrets, so they are NOT committed and
// a build from source stays silent. A Sentry DSN and a PostHog project key are
// public (they ship in the browser bundle), so this is about not making forks /
// source builds phone home by default, not about secrecy.
const posthogApiKey = on
? (process.env.SNAPOTTER_POSTHOG_PROJECT_ID ?? process.env.SNAPOTTER_POSTHOG_KEY ?? "")
: "";
const sentryDsn = on ? (process.env.SNAPOTTER_SENTRY_DSN ?? "") : "";
const sentryDsnWeb = on ? (process.env.SNAPOTTER_SENTRY_DSN_WEB ?? "") : "";
const posthogHost = posthogApiKey ? "https://us.i.posthog.com" : "";
// Enabled only when turned on AND there is somewhere to report to, so a
// credential-less source build never initializes the SDKs.
const enabled = on && (posthogApiKey !== "" || sentryDsn !== "" || sentryDsnWeb !== "");
// PostHog event sampling only. Sentry tracing was removed in 2.0.1; do not
// reintroduce a shared "sampleRate" that doubles as a traces rate.
// 1.0 = full analytics when enabled: the property allowlist (analytics-allowlist.ts)
// already blocks file data, and PostHog event volume is cheap under the sponsored
// plan. The old 0.1 was an inherited Sentry-tracing cost figure, not an event rate.
const posthogSampleRate = on ? 1.0 : 0;
const content = `// AUTO-GENERATED by scripts/bake-analytics.mjs -- do not edit manually
export const ANALYTICS_BAKED = {
enabled: ${enabled},
posthogApiKey: "${posthogApiKey}",
posthogHost: "${posthogHost}",
sentryDsn: "${sentryDsn}",
sentryDsnWeb: "${sentryDsnWeb}",
posthogSampleRate: ${posthogSampleRate},
} as const;
`;
writeFileSync(outPath, content, "utf-8");
console.log(`bake-analytics: wrote ${outPath} (mode=${mode}, enabled=${enabled})`);