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