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