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