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