[{"data":1,"prerenderedAt":1272},["ShallowReactive",2],{"navigation_docs":3,"-use-cases-telemetry-overview":510,"-use-cases-telemetry-overview-surround":1267},[4,30,80,123,293,425,480],{"title":5,"path":6,"stem":7,"children":8,"page":29},"Start","\u002Fstart","1.start",[9,14,19,24],{"title":10,"path":11,"stem":12,"icon":13},"Introduction","\u002Fstart\u002Fintroduction","1.start\u002F1.introduction","i-lucide-info",{"title":15,"path":16,"stem":17,"icon":18},"Why start with evlog","\u002Fstart\u002Fwhy-evlog","1.start\u002F2.why-evlog","i-lucide-rocket",{"title":20,"path":21,"stem":22,"icon":23},"Installation","\u002Fstart\u002Finstallation","1.start\u002F3.installation","i-lucide-download",{"title":25,"path":26,"stem":27,"icon":28},"Quick Start","\u002Fstart\u002Fquick-start","1.start\u002F4.quick-start","i-lucide-zap",false,{"title":31,"path":32,"stem":33,"children":34,"page":29},"Learn","\u002Flearn","2.learn",[35,40,45,50,55,60,65,70,75],{"title":36,"path":37,"stem":38,"icon":39},"Overview","\u002Flearn\u002Foverview","2.learn\u002F0.overview","i-lucide-list",{"title":41,"path":42,"stem":43,"icon":44},"Simple Logging","\u002Flearn\u002Fsimple-logging","2.learn\u002F1.simple-logging","i-lucide-terminal",{"title":46,"path":47,"stem":48,"icon":49},"Wide Events","\u002Flearn\u002Fwide-events","2.learn\u002F2.wide-events","i-lucide-layers",{"title":51,"path":52,"stem":53,"icon":54},"Structured Errors","\u002Flearn\u002Fstructured-errors","2.learn\u002F3.structured-errors","i-lucide-shield-alert",{"title":56,"path":57,"stem":58,"icon":59},"Lifecycle","\u002Flearn\u002Flifecycle","2.learn\u002F4.lifecycle","i-lucide-arrow-right-left",{"title":61,"path":62,"stem":63,"icon":64},"Sampling","\u002Flearn\u002Fsampling","2.learn\u002F5.sampling","i-lucide-filter",{"title":66,"path":67,"stem":68,"icon":69},"Auto-Redaction","\u002Flearn\u002Fredaction","2.learn\u002F6.redaction","i-lucide-eye-off",{"title":71,"path":72,"stem":73,"icon":74},"Typed Fields","\u002Flearn\u002Ftyped-fields","2.learn\u002F7.typed-fields","i-simple-icons-typescript",{"title":76,"path":77,"stem":78,"icon":79},"Catalogs","\u002Flearn\u002Fcatalogs","2.learn\u002F8.catalogs","i-lucide-book-open",{"title":81,"path":82,"stem":83,"children":84,"page":29},"CLI","\u002Fcli","3.cli",[85,88,93,98,103,108,113,118],{"title":36,"path":86,"stem":87,"icon":44},"\u002Fcli\u002Foverview","3.cli\u002F0.overview",{"title":89,"path":90,"stem":91,"icon":92},"init","\u002Fcli\u002Finit","3.cli\u002F1.init","i-lucide-wand-sparkles",{"title":94,"path":95,"stem":96,"icon":97},"map","\u002Fcli\u002Fmap","3.cli\u002F2.map","i-lucide-radar",{"title":99,"path":100,"stem":101,"icon":102},"Rules","\u002Fcli\u002Frules","3.cli\u002F3.rules","i-lucide-list-checks",{"title":104,"path":105,"stem":106,"icon":107},"Scoring","\u002Fcli\u002Fscoring","3.cli\u002F4.scoring","i-lucide-gauge",{"title":109,"path":110,"stem":111,"icon":112},"CI","\u002Fcli\u002Fci","3.cli\u002F5.ci","i-lucide-git-pull-request",{"title":114,"path":115,"stem":116,"icon":117},"doctor","\u002Fcli\u002Fdoctor","3.cli\u002F6.doctor","i-lucide-stethoscope",{"title":119,"path":120,"stem":121,"icon":122},"telemetry","\u002Fcli\u002Ftelemetry","3.cli\u002F7.telemetry","i-lucide-bar-chart-3",{"title":124,"path":125,"stem":126,"children":127,"page":29},"Integrate","\u002Fintegrate","4.integrate",[128,132,205],{"title":36,"path":129,"stem":130,"icon":131},"\u002Fintegrate\u002Foverview","4.integrate\u002F0.overview","i-lucide-plug",{"title":133,"path":134,"stem":135,"children":136,"page":29},"Adapters","\u002Fintegrate\u002Fadapters","4.integrate\u002Fadapters",[137,140,180],{"title":36,"path":138,"stem":139,"icon":39},"\u002Fintegrate\u002Fadapters\u002Foverview","4.integrate\u002Fadapters\u002F01.overview",{"title":141,"path":142,"stem":143,"children":144,"page":29},"Cloud","\u002Fintegrate\u002Fadapters\u002Fcloud","4.integrate\u002Fadapters\u002Fcloud",[145,150,155,160,165,170,175],{"title":146,"path":147,"stem":148,"icon":149},"Axiom","\u002Fintegrate\u002Fadapters\u002Fcloud\u002Faxiom","4.integrate\u002Fadapters\u002Fcloud\u002F01.axiom","i-custom-axiom",{"title":151,"path":152,"stem":153,"icon":154},"OTLP","\u002Fintegrate\u002Fadapters\u002Fcloud\u002Fotlp","4.integrate\u002Fadapters\u002Fcloud\u002F02.otlp","i-simple-icons-opentelemetry",{"title":156,"path":157,"stem":158,"icon":159},"PostHog","\u002Fintegrate\u002Fadapters\u002Fcloud\u002Fposthog","4.integrate\u002Fadapters\u002Fcloud\u002F03.posthog","i-simple-icons-posthog",{"title":161,"path":162,"stem":163,"icon":164},"Sentry","\u002Fintegrate\u002Fadapters\u002Fcloud\u002Fsentry","4.integrate\u002Fadapters\u002Fcloud\u002F04.sentry","i-simple-icons-sentry",{"title":166,"path":167,"stem":168,"icon":169},"Better Stack","\u002Fintegrate\u002Fadapters\u002Fcloud\u002Fbetter-stack","4.integrate\u002Fadapters\u002Fcloud\u002F05.better-stack","i-simple-icons-betterstack",{"title":171,"path":172,"stem":173,"icon":174},"Datadog","\u002Fintegrate\u002Fadapters\u002Fcloud\u002Fdatadog","4.integrate\u002Fadapters\u002Fcloud\u002F06.datadog","i-simple-icons-datadog",{"title":176,"path":177,"stem":178,"icon":179},"HyperDX","\u002Fintegrate\u002Fadapters\u002Fcloud\u002Fhyperdx","4.integrate\u002Fadapters\u002Fcloud\u002F07.hyperdx","i-custom-hyperdx",{"title":181,"path":182,"stem":183,"children":184,"page":29},"Self-Hosted","\u002Fintegrate\u002Fadapters\u002Fself-hosted","4.integrate\u002Fadapters\u002Fself-hosted",[185,190,195,200],{"title":186,"path":187,"stem":188,"icon":189},"File System","\u002Fintegrate\u002Fadapters\u002Fself-hosted\u002Ffs","4.integrate\u002Fadapters\u002Fself-hosted\u002F01.fs","i-lucide-hard-drive",{"title":191,"path":192,"stem":193,"icon":194},"NuxtHub","\u002Fintegrate\u002Fadapters\u002Fself-hosted\u002Fnuxthub","4.integrate\u002Fadapters\u002Fself-hosted\u002F02.nuxthub","i-simple-icons-nuxt",{"title":196,"path":197,"stem":198,"icon":199},"Memory","\u002Fintegrate\u002Fadapters\u002Fself-hosted\u002Fmemory","4.integrate\u002Fadapters\u002Fself-hosted\u002F03.memory","i-lucide-cpu",{"title":201,"path":202,"stem":203,"icon":204},"Grafana Loki","\u002Fintegrate\u002Fadapters\u002Fself-hosted\u002Floki","4.integrate\u002Fadapters\u002Fself-hosted\u002F04.loki","i-simple-icons-grafana",{"title":206,"path":207,"stem":208,"children":209,"page":29},"Frameworks","\u002Fintegrate\u002Fframeworks","4.integrate\u002Fframeworks",[210,214,219,224,229,234,239,244,249,254,259,264,269,274,278,283,288],{"title":36,"path":211,"stem":212,"icon":213},"\u002Fintegrate\u002Fframeworks\u002Foverview","4.integrate\u002Fframeworks\u002F00.overview","i-lucide-layout-grid",{"title":215,"path":216,"stem":217,"icon":218},"Nuxt","\u002Fintegrate\u002Fframeworks\u002Fnuxt","4.integrate\u002Fframeworks\u002F01.nuxt","i-simple-icons-nuxtdotjs",{"title":220,"path":221,"stem":222,"icon":223},"Next.js","\u002Fintegrate\u002Fframeworks\u002Fnextjs","4.integrate\u002Fframeworks\u002F02.nextjs","i-simple-icons-nextdotjs",{"title":225,"path":226,"stem":227,"icon":228},"SvelteKit","\u002Fintegrate\u002Fframeworks\u002Fsveltekit","4.integrate\u002Fframeworks\u002F03.sveltekit","i-simple-icons-svelte",{"title":230,"path":231,"stem":232,"icon":233},"Nitro","\u002Fintegrate\u002Fframeworks\u002Fnitro","4.integrate\u002Fframeworks\u002F04.nitro","i-custom-nitro",{"title":235,"path":236,"stem":237,"icon":238},"TanStack Start","\u002Fintegrate\u002Fframeworks\u002Ftanstack-start","4.integrate\u002Fframeworks\u002F05.tanstack-start","i-custom-tanstack",{"title":240,"path":241,"stem":242,"icon":243},"NestJS","\u002Fintegrate\u002Fframeworks\u002Fnestjs","4.integrate\u002Fframeworks\u002F06.nestjs","i-simple-icons-nestjs",{"title":245,"path":246,"stem":247,"icon":248},"Express","\u002Fintegrate\u002Fframeworks\u002Fexpress","4.integrate\u002Fframeworks\u002F07.express","i-simple-icons-express",{"title":250,"path":251,"stem":252,"icon":253},"Hono","\u002Fintegrate\u002Fframeworks\u002Fhono","4.integrate\u002Fframeworks\u002F08.hono","i-simple-icons-hono",{"title":255,"path":256,"stem":257,"icon":258},"Fastify","\u002Fintegrate\u002Fframeworks\u002Ffastify","4.integrate\u002Fframeworks\u002F09.fastify","i-simple-icons-fastify",{"title":260,"path":261,"stem":262,"icon":263},"Elysia","\u002Fintegrate\u002Fframeworks\u002Felysia","4.integrate\u002Fframeworks\u002F10.elysia","i-custom-elysia",{"title":265,"path":266,"stem":267,"icon":268},"React Router","\u002Fintegrate\u002Fframeworks\u002Freact-router","4.integrate\u002Fframeworks\u002F11.react-router","i-custom-reactrouter",{"title":270,"path":271,"stem":272,"icon":273},"Cloudflare Workers","\u002Fintegrate\u002Fframeworks\u002Fcloudflare-workers","4.integrate\u002Fframeworks\u002F12.cloudflare-workers","i-simple-icons-cloudflare",{"title":275,"path":276,"stem":277,"icon":74},"Standalone","\u002Fintegrate\u002Fframeworks\u002Fstandalone","4.integrate\u002Fframeworks\u002F13.standalone",{"title":279,"path":280,"stem":281,"icon":282},"Astro","\u002Fintegrate\u002Fframeworks\u002Fastro","4.integrate\u002Fframeworks\u002F14.astro","i-simple-icons-astro",{"title":284,"path":285,"stem":286,"icon":287},"oRPC","\u002Fintegrate\u002Fframeworks\u002Forpc","4.integrate\u002Fframeworks\u002F15.orpc","i-lucide-network",{"title":289,"path":290,"stem":291,"icon":292},"AWS Lambda","\u002Fintegrate\u002Fframeworks\u002Faws-lambda","4.integrate\u002Fframeworks\u002F16.aws-lambda","i-custom-lambda",{"title":294,"path":295,"stem":296,"children":297,"page":29},"Use Cases","\u002Fuse-cases","5.use-cases",[298,301,306,335,362,394,415,420],{"title":36,"path":299,"stem":300,"icon":102},"\u002Fuse-cases\u002Foverview","5.use-cases\u002F0.overview",{"title":302,"path":303,"stem":304,"icon":305},"Client Logging","\u002Fuse-cases\u002Fclient-logging","5.use-cases\u002F1.client-logging","i-lucide-monitor",{"title":307,"icon":308,"path":309,"stem":310,"children":311,"page":29},"AI SDK","i-simple-icons-vercel","\u002Fuse-cases\u002Fai-sdk","5.use-cases\u002F2.ai-sdk",[312,315,320,325,330],{"title":36,"path":313,"stem":314,"icon":39},"\u002Fuse-cases\u002Fai-sdk\u002Foverview","5.use-cases\u002F2.ai-sdk\u002F01.overview",{"title":316,"path":317,"stem":318,"icon":319},"Usage","\u002Fuse-cases\u002Fai-sdk\u002Fusage","5.use-cases\u002F2.ai-sdk\u002F02.usage","i-lucide-code",{"title":321,"path":322,"stem":323,"icon":324},"Options","\u002Fuse-cases\u002Fai-sdk\u002Foptions","5.use-cases\u002F2.ai-sdk\u002F03.options","i-lucide-sliders",{"title":326,"path":327,"stem":328,"icon":329},"Metadata","\u002Fuse-cases\u002Fai-sdk\u002Fmetadata","5.use-cases\u002F2.ai-sdk\u002F04.metadata","i-lucide-database",{"title":331,"path":332,"stem":333,"icon":334},"Telemetry","\u002Fuse-cases\u002Fai-sdk\u002Ftelemetry","5.use-cases\u002F2.ai-sdk\u002F05.telemetry","i-lucide-activity",{"title":336,"icon":337,"path":338,"stem":339,"children":340,"page":29},"Better Auth","i-simple-icons-betterauth","\u002Fuse-cases\u002Fbetter-auth","5.use-cases\u002F3.better-auth",[341,344,349,354,358],{"title":36,"path":342,"stem":343,"icon":39},"\u002Fuse-cases\u002Fbetter-auth\u002Foverview","5.use-cases\u002F3.better-auth\u002F01.overview",{"title":345,"path":346,"stem":347,"icon":348},"Identify User","\u002Fuse-cases\u002Fbetter-auth\u002Fidentify-user","5.use-cases\u002F3.better-auth\u002F02.identify-user","i-lucide-user-check",{"title":350,"path":351,"stem":352,"icon":353},"Middleware","\u002Fuse-cases\u002Fbetter-auth\u002Fmiddleware","5.use-cases\u002F3.better-auth\u002F03.middleware","i-lucide-shield",{"title":355,"path":356,"stem":357,"icon":305},"Client Sync","\u002Fuse-cases\u002Fbetter-auth\u002Fclient-sync","5.use-cases\u002F3.better-auth\u002F04.client-sync",{"title":359,"path":360,"stem":361,"icon":107},"Performance","\u002Fuse-cases\u002Fbetter-auth\u002Fperformance","5.use-cases\u002F3.better-auth\u002F05.performance",{"title":363,"icon":364,"path":365,"stem":366,"children":367,"page":29},"Audit Logs","i-lucide-shield-check","\u002Fuse-cases\u002Faudit","5.use-cases\u002F4.audit",[368,371,376,381,386,390],{"title":36,"path":369,"stem":370,"icon":39},"\u002Fuse-cases\u002Faudit\u002Foverview","5.use-cases\u002F4.audit\u002F01.overview",{"title":372,"path":373,"stem":374,"icon":375},"Schema","\u002Fuse-cases\u002Faudit\u002Fschema","5.use-cases\u002F4.audit\u002F02.schema","i-lucide-file-text",{"title":377,"path":378,"stem":379,"icon":380},"Recording","\u002Fuse-cases\u002Faudit\u002Frecording","5.use-cases\u002F4.audit\u002F03.recording","i-lucide-pen-line",{"title":382,"path":383,"stem":384,"icon":385},"Drains","\u002Fuse-cases\u002Faudit\u002Fpipeline","5.use-cases\u002F4.audit\u002F04.pipeline","i-lucide-link",{"title":387,"path":388,"stem":389,"icon":364},"Compliance","\u002Fuse-cases\u002Faudit\u002Fcompliance","5.use-cases\u002F4.audit\u002F05.compliance",{"title":391,"path":392,"stem":393,"icon":79},"Recipes","\u002Fuse-cases\u002Faudit\u002Frecipes","5.use-cases\u002F4.audit\u002F06.recipes",{"title":331,"icon":107,"path":395,"stem":396,"children":397,"page":29},"\u002Fuse-cases\u002Ftelemetry","5.use-cases\u002F4.telemetry",[398,401,406,411],{"title":36,"path":399,"stem":400,"icon":39},"\u002Fuse-cases\u002Ftelemetry\u002Foverview","5.use-cases\u002F4.telemetry\u002F01.overview",{"title":402,"path":403,"stem":404,"icon":405},"Setup","\u002Fuse-cases\u002Ftelemetry\u002Fsetup","5.use-cases\u002F4.telemetry\u002F02.setup","i-lucide-wrench",{"title":407,"path":408,"stem":409,"icon":410},"Ingest","\u002Fuse-cases\u002Ftelemetry\u002Fingest","5.use-cases\u002F4.telemetry\u002F03.ingest","i-lucide-server",{"title":412,"path":413,"stem":414,"icon":79},"Reference","\u002Fuse-cases\u002Ftelemetry\u002Freference","5.use-cases\u002F4.telemetry\u002F04.reference",{"title":416,"path":417,"stem":418,"icon":419},"Enrichers","\u002Fuse-cases\u002Fenrichers","5.use-cases\u002F5.enrichers","i-lucide-sparkles",{"title":421,"path":422,"stem":423,"icon":424},"eve","\u002Fuse-cases\u002Feve","5.use-cases\u002F5.eve","i-custom-eve",{"title":426,"path":427,"stem":428,"children":429,"page":29},"Extend","\u002Fextend","6.extend",[430,434,439,444,449,453,457,461,465,470,475],{"title":36,"path":431,"stem":432,"icon":433},"\u002Fextend\u002Foverview","6.extend\u002F0.overview","i-lucide-blocks",{"title":435,"path":436,"stem":437,"icon":438},"Stream","\u002Fextend\u002Fstream","6.extend\u002F1.stream","i-lucide-radio-tower",{"title":440,"path":441,"stem":442,"icon":443},"Custom framework","\u002Fextend\u002Fcustom-framework","6.extend\u002F10.custom-framework","i-lucide-puzzle",{"title":445,"path":446,"stem":447,"icon":448},"FS reader","\u002Fextend\u002Ffs-reader","6.extend\u002F2.fs-reader","i-lucide-folder-search",{"title":391,"path":450,"stem":451,"icon":452},"\u002Fextend\u002Fconsumer-recipes","6.extend\u002F3.consumer-recipes","i-lucide-chef-hat",{"title":454,"path":455,"stem":456,"icon":433},"Plugins","\u002Fextend\u002Fplugins","6.extend\u002F4.plugins",{"title":458,"path":459,"stem":460,"icon":419},"Custom enrichers","\u002Fextend\u002Fcustom-enrichers","6.extend\u002F5.custom-enrichers",{"title":462,"path":463,"stem":464,"icon":64},"Tail sampling","\u002Fextend\u002Ftail-sampling","6.extend\u002F6.tail-sampling",{"title":466,"path":467,"stem":468,"icon":469},"Identity headers","\u002Fextend\u002Fidentity-headers","6.extend\u002F7.identity-headers","i-lucide-fingerprint",{"title":471,"path":472,"stem":473,"icon":474},"Custom drains","\u002Fextend\u002Fcustom-drains","6.extend\u002F8.custom-drains","i-lucide-share-2",{"title":476,"path":477,"stem":478,"icon":479},"Drain pipeline","\u002Fextend\u002Fdrain-pipeline","6.extend\u002F9.drain-pipeline","i-lucide-workflow",{"title":412,"path":481,"stem":482,"children":483,"page":29},"\u002Freference","7.reference",[484,489,492,497,501,506],{"title":485,"path":486,"stem":487,"icon":488},"Configuration","\u002Freference\u002Fconfiguration","7.reference\u002F1.configuration","i-lucide-settings",{"title":359,"path":490,"stem":491,"icon":107},"\u002Freference\u002Fperformance","7.reference\u002F2.performance",{"title":493,"path":494,"stem":495,"icon":496},"Vite Plugin","\u002Freference\u002Fvite-plugin","7.reference\u002F3.vite-plugin","i-custom-vite",{"title":498,"path":499,"stem":500,"icon":364},"Best Practices","\u002Freference\u002Fbest-practices","7.reference\u002F4.best-practices",{"title":502,"path":503,"stem":504,"icon":505},"vs Other Loggers","\u002Freference\u002Fvs-other-loggers","7.reference\u002F5.vs-other-loggers","i-lucide-scale",{"title":507,"path":508,"stem":509,"icon":419},"Agent Skills","\u002Freference\u002Fagent-skills","7.reference\u002F6.agent-skills",{"id":511,"title":119,"body":512,"description":1256,"extension":1257,"links":1258,"meta":1263,"navigation":1264,"path":399,"seo":1265,"stem":400,"__hash__":1266},"docs\u002F5.use-cases\u002F4.telemetry\u002F01.overview.md",{"type":513,"value":514,"toc":1244},"minimark",[515,536,607,618,779,784,799,870,878,881,885,888,893,975,979,1069,1076,1080,1125,1129,1132,1182,1185,1208,1212,1240],[516,517,518,522,523,530,531,535],"p",{},[519,520,521],"code",{},"@evlog\u002Ftelemetry"," brings ",[524,525,529],"a",{"href":526,"rel":527},"https:\u002F\u002Fevlog.dev",[528],"nofollow","evlog","'s wide-event model to tools that run on other people's machines — CLIs, GitHub Actions, dev scripts, and CI jobs. Same philosophy as HTTP logging: ",[532,533,534],"strong",{},"one command execution → one structured event",", not a stream of analytics calls.",[537,538,539,564,578,592],"code-group",{},[540,541,547],"pre",{"className":542,"code":543,"filename":544,"language":545,"meta":546,"style":546},"language-bash shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","pnpm add @evlog\u002Ftelemetry\n","pnpm","bash","",[519,548,549],{"__ignoreMap":546},[550,551,554,557,561],"span",{"class":552,"line":553},"line",1,[550,555,544],{"class":556},"sBMFI",[550,558,560],{"class":559},"sfazB"," add",[550,562,563],{"class":559}," @evlog\u002Ftelemetry\n",[540,565,568],{"className":542,"code":566,"filename":567,"language":545,"meta":546,"style":546},"bun add @evlog\u002Ftelemetry\n","bun",[519,569,570],{"__ignoreMap":546},[550,571,572,574,576],{"class":552,"line":553},[550,573,567],{"class":556},[550,575,560],{"class":559},[550,577,563],{"class":559},[540,579,582],{"className":542,"code":580,"filename":581,"language":545,"meta":546,"style":546},"yarn add @evlog\u002Ftelemetry\n","yarn",[519,583,584],{"__ignoreMap":546},[550,585,586,588,590],{"class":552,"line":553},[550,587,581],{"class":556},[550,589,560],{"class":559},[550,591,563],{"class":559},[540,593,596],{"className":542,"code":594,"filename":595,"language":545,"meta":546,"style":546},"npm install @evlog\u002Ftelemetry\n","npm",[519,597,598],{"__ignoreMap":546},[550,599,600,602,605],{"class":552,"line":553},[550,601,595],{"class":556},[550,603,604],{"class":559}," install",[550,606,563],{"class":559},[516,608,609,610,613,614,617],{},"You get command name, sanitized flags, duration, and outcome automatically. Call ",[519,611,612],{},"telemetry.set()"," only when you have extra counters — numbers and booleans by default. Raw ",[519,615,616],{},"argv"," is never read; disclosure is generated from your runtime config so it cannot drift from what you actually collect.",[619,620,623,626,772],"prompt",{":actions":621,"description":622,"icon":107},"[\"copy\",\"cursor\",\"claude\"]","Add anonymous telemetry to my CLI or script",[516,624,625],{},"Add privacy-respecting telemetry to my CLI, script, or GitHub Action with @evlog\u002Ftelemetry.",[627,628,629,645,652,666,676,694,704,717,723,734,745],"ul",{},[630,631,632,633,636,637,640,641,644],"li",{},"Detect my entrypoint: citty CLI (",[519,634,635],{},"withTelemetry","), standalone script (",[519,638,639],{},"createTelemetry","), or GitHub Actions (",[519,642,643],{},"createGitHubActionsTelemetry",")",[630,646,647,648,651],{},"Install: ",[519,649,650],{},"pnpm add @evlog\u002Ftelemetry"," (or npm\u002Fyarn\u002Fbun)",[630,653,654,655,658,659,662,663],{},"Citty: wrap the root command in ",[519,656,657],{},"withTelemetry()"," in ",[519,660,661],{},"src\u002Findex.ts"," and add ",[519,664,665],{},"defineTelemetryCommands({ name: TOOL })",[630,667,668,669,672,673],{},"Script \u002F migrator: ",[519,670,671],{},"createTelemetry({ name, version })"," and wrap each logical unit with ",[519,674,675],{},"t.run('command', fn)",[630,677,678,679,682,683,686,687,690,691],{},"GitHub Actions: ",[519,680,681],{},"createGitHubActionsTelemetry()"," — only ",[519,684,685],{},"GITHUB_ACTION"," \u002F ",[519,688,689],{},"GITHUB_EVENT_NAME"," are injected into ",[519,692,693],{},"custom",[630,695,696,697,686,700,703],{},"Declare ",[519,698,699],{},"collect.flags",[519,701,702],{},"collect.fields"," for any string values you need beyond presence-only capture",[630,705,706,707,709,710,712,713],{},"Put your product schema in ",[519,708,693],{}," via ",[519,711,612],{}," — see ",[524,714,716],{"href":715},"\u002Fuse-cases\u002Ftelemetry\u002Freference#extending-the-schema","Extending the schema",[630,718,719,720,722],{},"Call ",[519,721,612],{}," for business counters (numbers\u002Fbooleans) inside handlers or helpers on the same async stack",[630,724,725,726,729,730,733],{},"Run ",[519,727,728],{},"generateDisclosure()"," and commit ",[519,731,732],{},"TELEMETRY.md"," beside the tool",[630,735,736,737,740,741,744],{},"Bake an ingestion URL in ",[519,738,739],{},"endpoint"," (or ",[519,742,743],{},"EVLOG_TELEMETRY_ENDPOINT",") — the local outbox is a buffer, not the destination",[630,746,747,748,751,752,755,756,759,760,763,764,767,768,771],{},"Ship ",[519,749,750],{},"POST \u002Fapi\u002Ftelemetry\u002Fingest"," on my app: use ",[519,753,754],{},"parseIngestBody()"," from ",[519,757,758],{},"@evlog\u002Ftelemetry\u002Fingest"," with ",[519,761,762],{},"allowedTools"," + ",[519,765,766],{},"allowedCustomKeys",", dedupe on ",[519,769,770],{},"idempotencyKey",", return 204 on success",[516,773,774,775],{},"Docs: ",[524,776,777],{"href":777,"rel":778},"https:\u002F\u002Fwww.evlog.dev\u002Fuse-cases\u002Ftelemetry\u002Foverview",[528],[780,781,783],"h2",{"id":782},"from-cli-to-your-backend","From CLI to your backend",[516,785,786,787,790,791,794,795,798],{},"The disk outbox (",[519,788,789],{},"~\u002F.config\u002F{toolName}\u002Ftelemetry\u002Foutbox.ndjson",") is a ",[532,792,793],{},"reliability buffer",", not where telemetry lives long-term. Each run appends one event locally, then the HTTP drain POSTs the backlog to ",[532,796,797],{},"your"," ingestion endpoint. Short-lived CI jobs and offline machines drain on the next invocation.",[800,801,802,812,823,831,841,851,860],"ol",{},[630,803,804,807,808,811],{},[532,805,806],{},"Run"," — ",[519,809,810],{},"my-tool doctor"," executes on the user's machine",[630,813,814,807,817,819,820],{},[532,815,816],{},"Capture",[519,818,521],{}," sanitizes flags, checks consent, and records one ",[519,821,822],{},"RunEvent",[630,824,825,828,829],{},[532,826,827],{},"Buffer"," — the event appends to ",[519,830,789],{},[630,832,833,836,837,840],{},[532,834,835],{},"Send"," — on flush, POST ",[519,838,839],{},"{ events: RunEvent[] }"," to your ingest URL",[630,842,843,807,846,848,849,644],{},[532,844,845],{},"Validate",[519,847,754],{}," allowlists tools and custom keys (",[524,850,407],{"href":408},[630,852,853,856,857,859],{},[532,854,855],{},"Store"," — dedupe on ",[519,858,770],{},", then DB \u002F warehouse \u002F evlog drain",[630,861,862,865,866,869],{},[532,863,864],{},"Ack"," — on ",[519,867,868],{},"2xx",", delivered keys are removed from the outbox",[540,871,876],{"className":872,"code":874,"language":875,"meta":546},[873],"language-text","CLI → @evlog\u002Ftelemetry → outbox.ndjson → POST \u002Fingest → validate → store\n","text",[519,877,874],{"__ignoreMap":546},[516,879,880],{},"Nothing is sent until you configure an endpoint and the server returns a success status. Until then, events stay in the outbox (or are purged on opt-out).",[780,882,884],{"id":883},"why-install-it","Why install it",[516,886,887],{},"You can wire anonymous usage telemetry yourself — outbox file, consent flags, flag sanitization, disclosure markdown, ingest validation, first-run notice. Or you add one dependency and get the evlog playbook baked in.",[889,890,892],"h3",{"id":891},"what-you-get-for-28-kb","What you get for ~28 KB",[894,895,896,907],"table",{},[897,898,899],"thead",{},[900,901,902,905],"tr",{},[903,904],"th",{},[903,906],{},[908,909,910,927,942,962],"tbody",{},[900,911,912,918],{},[913,914,915],"td",{},[532,916,917],{},"Published size",[913,919,920,921,923,924,926],{},"~28 KB ESM (",[519,922,521],{},"), ~8.6 KB gzip — standalone, no dependency on ",[519,925,529],{}," core",[900,928,929,934],{},[913,930,931],{},[532,932,933],{},"Server ingest only",[913,935,936,938,939,941],{},[519,937,758],{}," ~5 KB (~1.7 KB gzip) — ",[519,940,754],{}," without pulling citty wiring into your API",[900,943,944,949],{},[913,945,946],{},[532,947,948],{},"Runtime deps",[913,950,951,763,954,957,958,961],{},[519,952,953],{},"citty",[519,955,956],{},"std-env"," only — both ",[519,959,960],{},"sideEffects: false",", tree-shakeable ESM",[900,963,964,969],{},[913,965,966],{},[532,967,968],{},"Node",[913,970,971,972,974],{},"18+ · ESM · ",[519,973,960],{}," on the package",[889,976,978],{"id":977},"fits-wherever-your-code-runs","Fits wherever your code runs",[894,980,981,994],{},[897,982,983],{},[900,984,985,988,991],{},[903,986,987],{},"Surface",[903,989,990],{},"Entry",[903,992,993],{},"Lines of integration",[908,995,996,1014,1032,1053],{},[900,997,998,1003,1008],{},[913,999,1000],{},[532,1001,1002],{},"citty CLI",[913,1004,1005,1007],{},[519,1006,657],{}," on the root command",[913,1009,1010,1011],{},"One wrapper + optional ",[519,1012,1013],{},"defineTelemetryCommands()",[900,1015,1016,1021,1029],{},[913,1017,1018],{},[532,1019,1020],{},"Script \u002F migrator",[913,1022,1023,763,1026],{},[519,1024,1025],{},"createTelemetry()",[519,1027,1028],{},"t.run()",[913,1030,1031],{},"Wrap each logical run",[900,1033,1034,1039,1043],{},[913,1035,1036],{},[532,1037,1038],{},"GitHub Actions",[913,1040,1041],{},[519,1042,681],{},[913,1044,1045,1046,686,1049,1052],{},"Same as script; ",[519,1047,1048],{},"ghaAction",[519,1050,1051],{},"ghaEvent"," auto-injected",[900,1054,1055,1060,1066],{},[913,1056,1057],{},[532,1058,1059],{},"Your API (ingest)",[913,1061,1062,755,1064],{},[519,1063,754],{},[519,1065,758],{},[913,1067,1068],{},"One validator + one POST route",[516,1070,1071,1072,1075],{},"No framework lock-in. No PostHog \u002F Segment \u002F custom analytics SDK. No second schema to maintain — disclosure is generated from the same ",[519,1073,1074],{},"collect"," config the CLI uses at runtime.",[889,1077,1079],{"id":1078},"what-you-skip-building","What you skip building",[627,1081,1082,1087,1096,1099,1107,1110,1116,1119],{},[630,1083,1084,1085,644],{},"Privacy-safe flag capture (never reads raw ",[519,1086,616],{},[630,1088,1089,686,1092,1095],{},[519,1090,1091],{},"DO_NOT_TRACK",[519,1093,1094],{},"EVLOG_TELEMETRY"," \u002F persisted opt-out with outbox purge",[630,1097,1098],{},"Disk outbox with lockfile, stale-lock recovery, and backlog drain",[630,1100,1101,1102,763,1104,644],{},"Auto-generated disclosure (",[519,1103,732],{},[519,1105,1106],{},"telemetry status",[630,1108,1109],{},"First-run notice with opt-out instructions",[630,1111,1112,1113,1115],{},"Typed ",[519,1114,612],{}," with allowlisted string fields",[630,1117,1118],{},"Server-side ingest validation aligned with the CLI envelope",[630,1120,1121,1122],{},"Hard guarantee: ",[532,1123,1124],{},"telemetry never throws, never blocks exit",[889,1126,1128],{"id":1127},"the-payoff","The payoff",[516,1130,1131],{},"Once ingest is live you can answer product questions that CLI authors usually guess at:",[627,1133,1134,1145,1156,1163,1170],{},[630,1135,1136,1137,1139,1140,1139,1143,644],{},"Which commands are actually used (",[519,1138,114],{}," vs ",[519,1141,1142],{},"sync",[519,1144,1106],{},[630,1146,1147,1148,1151,1152,1155],{},"Where runs fail (",[519,1149,1150],{},"outcome",", ",[519,1153,1154],{},"errorCode",", version breakdown)",[630,1157,1158,1159,1162],{},"How long operations take (",[519,1160,1161],{},"durationMs"," per command)",[630,1164,1165,1166,1169],{},"Which versions are still in the wild (",[519,1167,1168],{},"tool.version"," on every event)",[630,1171,1172,1173,1151,1176,1151,1179,644],{},"Whether CI or local dev dominates (",[519,1174,1175],{},"env.ci",[519,1177,1178],{},"env.agent",[519,1180,1181],{},"env.tty",[516,1183,1184],{},"All from one wide event per run — the same mental model as evlog on the server, without bolting a browser analytics stack onto a terminal tool.",[1186,1187,1190,1191,807,1198,1151,1201,1204,1205,1207],"callout",{"color":1188,"icon":1189},"neutral","i-lucide-package","Try it locally: ",[524,1192,1195],{"href":1193,"rel":1194},"https:\u002F\u002Fgithub.com\u002FHugoRCD\u002Fevlog\u002Ftree\u002Fmain\u002Fexamples\u002Ftelemetry-playground",[528],[519,1196,1197],{},"examples\u002Ftelemetry-playground",[519,1199,1200],{},"pnpm run cli -- doctor",[519,1202,1203],{},"EVLOG_TELEMETRY_DEBUG=1"," to inspect payloads, ",[519,1206,1106],{}," for disclosure.",[780,1209,1211],{"id":1210},"see-also","See also",[627,1213,1214,1219,1224,1229,1235],{},[630,1215,1216,1218],{},[524,1217,402],{"href":403}," — citty, scripts, GitHub Actions, delivery config",[630,1220,1221,1223],{},[524,1222,407],{"href":408}," — server endpoint, validation, storage",[630,1225,1226,1228],{},[524,1227,412],{"href":413}," — envelope, schema extensions, disclosure, consent",[630,1230,1231,1234],{},[524,1232,1233],{"href":369},"Audit"," — wide events for security-sensitive actions",[630,1236,1237,1239],{},[524,1238,476],{"href":477}," — forward ingested events into Axiom, Datadog, OTLP, or a custom store",[1241,1242,1243],"style",{},"html pre.shiki code .sBMFI, html code.shiki .sBMFI{--shiki-light:#E2931D;--shiki-default:#FFCB6B;--shiki-dark:#FFCB6B}html pre.shiki code .sfazB, html code.shiki .sfazB{--shiki-light:#91B859;--shiki-default:#C3E88D;--shiki-dark:#C3E88D}html .light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html.light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}",{"title":546,"searchDepth":1245,"depth":1245,"links":1246},2,[1247,1248,1255],{"id":782,"depth":1245,"text":783},{"id":883,"depth":1245,"text":884,"children":1249},[1250,1252,1253,1254],{"id":891,"depth":1251,"text":892},3,{"id":977,"depth":1251,"text":978},{"id":1078,"depth":1251,"text":1079},{"id":1127,"depth":1251,"text":1128},{"id":1210,"depth":1245,"text":1211},"Wide-event telemetry for CLIs and automation — evlog's one-event-per-run model for tools on user machines, with privacy-safe flags, consent, outbox, and auto-generated disclosure.","md",[1259,1261,1262],{"label":402,"icon":405,"to":403,"color":1188,"variant":1260},"subtle",{"label":407,"icon":410,"to":408,"color":1188,"variant":1260},{"label":412,"icon":79,"to":413,"color":1188,"variant":1260},{},{"title":36,"icon":39},{"title":119,"description":1256},"9jh5Kgt4J5jpYeo833BTabRU5EVVS8x7g-W_bp24kEA",[1268,1270],{"title":391,"path":392,"stem":393,"description":1269,"icon":79,"children":-1},"File system, Axiom, and Postgres recipes for audit logs, plus mockAudit for tests and the full API reference.",{"title":402,"path":403,"stem":404,"description":1271,"icon":405,"children":-1},"Wire @evlog\u002Ftelemetry into citty CLIs, standalone scripts, and GitHub Actions — delivery config, automatic flag capture, telemetry.set(), and debug mode.",1785609193970]