[{"data":1,"prerenderedAt":3263},["ShallowReactive",2],{"navigation_docs":3,"-use-cases-telemetry-reference":598,"-use-cases-telemetry-reference-surround":3258},[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":600,"body":601,"description":3246,"extension":3247,"links":3248,"meta":3254,"navigation":3255,"path":437,"seo":3256,"stem":438,"__hash__":3257},"docs\u002F5.use-cases\u002F4.telemetry\u002F04.reference.md","Telemetry Reference",{"type":602,"value":603,"toc":3230},"minimark",[604,609,613,988,992,1010,1013,1070,1073,1106,1111,1122,1425,1428,1585,1594,1614,1618,1621,1891,1899,1903,1910,2195,2204,2210,2219,2298,2308,2312,2318,2456,2460,2555,2570,2574,2577,2586,2758,2767,2780,2786,2790,2801,2840,2933,2939,2982,2996,3007,3011,3023,3161,3171,3175,3194,3204,3213,3226],[605,606,608],"h2",{"id":607},"standard-envelope","Standard envelope",[610,611,612],"p",{},"Every run shares the same shape. You do not declare per-command schemas.",[614,615,620],"pre",{"className":616,"code":617,"language":618,"meta":619,"style":619},"language-jsonc shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","{\n  \"event\": \"run\",\n  \"command\": \"sync\",\n  \"durationMs\": 412,\n  \"outcome\": \"success\",\n  \"flags\": { \"dryRun\": true, \"output\": \"\u003Cset>\" },\n  \"tool\": { \"name\": \"my-tool\", \"version\": \"1.0.0\" },\n  \"env\": {\n    \"node\": \"20.11\",\n    \"ci\": false,\n    \"provider\": null,\n    \"tty\": true,\n    \"agent\": \"cursor\"   \u002F\u002F std-env: cursor, claude, codex, … or null\n  },\n  \"machineId\": \"ab3f…\", \u002F\u002F hashed; omitted in ephemeral CI\n  \"custom\": { \"itemsSynced\": 42 }\n}\n","jsonc","",[621,622,623,632,660,681,699,720,767,818,833,855,870,885,900,923,929,953,982],"code",{"__ignoreMap":619},[624,625,628],"span",{"class":626,"line":627},"line",1,[624,629,631],{"class":630},"sMK4o","{\n",[624,633,635,638,642,645,648,651,655,657],{"class":626,"line":634},2,[624,636,637],{"class":630},"  \"",[624,639,641],{"class":640},"spNyl","event",[624,643,644],{"class":630},"\"",[624,646,647],{"class":630},":",[624,649,650],{"class":630}," \"",[624,652,654],{"class":653},"sfazB","run",[624,656,644],{"class":630},[624,658,659],{"class":630},",\n",[624,661,663,665,668,670,672,674,677,679],{"class":626,"line":662},3,[624,664,637],{"class":630},[624,666,667],{"class":640},"command",[624,669,644],{"class":630},[624,671,647],{"class":630},[624,673,650],{"class":630},[624,675,676],{"class":653},"sync",[624,678,644],{"class":630},[624,680,659],{"class":630},[624,682,684,686,689,691,693,697],{"class":626,"line":683},4,[624,685,637],{"class":630},[624,687,688],{"class":640},"durationMs",[624,690,644],{"class":630},[624,692,647],{"class":630},[624,694,696],{"class":695},"sbssI"," 412",[624,698,659],{"class":630},[624,700,702,704,707,709,711,713,716,718],{"class":626,"line":701},5,[624,703,637],{"class":630},[624,705,706],{"class":640},"outcome",[624,708,644],{"class":630},[624,710,647],{"class":630},[624,712,650],{"class":630},[624,714,715],{"class":653},"success",[624,717,644],{"class":630},[624,719,659],{"class":630},[624,721,723,725,728,730,732,735,737,741,743,745,748,750,753,755,757,759,762,764],{"class":626,"line":722},6,[624,724,637],{"class":630},[624,726,727],{"class":640},"flags",[624,729,644],{"class":630},[624,731,647],{"class":630},[624,733,734],{"class":630}," {",[624,736,650],{"class":630},[624,738,740],{"class":739},"sBMFI","dryRun",[624,742,644],{"class":630},[624,744,647],{"class":630},[624,746,747],{"class":630}," true,",[624,749,650],{"class":630},[624,751,752],{"class":739},"output",[624,754,644],{"class":630},[624,756,647],{"class":630},[624,758,650],{"class":630},[624,760,761],{"class":653},"\u003Cset>",[624,763,644],{"class":630},[624,765,766],{"class":630}," },\n",[624,768,770,772,775,777,779,781,783,786,788,790,792,795,797,800,802,805,807,809,811,814,816],{"class":626,"line":769},7,[624,771,637],{"class":630},[624,773,774],{"class":640},"tool",[624,776,644],{"class":630},[624,778,647],{"class":630},[624,780,734],{"class":630},[624,782,650],{"class":630},[624,784,785],{"class":739},"name",[624,787,644],{"class":630},[624,789,647],{"class":630},[624,791,650],{"class":630},[624,793,794],{"class":653},"my-tool",[624,796,644],{"class":630},[624,798,799],{"class":630},",",[624,801,650],{"class":630},[624,803,804],{"class":739},"version",[624,806,644],{"class":630},[624,808,647],{"class":630},[624,810,650],{"class":630},[624,812,813],{"class":653},"1.0.0",[624,815,644],{"class":630},[624,817,766],{"class":630},[624,819,821,823,826,828,830],{"class":626,"line":820},8,[624,822,637],{"class":630},[624,824,825],{"class":640},"env",[624,827,644],{"class":630},[624,829,647],{"class":630},[624,831,832],{"class":630}," {\n",[624,834,836,839,842,844,846,848,851,853],{"class":626,"line":835},9,[624,837,838],{"class":630},"    \"",[624,840,841],{"class":739},"node",[624,843,644],{"class":630},[624,845,647],{"class":630},[624,847,650],{"class":630},[624,849,850],{"class":653},"20.11",[624,852,644],{"class":630},[624,854,659],{"class":630},[624,856,858,860,863,865,867],{"class":626,"line":857},10,[624,859,838],{"class":630},[624,861,862],{"class":739},"ci",[624,864,644],{"class":630},[624,866,647],{"class":630},[624,868,869],{"class":630}," false,\n",[624,871,873,875,878,880,882],{"class":626,"line":872},11,[624,874,838],{"class":630},[624,876,877],{"class":739},"provider",[624,879,644],{"class":630},[624,881,647],{"class":630},[624,883,884],{"class":630}," null,\n",[624,886,888,890,893,895,897],{"class":626,"line":887},12,[624,889,838],{"class":630},[624,891,892],{"class":739},"tty",[624,894,644],{"class":630},[624,896,647],{"class":630},[624,898,899],{"class":630}," true,\n",[624,901,903,905,908,910,912,914,917,919],{"class":626,"line":902},13,[624,904,838],{"class":630},[624,906,907],{"class":739},"agent",[624,909,644],{"class":630},[624,911,647],{"class":630},[624,913,650],{"class":630},[624,915,916],{"class":653},"cursor",[624,918,644],{"class":630},[624,920,922],{"class":921},"sHwdD","   \u002F\u002F std-env: cursor, claude, codex, … or null\n",[624,924,926],{"class":626,"line":925},14,[624,927,928],{"class":630},"  },\n",[624,930,932,934,937,939,941,943,946,948,950],{"class":626,"line":931},15,[624,933,637],{"class":630},[624,935,936],{"class":640},"machineId",[624,938,644],{"class":630},[624,940,647],{"class":630},[624,942,650],{"class":630},[624,944,945],{"class":653},"ab3f…",[624,947,644],{"class":630},[624,949,799],{"class":630},[624,951,952],{"class":921}," \u002F\u002F hashed; omitted in ephemeral CI\n",[624,954,956,958,961,963,965,967,969,972,974,976,979],{"class":626,"line":955},16,[624,957,637],{"class":630},[624,959,960],{"class":640},"custom",[624,962,644],{"class":630},[624,964,647],{"class":630},[624,966,734],{"class":630},[624,968,650],{"class":630},[624,970,971],{"class":739},"itemsSynced",[624,973,644],{"class":630},[624,975,647],{"class":630},[624,977,978],{"class":695}," 42",[624,980,981],{"class":630}," }\n",[624,983,985],{"class":626,"line":984},17,[624,986,987],{"class":630},"}\n",[605,989,991],{"id":990},"extending-the-schema","Extending the schema",[610,993,994,995,999,1000,1003,1004,1006,1007,1009],{},"The envelope above is ",[996,997,998],"strong",{},"fixed",": every tool sends the same top-level shape so ",[621,1001,1002],{},"parseIngestBody()"," and disclosure stay predictable. You do not add fields next to ",[621,1005,667],{}," or ",[621,1008,688],{},".",[610,1011,1012],{},"Your product schema lives in two extension zones:",[1014,1015,1016,1032],"table",{},[1017,1018,1019],"thead",{},[1020,1021,1022,1026,1029],"tr",{},[1023,1024,1025],"th",{},"Zone",[1023,1027,1028],{},"Who sets it",[1023,1030,1031],{},"What goes there",[1033,1034,1035,1051],"tbody",{},[1020,1036,1037,1042,1048],{},[1038,1039,1040],"td",{},[621,1041,727],{},[1038,1043,1044,1045],{},"citty (auto) + ",[621,1046,1047],{},"collect.flags",[1038,1049,1050],{},"Flags you passed — booleans\u002Fnumbers as values, strings only when allowlisted",[1020,1052,1053,1057,1067],{},[1038,1054,1055],{},[621,1056,960],{},[1038,1058,1059,1060,1063,1064],{},"you via ",[621,1061,1062],{},"telemetry.set()"," + ",[621,1065,1066],{},"collect.fields",[1038,1068,1069],{},"Business counters, categorical dimensions, schema version",[610,1071,1072],{},"Think of it as two contracts:",[1074,1075,1076,1091],"ul",{},[1077,1078,1079,1082,1083,1086,1087,1090],"li",{},[996,1080,1081],{},"Transport contract"," (",[621,1084,1085],{},"RunEvent","): owned by ",[621,1088,1089],{},"@evlog\u002Ftelemetry",", stable across tools",[1077,1092,1093,1082,1096,1098,1099,1101,1102,1105],{},[996,1094,1095],{},"Product contract",[621,1097,960],{}," + declared ",[621,1100,727],{},"): owned by you, declared in ",[621,1103,1104],{},"collect",", mirrored on the server",[1107,1108,1110],"h3",{"id":1109},"declare-your-extensions-once","Declare your extensions once",[610,1112,1113,1114,1117,1118,1121],{},"Everything you collect beyond the standard envelope is declared inline in the same ",[621,1115,1116],{},"withTelemetry()"," \u002F ",[621,1119,1120],{},"createTelemetry()"," call:",[614,1123,1128],{"className":1124,"code":1125,"filename":1126,"language":1127,"meta":619,"style":619},"language-ts shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","withTelemetry(command, {\n  name: 'acme-cli',\n  version: '2.1.0',\n  endpoint: 'https:\u002F\u002Ftelemetry.acme.dev\u002Fapi\u002Fingest',\n  collect: {\n    flags: {\n      format: ['json', 'yaml', 'table'],\n      target: ['staging', 'production'],\n    },\n    fields: {\n      product: ['cli', 'action', 'migrator'],\n      plan: ['free', 'pro', 'enterprise'],\n      framework: ['nuxt', 'next', 'remix'],\n    },\n  },\n})\n","src\u002Findex.ts","ts",[621,1129,1130,1144,1163,1179,1195,1204,1213,1252,1281,1286,1295,1333,1371,1409,1413,1417],{"__ignoreMap":619},[624,1131,1132,1136,1140,1142],{"class":626,"line":627},[624,1133,1135],{"class":1134},"s2Zo4","withTelemetry",[624,1137,1139],{"class":1138},"sTEyZ","(command",[624,1141,799],{"class":630},[624,1143,832],{"class":630},[624,1145,1146,1150,1152,1155,1158,1161],{"class":626,"line":634},[624,1147,1149],{"class":1148},"swJcz","  name",[624,1151,647],{"class":630},[624,1153,1154],{"class":630}," '",[624,1156,1157],{"class":653},"acme-cli",[624,1159,1160],{"class":630},"'",[624,1162,659],{"class":630},[624,1164,1165,1168,1170,1172,1175,1177],{"class":626,"line":662},[624,1166,1167],{"class":1148},"  version",[624,1169,647],{"class":630},[624,1171,1154],{"class":630},[624,1173,1174],{"class":653},"2.1.0",[624,1176,1160],{"class":630},[624,1178,659],{"class":630},[624,1180,1181,1184,1186,1188,1191,1193],{"class":626,"line":683},[624,1182,1183],{"class":1148},"  endpoint",[624,1185,647],{"class":630},[624,1187,1154],{"class":630},[624,1189,1190],{"class":653},"https:\u002F\u002Ftelemetry.acme.dev\u002Fapi\u002Fingest",[624,1192,1160],{"class":630},[624,1194,659],{"class":630},[624,1196,1197,1200,1202],{"class":626,"line":701},[624,1198,1199],{"class":1148},"  collect",[624,1201,647],{"class":630},[624,1203,832],{"class":630},[624,1205,1206,1209,1211],{"class":626,"line":722},[624,1207,1208],{"class":1148},"    flags",[624,1210,647],{"class":630},[624,1212,832],{"class":630},[624,1214,1215,1218,1220,1223,1225,1228,1230,1232,1234,1237,1239,1241,1243,1245,1247,1250],{"class":626,"line":769},[624,1216,1217],{"class":1148},"      format",[624,1219,647],{"class":630},[624,1221,1222],{"class":1138}," [",[624,1224,1160],{"class":630},[624,1226,1227],{"class":653},"json",[624,1229,1160],{"class":630},[624,1231,799],{"class":630},[624,1233,1154],{"class":630},[624,1235,1236],{"class":653},"yaml",[624,1238,1160],{"class":630},[624,1240,799],{"class":630},[624,1242,1154],{"class":630},[624,1244,1014],{"class":653},[624,1246,1160],{"class":630},[624,1248,1249],{"class":1138},"]",[624,1251,659],{"class":630},[624,1253,1254,1257,1259,1261,1263,1266,1268,1270,1272,1275,1277,1279],{"class":626,"line":820},[624,1255,1256],{"class":1148},"      target",[624,1258,647],{"class":630},[624,1260,1222],{"class":1138},[624,1262,1160],{"class":630},[624,1264,1265],{"class":653},"staging",[624,1267,1160],{"class":630},[624,1269,799],{"class":630},[624,1271,1154],{"class":630},[624,1273,1274],{"class":653},"production",[624,1276,1160],{"class":630},[624,1278,1249],{"class":1138},[624,1280,659],{"class":630},[624,1282,1283],{"class":626,"line":835},[624,1284,1285],{"class":630},"    },\n",[624,1287,1288,1291,1293],{"class":626,"line":857},[624,1289,1290],{"class":1148},"    fields",[624,1292,647],{"class":630},[624,1294,832],{"class":630},[624,1296,1297,1300,1302,1304,1306,1309,1311,1313,1315,1318,1320,1322,1324,1327,1329,1331],{"class":626,"line":872},[624,1298,1299],{"class":1148},"      product",[624,1301,647],{"class":630},[624,1303,1222],{"class":1138},[624,1305,1160],{"class":630},[624,1307,1308],{"class":653},"cli",[624,1310,1160],{"class":630},[624,1312,799],{"class":630},[624,1314,1154],{"class":630},[624,1316,1317],{"class":653},"action",[624,1319,1160],{"class":630},[624,1321,799],{"class":630},[624,1323,1154],{"class":630},[624,1325,1326],{"class":653},"migrator",[624,1328,1160],{"class":630},[624,1330,1249],{"class":1138},[624,1332,659],{"class":630},[624,1334,1335,1338,1340,1342,1344,1347,1349,1351,1353,1356,1358,1360,1362,1365,1367,1369],{"class":626,"line":887},[624,1336,1337],{"class":1148},"      plan",[624,1339,647],{"class":630},[624,1341,1222],{"class":1138},[624,1343,1160],{"class":630},[624,1345,1346],{"class":653},"free",[624,1348,1160],{"class":630},[624,1350,799],{"class":630},[624,1352,1154],{"class":630},[624,1354,1355],{"class":653},"pro",[624,1357,1160],{"class":630},[624,1359,799],{"class":630},[624,1361,1154],{"class":630},[624,1363,1364],{"class":653},"enterprise",[624,1366,1160],{"class":630},[624,1368,1249],{"class":1138},[624,1370,659],{"class":630},[624,1372,1373,1376,1378,1380,1382,1385,1387,1389,1391,1394,1396,1398,1400,1403,1405,1407],{"class":626,"line":902},[624,1374,1375],{"class":1148},"      framework",[624,1377,647],{"class":630},[624,1379,1222],{"class":1138},[624,1381,1160],{"class":630},[624,1383,1384],{"class":653},"nuxt",[624,1386,1160],{"class":630},[624,1388,799],{"class":630},[624,1390,1154],{"class":630},[624,1392,1393],{"class":653},"next",[624,1395,1160],{"class":630},[624,1397,799],{"class":630},[624,1399,1154],{"class":630},[624,1401,1402],{"class":653},"remix",[624,1404,1160],{"class":630},[624,1406,1249],{"class":1138},[624,1408,659],{"class":630},[624,1410,1411],{"class":626,"line":925},[624,1412,1285],{"class":630},[624,1414,1415],{"class":626,"line":931},[624,1416,928],{"class":630},[624,1418,1419,1422],{"class":626,"line":955},[624,1420,1421],{"class":630},"}",[624,1423,1424],{"class":1138},")\n",[610,1426,1427],{},"Inside handlers, add counters and dimensions:",[614,1429,1432],{"className":1124,"code":1430,"filename":1431,"language":1127,"meta":619,"style":619},"await t.run('deploy', async () => {\n  const result = await deployServices()\n  telemetry.set({\n    servicesDeployed: result.count,   \u002F\u002F number — always allowed\n    rollbackUsed: false,              \u002F\u002F boolean — always allowed\n    framework: 'nuxt',                \u002F\u002F string — allowed (in collect.fields)\n    schemaVersion: 2,                 \u002F\u002F number — version your custom shape\n  })\n})\n","src\u002Fcommands\u002Fdeploy.ts",[621,1433,1434,1470,1490,1504,1523,1539,1557,1572,1579],{"__ignoreMap":619},[624,1435,1436,1440,1443,1445,1447,1450,1452,1455,1457,1459,1462,1465,1468],{"class":626,"line":627},[624,1437,1439],{"class":1438},"s7zQu","await",[624,1441,1442],{"class":1138}," t",[624,1444,1009],{"class":630},[624,1446,654],{"class":1134},[624,1448,1449],{"class":1138},"(",[624,1451,1160],{"class":630},[624,1453,1454],{"class":653},"deploy",[624,1456,1160],{"class":630},[624,1458,799],{"class":630},[624,1460,1461],{"class":640}," async",[624,1463,1464],{"class":630}," ()",[624,1466,1467],{"class":640}," =>",[624,1469,832],{"class":630},[624,1471,1472,1475,1478,1481,1484,1487],{"class":626,"line":634},[624,1473,1474],{"class":640},"  const",[624,1476,1477],{"class":1138}," result",[624,1479,1480],{"class":630}," =",[624,1482,1483],{"class":1438}," await",[624,1485,1486],{"class":1134}," deployServices",[624,1488,1489],{"class":1148},"()\n",[624,1491,1492,1495,1497,1500,1502],{"class":626,"line":662},[624,1493,1494],{"class":1138},"  telemetry",[624,1496,1009],{"class":630},[624,1498,1499],{"class":1134},"set",[624,1501,1449],{"class":1148},[624,1503,631],{"class":630},[624,1505,1506,1509,1511,1513,1515,1518,1520],{"class":626,"line":683},[624,1507,1508],{"class":1148},"    servicesDeployed",[624,1510,647],{"class":630},[624,1512,1477],{"class":1138},[624,1514,1009],{"class":630},[624,1516,1517],{"class":1138},"count",[624,1519,799],{"class":630},[624,1521,1522],{"class":921},"   \u002F\u002F number — always allowed\n",[624,1524,1525,1528,1530,1534,1536],{"class":626,"line":701},[624,1526,1527],{"class":1148},"    rollbackUsed",[624,1529,647],{"class":630},[624,1531,1533],{"class":1532},"sfNiH"," false",[624,1535,799],{"class":630},[624,1537,1538],{"class":921},"              \u002F\u002F boolean — always allowed\n",[624,1540,1541,1544,1546,1548,1550,1552,1554],{"class":626,"line":722},[624,1542,1543],{"class":1148},"    framework",[624,1545,647],{"class":630},[624,1547,1154],{"class":630},[624,1549,1384],{"class":653},[624,1551,1160],{"class":630},[624,1553,799],{"class":630},[624,1555,1556],{"class":921},"                \u002F\u002F string — allowed (in collect.fields)\n",[624,1558,1559,1562,1564,1567,1569],{"class":626,"line":769},[624,1560,1561],{"class":1148},"    schemaVersion",[624,1563,647],{"class":630},[624,1565,1566],{"class":695}," 2",[624,1568,799],{"class":630},[624,1570,1571],{"class":921},"                 \u002F\u002F number — version your custom shape\n",[624,1573,1574,1577],{"class":626,"line":820},[624,1575,1576],{"class":630},"  }",[624,1578,1424],{"class":1148},[624,1580,1581,1583],{"class":626,"line":835},[624,1582,1421],{"class":630},[624,1584,1424],{"class":1138},[610,1586,1587,1588,1591,1592,1009],{},"Undeclared strings are ",[996,1589,1590],{},"dropped at runtime",", never thrown. That is the privacy guarantee: no accidental paths, tokens, or free-form PII in ",[621,1593,960],{},[1595,1596,1597,1600,1601,1604,1605,1607,1608,1610,1611,1613],"note",{},[996,1598,1599],{},"Typing:"," ",[621,1602,1603],{},"TelemetryHandle.set()"," autocomplete covers declared ",[621,1606,1066],{}," keys. Use the ambient ",[621,1609,1062],{}," for extra numeric\u002Fboolean counters in the same run, and both merge into ",[621,1612,960],{}," before the event is recorded.",[1107,1615,1617],{"id":1616},"mirror-on-the-server","Mirror on the server",[610,1619,1620],{},"Your ingest handler is the second gate. Pass the same tool name and custom keys you declared on the CLI:",[614,1622,1625],{"className":1124,"code":1623,"filename":1624,"language":1127,"meta":619,"style":619},"import { parseIngestBody } from '@evlog\u002Ftelemetry\u002Fingest'\n\nconst ALLOWED_CUSTOM = [\n  'servicesDeployed', 'rollbackUsed', 'framework',\n  'product', 'plan', 'schemaVersion',\n  'ghaAction', 'ghaEvent',\n] as const\n\nexport async function POST(req: Request) {\n  const raw = await req.text()\n  const events = parseIngestBody(raw, {\n    allowedTools: ['acme-cli'],\n    allowedCustomKeys: { 'acme-cli': ALLOWED_CUSTOM },\n  })\n  \u002F\u002F dedupe on idempotencyKey, then persist\n}\n","app\u002Fapi\u002Ftelemetry\u002Fingest\u002Froute.ts",[621,1626,1627,1651,1657,1671,1701,1730,1750,1761,1765,1794,1815,1835,1854,1876,1882,1887],{"__ignoreMap":619},[624,1628,1629,1632,1634,1637,1640,1643,1645,1648],{"class":626,"line":627},[624,1630,1631],{"class":1438},"import",[624,1633,734],{"class":630},[624,1635,1636],{"class":1138}," parseIngestBody",[624,1638,1639],{"class":630}," }",[624,1641,1642],{"class":1438}," from",[624,1644,1154],{"class":630},[624,1646,1647],{"class":653},"@evlog\u002Ftelemetry\u002Fingest",[624,1649,1650],{"class":630},"'\n",[624,1652,1653],{"class":626,"line":634},[624,1654,1656],{"emptyLinePlaceholder":1655},true,"\n",[624,1658,1659,1662,1665,1668],{"class":626,"line":662},[624,1660,1661],{"class":640},"const",[624,1663,1664],{"class":1138}," ALLOWED_CUSTOM ",[624,1666,1667],{"class":630},"=",[624,1669,1670],{"class":1138}," [\n",[624,1672,1673,1676,1679,1681,1683,1685,1688,1690,1692,1694,1697,1699],{"class":626,"line":683},[624,1674,1675],{"class":630},"  '",[624,1677,1678],{"class":653},"servicesDeployed",[624,1680,1160],{"class":630},[624,1682,799],{"class":630},[624,1684,1154],{"class":630},[624,1686,1687],{"class":653},"rollbackUsed",[624,1689,1160],{"class":630},[624,1691,799],{"class":630},[624,1693,1154],{"class":630},[624,1695,1696],{"class":653},"framework",[624,1698,1160],{"class":630},[624,1700,659],{"class":630},[624,1702,1703,1705,1708,1710,1712,1714,1717,1719,1721,1723,1726,1728],{"class":626,"line":701},[624,1704,1675],{"class":630},[624,1706,1707],{"class":653},"product",[624,1709,1160],{"class":630},[624,1711,799],{"class":630},[624,1713,1154],{"class":630},[624,1715,1716],{"class":653},"plan",[624,1718,1160],{"class":630},[624,1720,799],{"class":630},[624,1722,1154],{"class":630},[624,1724,1725],{"class":653},"schemaVersion",[624,1727,1160],{"class":630},[624,1729,659],{"class":630},[624,1731,1732,1734,1737,1739,1741,1743,1746,1748],{"class":626,"line":722},[624,1733,1675],{"class":630},[624,1735,1736],{"class":653},"ghaAction",[624,1738,1160],{"class":630},[624,1740,799],{"class":630},[624,1742,1154],{"class":630},[624,1744,1745],{"class":653},"ghaEvent",[624,1747,1160],{"class":630},[624,1749,659],{"class":630},[624,1751,1752,1755,1758],{"class":626,"line":769},[624,1753,1754],{"class":1138},"] ",[624,1756,1757],{"class":1438},"as",[624,1759,1760],{"class":640}," const\n",[624,1762,1763],{"class":626,"line":820},[624,1764,1656],{"emptyLinePlaceholder":1655},[624,1766,1767,1770,1772,1775,1778,1780,1784,1786,1789,1792],{"class":626,"line":835},[624,1768,1769],{"class":1438},"export",[624,1771,1461],{"class":640},[624,1773,1774],{"class":640}," function",[624,1776,1777],{"class":1134}," POST",[624,1779,1449],{"class":630},[624,1781,1783],{"class":1782},"sHdIc","req",[624,1785,647],{"class":630},[624,1787,1788],{"class":739}," Request",[624,1790,1791],{"class":630},")",[624,1793,832],{"class":630},[624,1795,1796,1798,1801,1803,1805,1808,1810,1813],{"class":626,"line":857},[624,1797,1474],{"class":640},[624,1799,1800],{"class":1138}," raw",[624,1802,1480],{"class":630},[624,1804,1483],{"class":1438},[624,1806,1807],{"class":1138}," req",[624,1809,1009],{"class":630},[624,1811,1812],{"class":1134},"text",[624,1814,1489],{"class":1148},[624,1816,1817,1819,1822,1824,1826,1828,1831,1833],{"class":626,"line":872},[624,1818,1474],{"class":640},[624,1820,1821],{"class":1138}," events",[624,1823,1480],{"class":630},[624,1825,1636],{"class":1134},[624,1827,1449],{"class":1148},[624,1829,1830],{"class":1138},"raw",[624,1832,799],{"class":630},[624,1834,832],{"class":630},[624,1836,1837,1840,1842,1844,1846,1848,1850,1852],{"class":626,"line":887},[624,1838,1839],{"class":1148},"    allowedTools",[624,1841,647],{"class":630},[624,1843,1222],{"class":1148},[624,1845,1160],{"class":630},[624,1847,1157],{"class":653},[624,1849,1160],{"class":630},[624,1851,1249],{"class":1148},[624,1853,659],{"class":630},[624,1855,1856,1859,1861,1863,1865,1867,1869,1871,1874],{"class":626,"line":902},[624,1857,1858],{"class":1148},"    allowedCustomKeys",[624,1860,647],{"class":630},[624,1862,734],{"class":630},[624,1864,1154],{"class":630},[624,1866,1157],{"class":1148},[624,1868,1160],{"class":630},[624,1870,647],{"class":630},[624,1872,1873],{"class":1138}," ALLOWED_CUSTOM",[624,1875,766],{"class":630},[624,1877,1878,1880],{"class":626,"line":925},[624,1879,1576],{"class":630},[624,1881,1424],{"class":1148},[624,1883,1884],{"class":626,"line":931},[624,1885,1886],{"class":921},"  \u002F\u002F dedupe on idempotencyKey, then persist\n",[624,1888,1889],{"class":626,"line":955},[624,1890,987],{"class":630},[610,1892,1893,1895,1896,1898],{},[621,1894,1002],{}," strips any ",[621,1897,960],{}," key you did not list, even if a client somehow sent it.",[1107,1900,1902],{"id":1901},"map-to-your-warehouse-schema","Map to your warehouse schema",[610,1904,1905,1906,1909],{},"After validation, shape the event for ",[996,1907,1908],{},"your"," database. The evlog envelope is the wire format; your tables are your choice:",[614,1911,1914],{"className":1124,"code":1912,"filename":1913,"language":1127,"meta":619,"style":619},"function toRow(event: RunEvent) {\n  return {\n    command: event.command,\n    duration_ms: event.durationMs,\n    outcome: event.outcome,\n    tool_version: event.tool.version,\n    format: event.flags.format,\n    target: event.flags.target,\n    services_deployed: event.custom.servicesDeployed,\n    framework: event.custom.framework,\n    plan: event.custom.plan,\n    schema_version: event.custom.schemaVersion ?? 1,\n    is_ci: event.env.ci,\n    node: event.env.node,\n    received_at: new Date(),\n  }\n}\n","lib\u002Ftelemetry-store.ts",[621,1915,1916,1937,1944,1960,1975,1990,2009,2029,2049,2068,2086,2105,2130,2149,2168,2186,2191],{"__ignoreMap":619},[624,1917,1918,1921,1924,1926,1928,1930,1933,1935],{"class":626,"line":627},[624,1919,1920],{"class":640},"function",[624,1922,1923],{"class":1134}," toRow",[624,1925,1449],{"class":630},[624,1927,641],{"class":1782},[624,1929,647],{"class":630},[624,1931,1932],{"class":739}," RunEvent",[624,1934,1791],{"class":630},[624,1936,832],{"class":630},[624,1938,1939,1942],{"class":626,"line":634},[624,1940,1941],{"class":1438},"  return",[624,1943,832],{"class":630},[624,1945,1946,1949,1951,1954,1956,1958],{"class":626,"line":662},[624,1947,1948],{"class":1148},"    command",[624,1950,647],{"class":630},[624,1952,1953],{"class":1138}," event",[624,1955,1009],{"class":630},[624,1957,667],{"class":1138},[624,1959,659],{"class":630},[624,1961,1962,1965,1967,1969,1971,1973],{"class":626,"line":683},[624,1963,1964],{"class":1148},"    duration_ms",[624,1966,647],{"class":630},[624,1968,1953],{"class":1138},[624,1970,1009],{"class":630},[624,1972,688],{"class":1138},[624,1974,659],{"class":630},[624,1976,1977,1980,1982,1984,1986,1988],{"class":626,"line":701},[624,1978,1979],{"class":1148},"    outcome",[624,1981,647],{"class":630},[624,1983,1953],{"class":1138},[624,1985,1009],{"class":630},[624,1987,706],{"class":1138},[624,1989,659],{"class":630},[624,1991,1992,1995,1997,1999,2001,2003,2005,2007],{"class":626,"line":722},[624,1993,1994],{"class":1148},"    tool_version",[624,1996,647],{"class":630},[624,1998,1953],{"class":1138},[624,2000,1009],{"class":630},[624,2002,774],{"class":1138},[624,2004,1009],{"class":630},[624,2006,804],{"class":1138},[624,2008,659],{"class":630},[624,2010,2011,2014,2016,2018,2020,2022,2024,2027],{"class":626,"line":769},[624,2012,2013],{"class":1148},"    format",[624,2015,647],{"class":630},[624,2017,1953],{"class":1138},[624,2019,1009],{"class":630},[624,2021,727],{"class":1138},[624,2023,1009],{"class":630},[624,2025,2026],{"class":1138},"format",[624,2028,659],{"class":630},[624,2030,2031,2034,2036,2038,2040,2042,2044,2047],{"class":626,"line":820},[624,2032,2033],{"class":1148},"    target",[624,2035,647],{"class":630},[624,2037,1953],{"class":1138},[624,2039,1009],{"class":630},[624,2041,727],{"class":1138},[624,2043,1009],{"class":630},[624,2045,2046],{"class":1138},"target",[624,2048,659],{"class":630},[624,2050,2051,2054,2056,2058,2060,2062,2064,2066],{"class":626,"line":835},[624,2052,2053],{"class":1148},"    services_deployed",[624,2055,647],{"class":630},[624,2057,1953],{"class":1138},[624,2059,1009],{"class":630},[624,2061,960],{"class":1138},[624,2063,1009],{"class":630},[624,2065,1678],{"class":1138},[624,2067,659],{"class":630},[624,2069,2070,2072,2074,2076,2078,2080,2082,2084],{"class":626,"line":857},[624,2071,1543],{"class":1148},[624,2073,647],{"class":630},[624,2075,1953],{"class":1138},[624,2077,1009],{"class":630},[624,2079,960],{"class":1138},[624,2081,1009],{"class":630},[624,2083,1696],{"class":1138},[624,2085,659],{"class":630},[624,2087,2088,2091,2093,2095,2097,2099,2101,2103],{"class":626,"line":872},[624,2089,2090],{"class":1148},"    plan",[624,2092,647],{"class":630},[624,2094,1953],{"class":1138},[624,2096,1009],{"class":630},[624,2098,960],{"class":1138},[624,2100,1009],{"class":630},[624,2102,1716],{"class":1138},[624,2104,659],{"class":630},[624,2106,2107,2110,2112,2114,2116,2118,2120,2122,2125,2128],{"class":626,"line":887},[624,2108,2109],{"class":1148},"    schema_version",[624,2111,647],{"class":630},[624,2113,1953],{"class":1138},[624,2115,1009],{"class":630},[624,2117,960],{"class":1138},[624,2119,1009],{"class":630},[624,2121,1725],{"class":1138},[624,2123,2124],{"class":630}," ??",[624,2126,2127],{"class":695}," 1",[624,2129,659],{"class":630},[624,2131,2132,2135,2137,2139,2141,2143,2145,2147],{"class":626,"line":902},[624,2133,2134],{"class":1148},"    is_ci",[624,2136,647],{"class":630},[624,2138,1953],{"class":1138},[624,2140,1009],{"class":630},[624,2142,825],{"class":1138},[624,2144,1009],{"class":630},[624,2146,862],{"class":1138},[624,2148,659],{"class":630},[624,2150,2151,2154,2156,2158,2160,2162,2164,2166],{"class":626,"line":925},[624,2152,2153],{"class":1148},"    node",[624,2155,647],{"class":630},[624,2157,1953],{"class":1138},[624,2159,1009],{"class":630},[624,2161,825],{"class":1138},[624,2163,1009],{"class":630},[624,2165,841],{"class":1138},[624,2167,659],{"class":630},[624,2169,2170,2173,2175,2178,2181,2184],{"class":626,"line":931},[624,2171,2172],{"class":1148},"    received_at",[624,2174,647],{"class":630},[624,2176,2177],{"class":630}," new",[624,2179,2180],{"class":1134}," Date",[624,2182,2183],{"class":1148},"()",[624,2185,659],{"class":630},[624,2187,2188],{"class":626,"line":955},[624,2189,2190],{"class":630},"  }\n",[624,2192,2193],{"class":626,"line":984},[624,2194,987],{"class":630},[610,2196,2197,2198,2200,2201,2203],{},"This is where a company \"modifies the schema\" in practice: not by changing ",[621,2199,1085],{},", but by defining how ",[621,2202,960],{}," maps into internal analytics tables.",[1107,2205,2207,2208],{"id":2206},"version-breaking-changes-in-custom","Version breaking changes in ",[621,2209,960],{},[610,2211,2212,2213,2215,2216,2218],{},"When your product counters evolve, bump a numeric ",[621,2214,1725],{}," in ",[621,2217,960],{}," (no allowlist needed) and branch in the ingest mapper:",[614,2220,2222],{"className":1124,"code":2221,"language":1127,"meta":619,"style":619},"const version = (event.custom.schemaVersion as number | undefined) ?? 1\nif (version === 1) return mapV1(event)\nreturn mapV2(event)\n",[621,2223,2224,2265,2289],{"__ignoreMap":619},[624,2225,2226,2228,2231,2233,2236,2238,2240,2242,2245,2247,2250,2253,2256,2259,2262],{"class":626,"line":627},[624,2227,1661],{"class":640},[624,2229,2230],{"class":1138}," version ",[624,2232,1667],{"class":630},[624,2234,2235],{"class":1138}," (event",[624,2237,1009],{"class":630},[624,2239,960],{"class":1138},[624,2241,1009],{"class":630},[624,2243,2244],{"class":1138},"schemaVersion ",[624,2246,1757],{"class":1438},[624,2248,2249],{"class":739}," number",[624,2251,2252],{"class":630}," |",[624,2254,2255],{"class":739}," undefined",[624,2257,2258],{"class":1138},") ",[624,2260,2261],{"class":630},"??",[624,2263,2264],{"class":695}," 1\n",[624,2266,2267,2270,2273,2276,2278,2280,2283,2286],{"class":626,"line":634},[624,2268,2269],{"class":1438},"if",[624,2271,2272],{"class":1138}," (version ",[624,2274,2275],{"class":630},"===",[624,2277,2127],{"class":695},[624,2279,2258],{"class":1138},[624,2281,2282],{"class":1438},"return",[624,2284,2285],{"class":1134}," mapV1",[624,2287,2288],{"class":1138},"(event)\n",[624,2290,2291,2293,2296],{"class":626,"line":662},[624,2292,2282],{"class":1438},[624,2294,2295],{"class":1134}," mapV2",[624,2297,2288],{"class":1138},[610,2299,2300,2301,2304,2305,2307],{},"Commit an updated ",[621,2302,2303],{},"TELEMETRY.md"," whenever ",[621,2306,1104],{}," changes so disclosure stays aligned with releases.",[1107,2309,2311],{"id":2310},"multiple-tools-one-endpoint","Multiple tools, one endpoint",[610,2313,2314,2315,647],{},"If several CLIs POST to the same ingest URL, namespace custom keys or rely on ",[621,2316,2317],{},"tool.name",[614,2319,2321],{"className":1124,"code":2320,"language":1127,"meta":619,"style":619},"\u002F\u002F Option A — prefix keys per product line\ntelemetry.set({ acme_product: 'cli', deployCount: 3 })\n\n\u002F\u002F Option B — separate allowedCustomKeys per tool.name in parseIngestBody\nallowedCustomKeys: {\n  'acme-cli': ['deployCount', 'framework'],\n  'acme-action': ['jobDuration', 'ghaAction', 'ghaEvent'],\n}\n",[621,2322,2323,2328,2366,2370,2375,2384,2414,2452],{"__ignoreMap":619},[624,2324,2325],{"class":626,"line":627},[624,2326,2327],{"class":921},"\u002F\u002F Option A — prefix keys per product line\n",[624,2329,2330,2332,2334,2336,2338,2341,2344,2346,2348,2350,2352,2354,2357,2359,2362,2364],{"class":626,"line":634},[624,2331,124],{"class":1138},[624,2333,1009],{"class":630},[624,2335,1499],{"class":1134},[624,2337,1449],{"class":1138},[624,2339,2340],{"class":630},"{",[624,2342,2343],{"class":1148}," acme_product",[624,2345,647],{"class":630},[624,2347,1154],{"class":630},[624,2349,1308],{"class":653},[624,2351,1160],{"class":630},[624,2353,799],{"class":630},[624,2355,2356],{"class":1148}," deployCount",[624,2358,647],{"class":630},[624,2360,2361],{"class":695}," 3",[624,2363,1639],{"class":630},[624,2365,1424],{"class":1138},[624,2367,2368],{"class":626,"line":662},[624,2369,1656],{"emptyLinePlaceholder":1655},[624,2371,2372],{"class":626,"line":683},[624,2373,2374],{"class":921},"\u002F\u002F Option B — separate allowedCustomKeys per tool.name in parseIngestBody\n",[624,2376,2377,2380,2382],{"class":626,"line":701},[624,2378,2379],{"class":739},"allowedCustomKeys",[624,2381,647],{"class":630},[624,2383,832],{"class":630},[624,2385,2386,2388,2390,2392,2395,2397,2400,2402,2404,2406,2408,2410,2412],{"class":626,"line":722},[624,2387,1675],{"class":630},[624,2389,1157],{"class":653},[624,2391,1160],{"class":630},[624,2393,2394],{"class":1148},": [",[624,2396,1160],{"class":630},[624,2398,2399],{"class":653},"deployCount",[624,2401,1160],{"class":630},[624,2403,799],{"class":630},[624,2405,1154],{"class":630},[624,2407,1696],{"class":653},[624,2409,1160],{"class":630},[624,2411,1249],{"class":1148},[624,2413,659],{"class":630},[624,2415,2416,2418,2421,2423,2425,2427,2430,2432,2434,2436,2438,2440,2442,2444,2446,2448,2450],{"class":626,"line":769},[624,2417,1675],{"class":630},[624,2419,2420],{"class":653},"acme-action",[624,2422,1160],{"class":630},[624,2424,2394],{"class":1148},[624,2426,1160],{"class":630},[624,2428,2429],{"class":653},"jobDuration",[624,2431,1160],{"class":630},[624,2433,799],{"class":630},[624,2435,1154],{"class":630},[624,2437,1736],{"class":653},[624,2439,1160],{"class":630},[624,2441,799],{"class":630},[624,2443,1154],{"class":630},[624,2445,1745],{"class":653},[624,2447,1160],{"class":630},[624,2449,1249],{"class":1148},[624,2451,659],{"class":630},[624,2453,2454],{"class":626,"line":820},[624,2455,987],{"class":630},[1107,2457,2459],{"id":2458},"what-v1-does-not-support","What v1 does not support",[1014,2461,2462,2475],{},[1017,2463,2464],{},[1020,2465,2466,2469,2472],{},[1023,2467,2468],{},"Need",[1023,2470,2471],{},"v1 answer",[1023,2473,2474],{},"Workaround",[1033,2476,2477,2496,2516,2533,2544],{},[1020,2478,2479,2485,2488],{},[1038,2480,2481,2482,1791],{},"New top-level field (",[621,2483,2484],{},"tenantId",[1038,2486,2487],{},"Not on the wire",[1038,2489,2490,2491,2493,2494],{},"Flat key in ",[621,2492,960],{}," + allowlist, or map server-side from ",[621,2495,936],{},[1020,2497,2498,2504,2507],{},[1038,2499,2500,2501,1791],{},"Nested objects (",[621,2502,2503],{},"custom.user.plan",[1038,2505,2506],{},"Flat records only",[1038,2508,2509,2510,2513,2514],{},"Flatten: ",[621,2511,2512],{},"userPlan: 'pro'"," with ",[621,2515,1066],{},[1020,2517,2518,2521,2524],{},[1038,2519,2520],{},"Free-form strings (paths, emails)",[1038,2522,2523],{},"Blocked by design",[1038,2525,2526,2527,2530,2531],{},"Flags record ",[621,2528,2529],{},"\"\u003Cset>\""," instead of the value; hash before ",[621,2532,1062],{},[1020,2534,2535,2538,2541],{},[1038,2536,2537],{},"Different schema per command",[1038,2539,2540],{},"One envelope per run",[1038,2542,2543],{},"Convention: only set relevant keys per command",[1020,2545,2546,2549,2552],{},[1038,2547,2548],{},"Transform before outbox",[1038,2550,2551],{},"No hook yet",[1038,2553,2554],{},"Map on the server (recommended) or see planned v2 below",[2556,2557,2558,2561,2562,2564,2565,1063,2567,2569],"tip",{},[996,2559,2560],{},"Rule of thumb:"," if it is safe to print in ",[621,2563,2303],{}," and fits a closed set or a number, it belongs in ",[621,2566,1104],{},[621,2568,960],{},". Everything else stays server-side.",[1107,2571,2573],{"id":2572},"planned-v2-extensions","Planned v2 extensions",[610,2575,2576],{},"Not shipped yet. These are design targets for when the v1 extension zones are not enough:",[610,2578,2579,2585],{},[996,2580,2581,2584],{},[621,2582,2583],{},"enrich"," hook."," Runs after sanitization, before the outbox append. Lets you inject computed fields without forking the package:",[614,2587,2589],{"className":1124,"code":2588,"language":1127,"meta":619,"style":619},"\u002F\u002F Planned API — not available in v1\ncreateTelemetry({\n  name: 'acme-cli',\n  version: '3.0.0',\n  collect: { fields: { product: ['cli', 'action'] } },\n  enrich(event) {\n    return {\n      ...event,\n      custom: {\n        ...event.custom,\n        schemaVersion: 2,\n      },\n    }\n  },\n})\n",[621,2590,2591,2596,2605,2619,2634,2676,2689,2696,2705,2714,2727,2738,2743,2748,2752],{"__ignoreMap":619},[624,2592,2593],{"class":626,"line":627},[624,2594,2595],{"class":921},"\u002F\u002F Planned API — not available in v1\n",[624,2597,2598,2601,2603],{"class":626,"line":634},[624,2599,2600],{"class":1134},"createTelemetry",[624,2602,1449],{"class":1138},[624,2604,631],{"class":630},[624,2606,2607,2609,2611,2613,2615,2617],{"class":626,"line":662},[624,2608,1149],{"class":1148},[624,2610,647],{"class":630},[624,2612,1154],{"class":630},[624,2614,1157],{"class":653},[624,2616,1160],{"class":630},[624,2618,659],{"class":630},[624,2620,2621,2623,2625,2627,2630,2632],{"class":626,"line":683},[624,2622,1167],{"class":1148},[624,2624,647],{"class":630},[624,2626,1154],{"class":630},[624,2628,2629],{"class":653},"3.0.0",[624,2631,1160],{"class":630},[624,2633,659],{"class":630},[624,2635,2636,2638,2640,2642,2645,2647,2649,2652,2654,2656,2658,2660,2662,2664,2666,2668,2670,2672,2674],{"class":626,"line":701},[624,2637,1199],{"class":1148},[624,2639,647],{"class":630},[624,2641,734],{"class":630},[624,2643,2644],{"class":1148}," fields",[624,2646,647],{"class":630},[624,2648,734],{"class":630},[624,2650,2651],{"class":1148}," product",[624,2653,647],{"class":630},[624,2655,1222],{"class":1138},[624,2657,1160],{"class":630},[624,2659,1308],{"class":653},[624,2661,1160],{"class":630},[624,2663,799],{"class":630},[624,2665,1154],{"class":630},[624,2667,1317],{"class":653},[624,2669,1160],{"class":630},[624,2671,1754],{"class":1138},[624,2673,1421],{"class":630},[624,2675,766],{"class":630},[624,2677,2678,2681,2683,2685,2687],{"class":626,"line":722},[624,2679,2680],{"class":1148},"  enrich",[624,2682,1449],{"class":630},[624,2684,641],{"class":1782},[624,2686,1791],{"class":630},[624,2688,832],{"class":630},[624,2690,2691,2694],{"class":626,"line":769},[624,2692,2693],{"class":1438},"    return",[624,2695,832],{"class":630},[624,2697,2698,2701,2703],{"class":626,"line":820},[624,2699,2700],{"class":630},"      ...",[624,2702,641],{"class":1138},[624,2704,659],{"class":630},[624,2706,2707,2710,2712],{"class":626,"line":835},[624,2708,2709],{"class":1148},"      custom",[624,2711,647],{"class":630},[624,2713,832],{"class":630},[624,2715,2716,2719,2721,2723,2725],{"class":626,"line":857},[624,2717,2718],{"class":630},"        ...",[624,2720,641],{"class":1138},[624,2722,1009],{"class":630},[624,2724,960],{"class":1138},[624,2726,659],{"class":630},[624,2728,2729,2732,2734,2736],{"class":626,"line":872},[624,2730,2731],{"class":1148},"        schemaVersion",[624,2733,647],{"class":630},[624,2735,1566],{"class":695},[624,2737,659],{"class":630},[624,2739,2740],{"class":626,"line":887},[624,2741,2742],{"class":630},"      },\n",[624,2744,2745],{"class":626,"line":902},[624,2746,2747],{"class":630},"    }\n",[624,2749,2750],{"class":626,"line":925},[624,2751,928],{"class":630},[624,2753,2754,2756],{"class":626,"line":931},[624,2755,1421],{"class":630},[624,2757,1424],{"class":1138},[610,2759,2760,2761,2763,2764,2766],{},"The hook cannot bypass sanitization rules, and strings still require ",[621,2762,1066],{},". Server-side ",[621,2765,2379],{}," stays the source of truth.",[610,2768,2769,2772,2773,2776,2777,1009],{},[996,2770,2771],{},"Namespaced keys."," An optional ",[621,2774,2775],{},"acme.product"," convention for multi-tool endpoints without prefix collisions. Would be documented in disclosure as ",[621,2778,2779],{},"acme.product: cli | action",[610,2781,2782,2783,2785],{},"If you need one of these before v2 lands, open a discussion on the repo. The v1 path (",[621,2784,960],{}," + server mapping) covers most product analytics needs.",[605,2787,2789],{"id":2788},"privacy","Privacy",[610,2791,2792,2793,2796,2797,2800],{},"Raw ",[621,2794,2795],{},"argv"," is never read. Sanitization applies to ",[996,2798,2799],{},"citty-parsed"," flags only:",[1074,2802,2803,2816,2830],{},[1077,2804,2805,2808,2809,2812,2813,1791],{},[996,2806,2807],{},"Booleans \u002F numbers"," → value stored (",[621,2810,2811],{},"json: true",", ",[621,2814,2815],{},"limit: 50",[1077,2817,2818,2821,2822,1082,2824,2827,2828],{},[996,2819,2820],{},"Strings"," → ",[621,2823,2529],{},[621,2825,2826],{},"output: \"\u003Cset>\"",") unless allowlisted in ",[621,2829,1047],{},[1077,2831,2832,2836,2837,2839],{},[996,2833,2834],{},[621,2835,1062],{}," → numbers and booleans always; strings only via ",[621,2838,1066],{}," (undeclared values are dropped at runtime, never thrown)",[614,2841,2843],{"className":1124,"code":2842,"filename":1126,"language":1127,"meta":619,"style":619},"collect: {\n  flags: { format: ['json', 'csv'] },           \u002F\u002F --format json → \"json\"; --format yaml → \"\u003Cset>\"\n  fields: { framework: ['nuxt', 'next'] },      \u002F\u002F telemetry.set({ framework: 'nuxt' }) ok\n}\n",[621,2844,2845,2853,2892,2929],{"__ignoreMap":619},[624,2846,2847,2849,2851],{"class":626,"line":627},[624,2848,1104],{"class":739},[624,2850,647],{"class":630},[624,2852,832],{"class":630},[624,2854,2855,2858,2860,2862,2865,2867,2869,2871,2873,2875,2877,2879,2882,2884,2886,2889],{"class":626,"line":634},[624,2856,2857],{"class":739},"  flags",[624,2859,647],{"class":630},[624,2861,734],{"class":630},[624,2863,2864],{"class":739}," format",[624,2866,647],{"class":630},[624,2868,1222],{"class":1148},[624,2870,1160],{"class":630},[624,2872,1227],{"class":653},[624,2874,1160],{"class":630},[624,2876,799],{"class":630},[624,2878,1154],{"class":630},[624,2880,2881],{"class":653},"csv",[624,2883,1160],{"class":630},[624,2885,1754],{"class":1148},[624,2887,2888],{"class":630},"},",[624,2890,2891],{"class":921},"           \u002F\u002F --format json → \"json\"; --format yaml → \"\u003Cset>\"\n",[624,2893,2894,2897,2899,2901,2904,2906,2908,2910,2912,2914,2916,2918,2920,2922,2924,2926],{"class":626,"line":662},[624,2895,2896],{"class":739},"  fields",[624,2898,647],{"class":630},[624,2900,734],{"class":630},[624,2902,2903],{"class":739}," framework",[624,2905,647],{"class":630},[624,2907,1222],{"class":1148},[624,2909,1160],{"class":630},[624,2911,1384],{"class":653},[624,2913,1160],{"class":630},[624,2915,799],{"class":630},[624,2917,1154],{"class":630},[624,2919,1393],{"class":653},[624,2921,1160],{"class":630},[624,2923,1754],{"class":1148},[624,2925,2888],{"class":630},[624,2927,2928],{"class":921},"      \u002F\u002F telemetry.set({ framework: 'nuxt' }) ok\n",[624,2930,2931],{"class":626,"line":683},[624,2932,987],{"class":630},[610,2934,2935,2936,2938],{},"Three kinds of parser noise are dropped before the event is built, so ",[621,2937,727],{}," reads\nas what the user asked for rather than what the parser filled in:",[1074,2940,2941,2951,2961],{},[1077,2942,2943,2946,2947,2950],{},[996,2944,2945],{},"Positionals",": citty's ",[621,2948,2949],{},"_"," bucket holds argument values, not flag names",[1077,2952,2953,2956,2957,2960],{},[996,2954,2955],{},"Defaults",": a flag still sitting at its declared ",[621,2958,2959],{},"default"," is not a choice anyone made",[1077,2962,2963,2966,2967,2970,2971,2974,2975,2978,2979,2981],{},[996,2964,2965],{},"Kebab-case duplicates",": ",[621,2968,2969],{},"--min-score"," arrives as both ",[621,2972,2973],{},"minScore"," and ",[621,2976,2977],{},"min-score","; only the camelCase name is kept, and that is the name ",[621,2980,1047],{}," allowlists",[610,2983,2984,2985,2988,2989,2992,2993,1009],{},"Negation still reports: ",[621,2986,2987],{},"--no-write"," against ",[621,2990,2991],{},"write: { default: true }"," records ",[621,2994,2995],{},"write: false",[610,2997,2998,2999,1117,3001,3003,3004,3006],{},"Declare allowlists in the same ",[621,3000,1116],{},[621,3002,1120],{}," call as ",[621,3005,1104],{},", with no separate config file.",[605,3008,3010],{"id":3009},"disclosure","Disclosure",[610,3012,3013,3016,3017,3019,3020,3022],{},[621,3014,3015],{},"generateDisclosure()"," produces markdown + JSON from the standard envelope plus your ",[621,3018,1104],{}," extensions. Commit the output (e.g. ",[621,3021,2303],{},") so it stays in sync with releases:",[614,3024,3027],{"className":1124,"code":3025,"filename":3026,"language":1127,"meta":619,"style":619},"import { writeFile } from 'node:fs\u002Fpromises'\nimport { generateDisclosure } from '@evlog\u002Ftelemetry'\n\nconst { markdown } = generateDisclosure('my-tool', {\n  flags: { format: ['json', 'csv'] },\n})\n\nawait writeFile('TELEMETRY.md', markdown)\n","scripts\u002Fgenerate-disclosure.ts",[621,3028,3029,3049,3068,3072,3099,3132,3138,3142],{"__ignoreMap":619},[624,3030,3031,3033,3035,3038,3040,3042,3044,3047],{"class":626,"line":627},[624,3032,1631],{"class":1438},[624,3034,734],{"class":630},[624,3036,3037],{"class":1138}," writeFile",[624,3039,1639],{"class":630},[624,3041,1642],{"class":1438},[624,3043,1154],{"class":630},[624,3045,3046],{"class":653},"node:fs\u002Fpromises",[624,3048,1650],{"class":630},[624,3050,3051,3053,3055,3058,3060,3062,3064,3066],{"class":626,"line":634},[624,3052,1631],{"class":1438},[624,3054,734],{"class":630},[624,3056,3057],{"class":1138}," generateDisclosure",[624,3059,1639],{"class":630},[624,3061,1642],{"class":1438},[624,3063,1154],{"class":630},[624,3065,1089],{"class":653},[624,3067,1650],{"class":630},[624,3069,3070],{"class":626,"line":662},[624,3071,1656],{"emptyLinePlaceholder":1655},[624,3073,3074,3076,3078,3081,3083,3085,3087,3089,3091,3093,3095,3097],{"class":626,"line":683},[624,3075,1661],{"class":640},[624,3077,734],{"class":630},[624,3079,3080],{"class":1138}," markdown ",[624,3082,1421],{"class":630},[624,3084,1480],{"class":630},[624,3086,3057],{"class":1134},[624,3088,1449],{"class":1138},[624,3090,1160],{"class":630},[624,3092,794],{"class":653},[624,3094,1160],{"class":630},[624,3096,799],{"class":630},[624,3098,832],{"class":630},[624,3100,3101,3103,3105,3107,3109,3111,3113,3115,3117,3119,3121,3123,3125,3127,3129],{"class":626,"line":701},[624,3102,2857],{"class":1148},[624,3104,647],{"class":630},[624,3106,734],{"class":630},[624,3108,2864],{"class":1148},[624,3110,647],{"class":630},[624,3112,1222],{"class":1138},[624,3114,1160],{"class":630},[624,3116,1227],{"class":653},[624,3118,1160],{"class":630},[624,3120,799],{"class":630},[624,3122,1154],{"class":630},[624,3124,2881],{"class":653},[624,3126,1160],{"class":630},[624,3128,1754],{"class":1138},[624,3130,3131],{"class":630},"},\n",[624,3133,3134,3136],{"class":626,"line":722},[624,3135,1421],{"class":630},[624,3137,1424],{"class":1138},[624,3139,3140],{"class":626,"line":769},[624,3141,1656],{"emptyLinePlaceholder":1655},[624,3143,3144,3146,3148,3150,3152,3154,3156,3158],{"class":626,"line":820},[624,3145,1439],{"class":1438},[624,3147,3037],{"class":1134},[624,3149,1449],{"class":1138},[624,3151,1160],{"class":630},[624,3153,2303],{"class":653},[624,3155,1160],{"class":630},[624,3157,799],{"class":630},[624,3159,3160],{"class":1138}," markdown)\n",[610,3162,3163,3164,3167,3168,1009],{},"Users can also read it at runtime via ",[621,3165,3166],{},"my-tool telemetry status"," when you wire ",[621,3169,3170],{},"defineTelemetryCommands()",[605,3172,3174],{"id":3173},"consent-and-reliability","Consent and reliability",[610,3176,3177,1600,3180,2821,3183,3186,3187,1117,3190,3193],{},[996,3178,3179],{},"Opt-out priority:",[621,3181,3182],{},"DO_NOT_TRACK=1",[621,3184,3185],{},"EVLOG_TELEMETRY=0"," → persisted preference (",[621,3188,3189],{},"disableTelemetry()",[621,3191,3192],{},"telemetry disable","). Opt-out purges the undelivered outbox.",[610,3195,3196,3199,3200,3203],{},[996,3197,3198],{},"Never harms the host:"," telemetry never throws, never blocks exit; ",[621,3201,3202],{},"flush()"," has a 500ms hard cap.",[610,3205,3206,3209,3210,1009],{},[996,3207,3208],{},"Outbox:"," events append locally before any network attempt. Offline machines and CI matrix jobs drain the backlog on the next invocation once your ingestion endpoint returns ",[621,3211,3212],{},"2xx",[610,3214,3215,1600,3218,3221,3222,3225],{},[996,3216,3217],{},"Endpoint:",[621,3219,3220],{},"EVLOG_TELEMETRY_ENDPOINT"," env → ",[621,3223,3224],{},"endpoint"," option baked into the CLI. Omit both during local development; ship the URL when your ingest handler is live.",[3227,3228,3229],"style",{},"html pre.shiki code .s2Zo4, html code.shiki .s2Zo4{--shiki-light:#6182B8;--shiki-default:#82AAFF;--shiki-dark:#82AAFF}html pre.shiki code .sTEyZ, html code.shiki .sTEyZ{--shiki-light:#90A4AE;--shiki-default:#EEFFFF;--shiki-dark:#BABED8}html pre.shiki code .sMK4o, html code.shiki .sMK4o{--shiki-light:#39ADB5;--shiki-default:#89DDFF;--shiki-dark:#89DDFF}html pre.shiki code .swJcz, html code.shiki .swJcz{--shiki-light:#E53935;--shiki-default:#F07178;--shiki-dark:#F07178}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);}html pre.shiki code .s7zQu, html code.shiki .s7zQu{--shiki-light:#39ADB5;--shiki-light-font-style:italic;--shiki-default:#89DDFF;--shiki-default-font-style:italic;--shiki-dark:#89DDFF;--shiki-dark-font-style:italic}html pre.shiki code .spNyl, html code.shiki .spNyl{--shiki-light:#9C3EDA;--shiki-default:#C792EA;--shiki-dark:#C792EA}html pre.shiki code .sHwdD, html code.shiki .sHwdD{--shiki-light:#90A4AE;--shiki-light-font-style:italic;--shiki-default:#546E7A;--shiki-default-font-style:italic;--shiki-dark:#676E95;--shiki-dark-font-style:italic}html pre.shiki code .sfNiH, html code.shiki .sfNiH{--shiki-light:#FF5370;--shiki-default:#FF9CAC;--shiki-dark:#FF9CAC}html pre.shiki code .sbssI, html code.shiki .sbssI{--shiki-light:#F76D47;--shiki-default:#F78C6C;--shiki-dark:#F78C6C}html pre.shiki code .sHdIc, html code.shiki .sHdIc{--shiki-light:#90A4AE;--shiki-light-font-style:italic;--shiki-default:#EEFFFF;--shiki-default-font-style:italic;--shiki-dark:#BABED8;--shiki-dark-font-style:italic}html pre.shiki code .sBMFI, html code.shiki .sBMFI{--shiki-light:#E2931D;--shiki-default:#FFCB6B;--shiki-dark:#FFCB6B}",{"title":619,"searchDepth":634,"depth":634,"links":3231},[3232,3233,3243,3244,3245],{"id":607,"depth":634,"text":608},{"id":990,"depth":634,"text":991,"children":3234},[3235,3236,3237,3238,3240,3241,3242],{"id":1109,"depth":662,"text":1110},{"id":1616,"depth":662,"text":1617},{"id":1901,"depth":662,"text":1902},{"id":2206,"depth":662,"text":3239},"Version breaking changes in custom",{"id":2310,"depth":662,"text":2311},{"id":2458,"depth":662,"text":2459},{"id":2572,"depth":662,"text":2573},{"id":2788,"depth":634,"text":2789},{"id":3009,"depth":634,"text":3010},{"id":3173,"depth":634,"text":3174},"RunEvent envelope, extending the schema with collect and custom fields, privacy rules, TELEMETRY.md disclosure, and consent \u002F outbox reliability.","md",[3249,3252,3253],{"label":41,"icon":44,"to":423,"color":3250,"variant":3251},"neutral","subtle",{"label":426,"icon":429,"to":427,"color":3250,"variant":3251},{"label":431,"icon":434,"to":432,"color":3250,"variant":3251},{},{"title":436,"icon":84},{"title":600,"description":3246},"9QIMa3arrtXM1ogwvMDBj2bkaTzJC1sft1nHE9vGiwU",[3259,3261],{"title":431,"path":432,"stem":433,"description":3260,"icon":434,"children":-1},"Build the ingestion endpoint for @evlog\u002Ftelemetry: the threat model, parseIngestBody validation, framework routes, storage, and rate limiting.",{"title":440,"path":441,"stem":442,"description":3262,"icon":443,"children":-1},"Add derived context to every wide event, from user agent and geo to your own computed fields.",1789076909580]