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