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