[{"data":1,"prerenderedAt":1304},["ShallowReactive",2],{"navigation_docs":3,"-use-cases-telemetry-overview":538,"-use-cases-telemetry-overview-surround":1299},[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,507,512,515,520,524,529,533],{"title":36,"path":504,"stem":505,"icon":506},"\u002Freference\u002Foverview","7.reference\u002F0.overview","i-lucide-book-marked",{"title":508,"path":509,"stem":510,"icon":511},"Configuration","\u002Freference\u002Fconfiguration","7.reference\u002F1.configuration","i-lucide-settings",{"title":374,"path":513,"stem":514,"icon":107},"\u002Freference\u002Fperformance","7.reference\u002F2.performance",{"title":516,"path":517,"stem":518,"icon":519},"Vite Plugin","\u002Freference\u002Fvite-plugin","7.reference\u002F3.vite-plugin","i-custom-vite",{"title":521,"path":522,"stem":523,"icon":379},"Best Practices","\u002Freference\u002Fbest-practices","7.reference\u002F4.best-practices",{"title":525,"path":526,"stem":527,"icon":528},"vs Other Loggers","\u002Freference\u002Fvs-other-loggers","7.reference\u002F5.vs-other-loggers","i-lucide-scale",{"title":530,"path":531,"stem":532,"icon":434},"Agent Skills","\u002Freference\u002Fagent-skills","7.reference\u002F6.agent-skills",{"title":534,"path":535,"stem":536,"icon":537},"Cost","\u002Freference\u002Fcost","7.reference\u002F7.cost","i-lucide-receipt",{"id":539,"title":119,"body":540,"description":1288,"extension":1289,"links":1290,"meta":1295,"navigation":1296,"path":414,"seo":1297,"stem":415,"__hash__":1298},"docs\u002F5.use-cases\u002F4.telemetry\u002F01.overview.md",{"type":541,"value":542,"toc":1276},"minimark",[543,564,635,646,811,816,831,902,910,913,917,920,925,1007,1011,1101,1108,1112,1157,1161,1164,1214,1217,1240,1244,1272],[544,545,546,550,551,558,559,563],"p",{},[547,548,549],"code",{},"@evlog\u002Ftelemetry"," brings ",[552,553,557],"a",{"href":554,"rel":555},"https:\u002F\u002Fevlog.dev",[556],"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: ",[560,561,562],"strong",{},"one command execution → one structured event",", not a stream of analytics calls.",[565,566,567,592,606,620],"code-group",{},[568,569,575],"pre",{"className":570,"code":571,"filename":572,"language":573,"meta":574,"style":574},"language-bash shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","pnpm add @evlog\u002Ftelemetry\n","pnpm","bash","",[547,576,577],{"__ignoreMap":574},[578,579,582,585,589],"span",{"class":580,"line":581},"line",1,[578,583,572],{"class":584},"sBMFI",[578,586,588],{"class":587},"sfazB"," add",[578,590,591],{"class":587}," @evlog\u002Ftelemetry\n",[568,593,596],{"className":570,"code":594,"filename":595,"language":573,"meta":574,"style":574},"bun add @evlog\u002Ftelemetry\n","bun",[547,597,598],{"__ignoreMap":574},[578,599,600,602,604],{"class":580,"line":581},[578,601,595],{"class":584},[578,603,588],{"class":587},[578,605,591],{"class":587},[568,607,610],{"className":570,"code":608,"filename":609,"language":573,"meta":574,"style":574},"yarn add @evlog\u002Ftelemetry\n","yarn",[547,611,612],{"__ignoreMap":574},[578,613,614,616,618],{"class":580,"line":581},[578,615,609],{"class":584},[578,617,588],{"class":587},[578,619,591],{"class":587},[568,621,624],{"className":570,"code":622,"filename":623,"language":573,"meta":574,"style":574},"npm install @evlog\u002Ftelemetry\n","npm",[547,625,626],{"__ignoreMap":574},[578,627,628,630,633],{"class":580,"line":581},[578,629,623],{"class":584},[578,631,632],{"class":587}," install",[578,634,591],{"class":587},[544,636,637,638,641,642,645],{},"You get command name, sanitized flags, duration, and outcome automatically. Call ",[547,639,640],{},"telemetry.set()"," only when you have extra counters, numbers and booleans by default. Raw ",[547,643,644],{},"argv"," is never read; disclosure is generated from your runtime config so it cannot drift from what you actually collect.",[647,648,651,654,804],"prompt",{":actions":649,"description":650,"icon":107},"[\"copy\",\"cursor\",\"claude\"]","Add anonymous telemetry to my CLI or script",[544,652,653],{},"Add privacy-respecting telemetry to my CLI, script, or GitHub Action with @evlog\u002Ftelemetry.",[655,656,657,673,680,694,704,722,736,749,755,766,777],"ul",{},[658,659,660,661,664,665,668,669,672],"li",{},"Detect my entrypoint: citty CLI (",[547,662,663],{},"withTelemetry","), standalone script (",[547,666,667],{},"createTelemetry","), or GitHub Actions (",[547,670,671],{},"createGitHubActionsTelemetry",")",[658,674,675,676,679],{},"Install: ",[547,677,678],{},"pnpm add @evlog\u002Ftelemetry"," (or npm\u002Fyarn\u002Fbun)",[658,681,682,683,686,687,690,691],{},"Citty: wrap the root command in ",[547,684,685],{},"withTelemetry()"," in ",[547,688,689],{},"src\u002Findex.ts"," and add ",[547,692,693],{},"defineTelemetryCommands({ name: TOOL })",[658,695,696,697,700,701],{},"Script \u002F migrator: ",[547,698,699],{},"createTelemetry({ name, version })"," and wrap each logical unit with ",[547,702,703],{},"t.run('command', fn)",[658,705,706,707,710,711,714,715,718,719],{},"GitHub Actions: ",[547,708,709],{},"createGitHubActionsTelemetry()",". Only ",[547,712,713],{},"GITHUB_ACTION"," \u002F ",[547,716,717],{},"GITHUB_EVENT_NAME"," are injected into ",[547,720,721],{},"custom",[658,723,724,725,714,728,731,732,735],{},"Declare ",[547,726,727],{},"collect.flags",[547,729,730],{},"collect.fields"," for any string values you need beyond the ",[547,733,734],{},"\"\u003Cset>\""," marker",[658,737,738,739,741,742,744,745],{},"Put your product schema in ",[547,740,721],{}," via ",[547,743,640],{},", see ",[552,746,748],{"href":747},"\u002Fuse-cases\u002Ftelemetry\u002Freference#extending-the-schema","Extending the schema",[658,750,751,752,754],{},"Call ",[547,753,640],{}," for business counters (numbers\u002Fbooleans) inside handlers or helpers on the same async stack",[658,756,757,758,761,762,765],{},"Run ",[547,759,760],{},"generateDisclosure()"," and commit ",[547,763,764],{},"TELEMETRY.md"," beside the tool",[658,767,768,769,772,773,776],{},"Bake an ingestion URL in ",[547,770,771],{},"endpoint"," (or ",[547,774,775],{},"EVLOG_TELEMETRY_ENDPOINT","). The local outbox is a buffer, not the destination",[658,778,779,780,783,784,787,788,791,792,795,796,799,800,803],{},"Ship ",[547,781,782],{},"POST \u002Fapi\u002Ftelemetry\u002Fingest"," on my app: use ",[547,785,786],{},"parseIngestBody()"," from ",[547,789,790],{},"@evlog\u002Ftelemetry\u002Fingest"," with ",[547,793,794],{},"allowedTools"," + ",[547,797,798],{},"allowedCustomKeys",", dedupe on ",[547,801,802],{},"idempotencyKey",", return 204 on success",[544,805,806,807],{},"Docs: ",[552,808,809],{"href":809,"rel":810},"https:\u002F\u002Fwww.evlog.dev\u002Fuse-cases\u002Ftelemetry\u002Foverview",[556],[812,813,815],"h2",{"id":814},"from-cli-to-your-backend","From CLI to your backend",[544,817,818,819,822,823,826,827,830],{},"The disk outbox (",[547,820,821],{},"~\u002F.config\u002F{toolName}\u002Ftelemetry\u002Foutbox.ndjson",") is a ",[560,824,825],{},"reliability buffer",", not where telemetry lives long-term. Each run appends one event locally, then the HTTP drain POSTs the backlog to ",[560,828,829],{},"your"," ingestion endpoint. Short-lived CI jobs and offline machines drain on the next invocation.",[832,833,834,844,855,863,873,883,892],"ol",{},[658,835,836,839,840,843],{},[560,837,838],{},"Run",": ",[547,841,842],{},"my-tool doctor"," executes on the user's machine",[658,845,846,839,849,851,852],{},[560,847,848],{},"Capture",[547,850,549],{}," sanitizes flags, checks consent, and records one ",[547,853,854],{},"RunEvent",[658,856,857,860,861],{},[560,858,859],{},"Buffer",": the event appends to ",[547,862,821],{},[658,864,865,868,869,872],{},[560,866,867],{},"Send",": on flush, POST ",[547,870,871],{},"{ events: RunEvent[] }"," to your ingest URL",[658,874,875,839,878,880,881,672],{},[560,876,877],{},"Validate",[547,879,786],{}," allowlists tools and custom keys (",[552,882,422],{"href":423},[658,884,885,888,889,891],{},[560,886,887],{},"Store",": dedupe on ",[547,890,802],{},", then DB \u002F warehouse \u002F evlog drain",[658,893,894,897,898,901],{},[560,895,896],{},"Ack",": on ",[547,899,900],{},"2xx",", delivered keys are removed from the outbox",[568,903,908],{"className":904,"code":906,"language":907,"meta":574},[905],"language-text","CLI → @evlog\u002Ftelemetry → outbox.ndjson → POST \u002Fingest → validate → store\n","text",[547,909,906],{"__ignoreMap":574},[544,911,912],{},"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).",[812,914,916],{"id":915},"why-install-it","Why install it",[544,918,919],{},"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.",[921,922,924],"h3",{"id":923},"what-you-get-for-28-kb","What you get for ~28 KB",[926,927,928,939],"table",{},[929,930,931],"thead",{},[932,933,934,937],"tr",{},[935,936],"th",{},[935,938],{},[940,941,942,959,974,994],"tbody",{},[932,943,944,950],{},[945,946,947],"td",{},[560,948,949],{},"Published size",[945,951,952,953,955,956,958],{},"~28 KB ESM (",[547,954,549],{},"), ~8.6 KB gzip — standalone, no dependency on ",[547,957,557],{}," core",[932,960,961,966],{},[945,962,963],{},[560,964,965],{},"Server ingest only",[945,967,968,970,971,973],{},[547,969,790],{}," ~5 KB (~1.7 KB gzip) — ",[547,972,786],{}," without pulling citty wiring into your API",[932,975,976,981],{},[945,977,978],{},[560,979,980],{},"Runtime deps",[945,982,983,795,986,989,990,993],{},[547,984,985],{},"citty",[547,987,988],{},"std-env"," only — both ",[547,991,992],{},"sideEffects: false",", tree-shakeable ESM",[932,995,996,1001],{},[945,997,998],{},[560,999,1000],{},"Node",[945,1002,1003,1004,1006],{},"18+ · ESM · ",[547,1005,992],{}," on the package",[921,1008,1010],{"id":1009},"fits-wherever-your-code-runs","Fits wherever your code runs",[926,1012,1013,1026],{},[929,1014,1015],{},[932,1016,1017,1020,1023],{},[935,1018,1019],{},"Surface",[935,1021,1022],{},"Entry",[935,1024,1025],{},"Lines of integration",[940,1027,1028,1046,1064,1085],{},[932,1029,1030,1035,1040],{},[945,1031,1032],{},[560,1033,1034],{},"citty CLI",[945,1036,1037,1039],{},[547,1038,685],{}," on the root command",[945,1041,1042,1043],{},"One wrapper + optional ",[547,1044,1045],{},"defineTelemetryCommands()",[932,1047,1048,1053,1061],{},[945,1049,1050],{},[560,1051,1052],{},"Script \u002F migrator",[945,1054,1055,795,1058],{},[547,1056,1057],{},"createTelemetry()",[547,1059,1060],{},"t.run()",[945,1062,1063],{},"Wrap each logical run",[932,1065,1066,1071,1075],{},[945,1067,1068],{},[560,1069,1070],{},"GitHub Actions",[945,1072,1073],{},[547,1074,709],{},[945,1076,1077,1078,714,1081,1084],{},"Same as script; ",[547,1079,1080],{},"ghaAction",[547,1082,1083],{},"ghaEvent"," auto-injected",[932,1086,1087,1092,1098],{},[945,1088,1089],{},[560,1090,1091],{},"Your API (ingest)",[945,1093,1094,787,1096],{},[547,1095,786],{},[547,1097,790],{},[945,1099,1100],{},"One validator + one POST route",[544,1102,1103,1104,1107],{},"No framework lock-in. No PostHog \u002F Segment \u002F custom analytics SDK. No second schema to maintain, since disclosure is generated from the same ",[547,1105,1106],{},"collect"," config the CLI uses at runtime.",[921,1109,1111],{"id":1110},"what-you-skip-building","What you skip building",[655,1113,1114,1119,1128,1131,1139,1142,1148,1151],{},[658,1115,1116,1117,672],{},"Privacy-safe flag capture (never reads raw ",[547,1118,644],{},[658,1120,1121,714,1124,1127],{},[547,1122,1123],{},"DO_NOT_TRACK",[547,1125,1126],{},"EVLOG_TELEMETRY"," \u002F persisted opt-out with outbox purge",[658,1129,1130],{},"Disk outbox with lockfile, stale-lock recovery, and backlog drain",[658,1132,1133,1134,795,1136,672],{},"Auto-generated disclosure (",[547,1135,764],{},[547,1137,1138],{},"telemetry status",[658,1140,1141],{},"First-run notice with opt-out instructions",[658,1143,1144,1145,1147],{},"Typed ",[547,1146,640],{}," with allowlisted string fields",[658,1149,1150],{},"Server-side ingest validation aligned with the CLI envelope",[658,1152,1153,1154],{},"Hard guarantee: ",[560,1155,1156],{},"telemetry never throws, never blocks exit",[921,1158,1160],{"id":1159},"the-payoff","The payoff",[544,1162,1163],{},"Once ingest is live you can answer product questions that CLI authors usually guess at:",[655,1165,1166,1177,1188,1195,1202],{},[658,1167,1168,1169,1171,1172,1171,1175,672],{},"Which commands are actually used (",[547,1170,114],{}," vs ",[547,1173,1174],{},"sync",[547,1176,1138],{},[658,1178,1179,1180,1183,1184,1187],{},"Where runs fail (",[547,1181,1182],{},"outcome",", ",[547,1185,1186],{},"errorCode",", version breakdown)",[658,1189,1190,1191,1194],{},"How long operations take (",[547,1192,1193],{},"durationMs"," per command)",[658,1196,1197,1198,1201],{},"Which versions are still in the wild (",[547,1199,1200],{},"tool.version"," on every event)",[658,1203,1204,1205,1183,1208,1183,1211,672],{},"Whether CI or local dev dominates (",[547,1206,1207],{},"env.ci",[547,1209,1210],{},"env.agent",[547,1212,1213],{},"env.tty",[544,1215,1216],{},"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.",[1218,1219,1222,1223,839,1230,1183,1233,1236,1237,1239],"callout",{"color":1220,"icon":1221},"neutral","i-lucide-package","Try it locally: ",[552,1224,1227],{"href":1225,"rel":1226},"https:\u002F\u002Fgithub.com\u002FHugoRCD\u002Fevlog\u002Ftree\u002Fmain\u002Fexamples\u002Ftelemetry-playground",[556],[547,1228,1229],{},"examples\u002Ftelemetry-playground",[547,1231,1232],{},"pnpm run cli -- doctor",[547,1234,1235],{},"EVLOG_TELEMETRY_DEBUG=1"," to inspect payloads, ",[547,1238,1138],{}," for disclosure.",[812,1241,1243],{"id":1242},"see-also","See also",[655,1245,1246,1251,1256,1261,1267],{},[658,1247,1248,1250],{},[552,1249,417],{"href":418},": citty, scripts, GitHub Actions, delivery config",[658,1252,1253,1255],{},[552,1254,422],{"href":423},": server endpoint, validation, storage",[658,1257,1258,1260],{},[552,1259,427],{"href":428},": envelope, schema extensions, disclosure, consent",[658,1262,1263,1266],{},[552,1264,1265],{"href":384},"Audit",": wide events for security-sensitive actions",[658,1268,1269,1271],{},[552,1270,495],{"href":496},": forward ingested events into Axiom, Datadog, OTLP, or a custom store",[1273,1274,1275],"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":574,"searchDepth":1277,"depth":1277,"links":1278},2,[1279,1280,1287],{"id":814,"depth":1277,"text":815},{"id":915,"depth":1277,"text":916,"children":1281},[1282,1284,1285,1286],{"id":923,"depth":1283,"text":924},3,{"id":1009,"depth":1283,"text":1010},{"id":1110,"depth":1283,"text":1111},{"id":1159,"depth":1283,"text":1160},{"id":1242,"depth":1277,"text":1243},"One event per run for CLIs and automation, with privacy-safe flags, consent, an outbox, and disclosure generated from the same config.","md",[1291,1293,1294],{"label":417,"icon":420,"to":418,"color":1220,"variant":1292},"subtle",{"label":422,"icon":425,"to":423,"color":1220,"variant":1292},{"label":427,"icon":79,"to":428,"color":1220,"variant":1292},{},{"title":36,"icon":39},{"title":119,"description":1288},"AxDuOU1FdLRQg54Mv-z255mpOH-cqTcIzq2DPCj0tsQ",[1300,1302],{"title":406,"path":407,"stem":408,"description":1301,"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":1303,"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.",1786817427963]