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