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