[{"data":1,"prerenderedAt":1315},["ShallowReactive",2],{"navigation_docs":3,"-libraries-testing":612,"-libraries-testing-surround":1310},[4,35,85,138,318,453,489,548,587],{"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,474,479,484],{"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":132},"Errors Agents Can Act On","\u002Flibraries\u002Fagents","6.libraries\u002F3.agents",{"title":475,"path":476,"stem":477,"icon":478},"Exporting the Catalog","\u002Flibraries\u002Fexporting","6.libraries\u002F4.exporting","i-lucide-file-output",{"title":480,"path":481,"stem":482,"icon":483},"Migrating","\u002Flibraries\u002Fmigrating","6.libraries\u002F5.migrating","i-lucide-route",{"title":485,"path":486,"stem":487,"icon":488},"Testing","\u002Flibraries\u002Ftesting","6.libraries\u002F6.testing","i-lucide-flask-conical",{"title":490,"path":491,"stem":492,"children":493,"page":34},"Extend","\u002Fextend","7.extend",[494,498,503,508,512,517,521,525,529,533,538,543],{"title":41,"path":495,"stem":496,"icon":497},"\u002Fextend\u002Foverview","7.extend\u002F0.overview","i-lucide-blocks",{"title":499,"path":500,"stem":501,"icon":502},"Stream","\u002Fextend\u002Fstream","7.extend\u002F1.stream","i-lucide-radio-tower",{"title":504,"path":505,"stem":506,"icon":507},"Custom framework","\u002Fextend\u002Fcustom-framework","7.extend\u002F10.custom-framework","i-lucide-puzzle",{"title":509,"path":510,"stem":511,"icon":502},"Diagnostics channel","\u002Fextend\u002Fdiagnostics-channel","7.extend\u002F11.diagnostics-channel",{"title":513,"path":514,"stem":515,"icon":516},"FS reader","\u002Fextend\u002Ffs-reader","7.extend\u002F2.fs-reader","i-lucide-folder-search",{"title":415,"path":518,"stem":519,"icon":520},"\u002Fextend\u002Fconsumer-recipes","7.extend\u002F3.consumer-recipes","i-lucide-chef-hat",{"title":522,"path":523,"stem":524,"icon":497},"Plugins","\u002Fextend\u002Fplugins","7.extend\u002F4.plugins",{"title":526,"path":527,"stem":528,"icon":443},"Custom enrichers","\u002Fextend\u002Fcustom-enrichers","7.extend\u002F5.custom-enrichers",{"title":530,"path":531,"stem":532,"icon":69},"Tail sampling","\u002Fextend\u002Ftail-sampling","7.extend\u002F6.tail-sampling",{"title":534,"path":535,"stem":536,"icon":537},"Identity headers","\u002Fextend\u002Fidentity-headers","7.extend\u002F7.identity-headers","i-lucide-fingerprint",{"title":539,"path":540,"stem":541,"icon":542},"Custom drains","\u002Fextend\u002Fcustom-drains","7.extend\u002F8.custom-drains","i-lucide-share-2",{"title":544,"path":545,"stem":546,"icon":547},"Drain pipeline","\u002Fextend\u002Fdrain-pipeline","7.extend\u002F9.drain-pipeline","i-lucide-workflow",{"title":436,"path":549,"stem":550,"children":551,"page":34},"\u002Freference","8.reference",[552,556,561,564,569,573,578,582],{"title":41,"path":553,"stem":554,"icon":555},"\u002Freference\u002Foverview","8.reference\u002F0.overview","i-lucide-book-marked",{"title":557,"path":558,"stem":559,"icon":560},"Configuration","\u002Freference\u002Fconfiguration","8.reference\u002F1.configuration","i-lucide-settings",{"title":383,"path":562,"stem":563,"icon":112},"\u002Freference\u002Fperformance","8.reference\u002F2.performance",{"title":565,"path":566,"stem":567,"icon":568},"Vite Plugin","\u002Freference\u002Fvite-plugin","8.reference\u002F3.vite-plugin","i-custom-vite",{"title":570,"path":571,"stem":572,"icon":388},"Best Practices","\u002Freference\u002Fbest-practices","8.reference\u002F4.best-practices",{"title":574,"path":575,"stem":576,"icon":577},"vs Other Loggers","\u002Freference\u002Fvs-other-loggers","8.reference\u002F5.vs-other-loggers","i-lucide-scale",{"title":579,"path":580,"stem":581,"icon":443},"Agent Skills","\u002Freference\u002Fagent-skills","8.reference\u002F6.agent-skills",{"title":583,"path":584,"stem":585,"icon":586},"Cost","\u002Freference\u002Fcost","8.reference\u002F7.cost","i-lucide-receipt",{"title":588,"path":589,"stem":590,"children":591,"page":34},"Compare","\u002Fcompare","9.compare",[592,596,600,604,608],{"title":593,"path":594,"stem":595,"icon":577},"evlog vs Pino","\u002Fcompare\u002Fpino","9.compare\u002F1.pino",{"title":597,"path":598,"stem":599,"icon":204},"evlog vs OpenTelemetry","\u002Fcompare\u002Fopentelemetry","9.compare\u002F2.opentelemetry",{"title":601,"path":602,"stem":603,"icon":577},"evlog vs LogTape","\u002Fcompare\u002Flogtape","9.compare\u002F3.logtape",{"title":605,"path":606,"stem":607,"icon":577},"evlog vs Winston: formats and request events","\u002Fcompare\u002Fwinston","9.compare\u002F4.winston",{"title":609,"path":610,"stem":611,"icon":577},"evlog vs Consola: reporters and request context","\u002Fcompare\u002Fconsola","9.compare\u002F5.consola",{"id":613,"title":485,"body":614,"description":1303,"extension":1304,"links":1305,"meta":1306,"navigation":1307,"path":486,"seo":1308,"stem":487,"__hash__":1309},"docs\u002F6.libraries\u002F6.testing.md",{"type":615,"value":616,"toc":1296},"minimark",[617,630,633,638,641,889,903,907,910,1126,1130,1137,1236,1243,1250,1254,1267,1271,1292],[618,619,620,621,625,626,629],"p",{},"The events your package emits are public behavior: a host filtering on your ",[622,623,624],"code",{},"source"," field, an agent matching on your error codes, or a support macro keyed on a ",[622,627,628],{},"fix"," string, all break when you rename them as surely as when you rename a function. Tests make that visible before the host does. This page covers the two ways to observe events in a test process, how to lock error codes down, and the one assertion that keeps the generated error reference current.",[618,631,632],{},"The test process is the host. Nothing about being a library changes the setup: you configure evlog the way an application would, because inside a test that is exactly what your code is.",[634,635,637],"h2",{"id":636},"collect-events-with-a-drain-function","Collect events with a drain function",[618,639,640],{},"A drain function runs synchronously when an event is emitted, so a plain array is enough:",[642,643,649],"pre",{"className":644,"code":645,"filename":646,"language":647,"meta":648,"style":648},"language-typescript shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","import { initLogger } from 'evlog'\nimport type { DrainContext, WideEvent } from 'evlog'\n\nconst events: WideEvent[] = []\n\nbeforeAll(() => {\n  initLogger({ drain: (ctx: DrainContext) => { events.push(ctx.event) } })\n})\n\n\u002F\u002F run the operation under test, then assert on the collected events\nexpect(events[0].source).toBe('mylib')\n","test\u002Fevents.test.ts","typescript","",[622,650,651,684,713,720,745,750,769,832,839,844,851],{"__ignoreMap":648},[652,653,656,660,664,668,671,674,677,681],"span",{"class":654,"line":655},"line",1,[652,657,659],{"class":658},"s7zQu","import",[652,661,663],{"class":662},"sMK4o"," {",[652,665,667],{"class":666},"sTEyZ"," initLogger",[652,669,670],{"class":662}," }",[652,672,673],{"class":658}," from",[652,675,676],{"class":662}," '",[652,678,680],{"class":679},"sfazB","evlog",[652,682,683],{"class":662},"'\n",[652,685,687,689,692,694,697,700,703,705,707,709,711],{"class":654,"line":686},2,[652,688,659],{"class":658},[652,690,691],{"class":658}," type",[652,693,663],{"class":662},[652,695,696],{"class":666}," DrainContext",[652,698,699],{"class":662},",",[652,701,702],{"class":666}," WideEvent",[652,704,670],{"class":662},[652,706,673],{"class":658},[652,708,676],{"class":662},[652,710,680],{"class":679},[652,712,683],{"class":662},[652,714,716],{"class":654,"line":715},3,[652,717,719],{"emptyLinePlaceholder":718},true,"\n",[652,721,723,727,730,733,736,739,742],{"class":654,"line":722},4,[652,724,726],{"class":725},"spNyl","const",[652,728,729],{"class":666}," events",[652,731,732],{"class":662},":",[652,734,702],{"class":735},"sBMFI",[652,737,738],{"class":666},"[] ",[652,740,741],{"class":662},"=",[652,743,744],{"class":666}," []\n",[652,746,748],{"class":654,"line":747},5,[652,749,719],{"emptyLinePlaceholder":718},[652,751,753,757,760,763,766],{"class":654,"line":752},6,[652,754,756],{"class":755},"s2Zo4","beforeAll",[652,758,759],{"class":666},"(",[652,761,762],{"class":662},"()",[652,764,765],{"class":725}," =>",[652,767,768],{"class":662}," {\n",[652,770,772,775,778,781,784,786,789,793,795,797,800,802,804,806,809,812,814,816,818,821,824,827,829],{"class":654,"line":771},7,[652,773,774],{"class":755},"  initLogger",[652,776,759],{"class":777},"swJcz",[652,779,780],{"class":662},"{",[652,782,783],{"class":755}," drain",[652,785,732],{"class":662},[652,787,788],{"class":662}," (",[652,790,792],{"class":791},"sHdIc","ctx",[652,794,732],{"class":662},[652,796,696],{"class":735},[652,798,799],{"class":662},")",[652,801,765],{"class":725},[652,803,663],{"class":662},[652,805,729],{"class":666},[652,807,808],{"class":662},".",[652,810,811],{"class":755},"push",[652,813,759],{"class":777},[652,815,792],{"class":666},[652,817,808],{"class":662},[652,819,820],{"class":666},"event",[652,822,823],{"class":777},") ",[652,825,826],{"class":662},"}",[652,828,670],{"class":662},[652,830,831],{"class":777},")\n",[652,833,835,837],{"class":654,"line":834},8,[652,836,826],{"class":662},[652,838,831],{"class":666},[652,840,842],{"class":654,"line":841},9,[652,843,719],{"emptyLinePlaceholder":718},[652,845,847],{"class":654,"line":846},10,[652,848,850],{"class":849},"sHwdD","\u002F\u002F run the operation under test, then assert on the collected events\n",[652,852,854,857,860,864,867,869,872,874,877,879,882,885,887],{"class":654,"line":853},11,[652,855,856],{"class":755},"expect",[652,858,859],{"class":666},"(events[",[652,861,863],{"class":862},"sbssI","0",[652,865,866],{"class":666},"]",[652,868,808],{"class":662},[652,870,871],{"class":666},"source)",[652,873,808],{"class":662},[652,875,876],{"class":755},"toBe",[652,878,759],{"class":666},[652,880,881],{"class":662},"'",[652,883,884],{"class":679},"mylib",[652,886,881],{"class":662},[652,888,831],{"class":666},[618,890,891,892,894,895,898,899,902],{},"Assert on the fields you promised the host: the ",[622,893,624],{},", the ",[622,896,897],{},"operation",", the domain fields you ",[622,900,901],{},"set",". Do not assert on console output; pretty printing is presentation, and the drained event is the contract.",[634,904,906],{"id":905},"inspect-events-with-the-memory-drain","Inspect events with the memory drain",[618,908,909],{},"The memory drain keeps events in a ring buffer you can read and clear, useful when an operation emits several events and you want them as a list:",[642,911,913],{"className":644,"code":912,"filename":646,"language":647,"meta":648,"style":648},"import { createMemoryDrain, readMemoryLogs } from 'evlog\u002Fmemory'\nimport { initLogger } from 'evlog'\n\nbeforeAll(() => {\n  initLogger({ drain: createMemoryDrain({ store: 'test' }) })\n})\n\n\u002F\u002F run the operation under test, then give the drain a tick:\n\u002F\u002F emit() hands events to the drain without awaiting it\nawait new Promise(resolve => setTimeout(resolve, 0))\n\nconst events = readMemoryLogs({ store: 'test', filter: e => e.source === 'mylib' })\n",[622,914,915,940,958,962,974,1012,1018,1022,1027,1032,1064,1068],{"__ignoreMap":648},[652,916,917,919,921,924,926,929,931,933,935,938],{"class":654,"line":655},[652,918,659],{"class":658},[652,920,663],{"class":662},[652,922,923],{"class":666}," createMemoryDrain",[652,925,699],{"class":662},[652,927,928],{"class":666}," readMemoryLogs",[652,930,670],{"class":662},[652,932,673],{"class":658},[652,934,676],{"class":662},[652,936,937],{"class":679},"evlog\u002Fmemory",[652,939,683],{"class":662},[652,941,942,944,946,948,950,952,954,956],{"class":654,"line":686},[652,943,659],{"class":658},[652,945,663],{"class":662},[652,947,667],{"class":666},[652,949,670],{"class":662},[652,951,673],{"class":658},[652,953,676],{"class":662},[652,955,680],{"class":679},[652,957,683],{"class":662},[652,959,960],{"class":654,"line":715},[652,961,719],{"emptyLinePlaceholder":718},[652,963,964,966,968,970,972],{"class":654,"line":722},[652,965,756],{"class":755},[652,967,759],{"class":666},[652,969,762],{"class":662},[652,971,765],{"class":725},[652,973,768],{"class":662},[652,975,976,978,980,982,984,986,988,990,992,995,997,999,1002,1004,1006,1008,1010],{"class":654,"line":747},[652,977,774],{"class":755},[652,979,759],{"class":777},[652,981,780],{"class":662},[652,983,783],{"class":777},[652,985,732],{"class":662},[652,987,923],{"class":755},[652,989,759],{"class":777},[652,991,780],{"class":662},[652,993,994],{"class":777}," store",[652,996,732],{"class":662},[652,998,676],{"class":662},[652,1000,1001],{"class":679},"test",[652,1003,881],{"class":662},[652,1005,670],{"class":662},[652,1007,823],{"class":777},[652,1009,826],{"class":662},[652,1011,831],{"class":777},[652,1013,1014,1016],{"class":654,"line":752},[652,1015,826],{"class":662},[652,1017,831],{"class":666},[652,1019,1020],{"class":654,"line":771},[652,1021,719],{"emptyLinePlaceholder":718},[652,1023,1024],{"class":654,"line":834},[652,1025,1026],{"class":849},"\u002F\u002F run the operation under test, then give the drain a tick:\n",[652,1028,1029],{"class":654,"line":841},[652,1030,1031],{"class":849},"\u002F\u002F emit() hands events to the drain without awaiting it\n",[652,1033,1034,1037,1040,1043,1045,1048,1050,1053,1056,1058,1061],{"class":654,"line":846},[652,1035,1036],{"class":658},"await",[652,1038,1039],{"class":662}," new",[652,1041,1042],{"class":735}," Promise",[652,1044,759],{"class":666},[652,1046,1047],{"class":791},"resolve",[652,1049,765],{"class":725},[652,1051,1052],{"class":755}," setTimeout",[652,1054,1055],{"class":666},"(resolve",[652,1057,699],{"class":662},[652,1059,1060],{"class":862}," 0",[652,1062,1063],{"class":666},"))\n",[652,1065,1066],{"class":654,"line":853},[652,1067,719],{"emptyLinePlaceholder":718},[652,1069,1071,1073,1076,1078,1080,1082,1084,1086,1088,1090,1092,1094,1096,1099,1101,1104,1106,1108,1110,1113,1116,1118,1120,1122,1124],{"class":654,"line":1070},12,[652,1072,726],{"class":725},[652,1074,1075],{"class":666}," events ",[652,1077,741],{"class":662},[652,1079,928],{"class":755},[652,1081,759],{"class":666},[652,1083,780],{"class":662},[652,1085,994],{"class":777},[652,1087,732],{"class":662},[652,1089,676],{"class":662},[652,1091,1001],{"class":679},[652,1093,881],{"class":662},[652,1095,699],{"class":662},[652,1097,1098],{"class":755}," filter",[652,1100,732],{"class":662},[652,1102,1103],{"class":791}," e",[652,1105,765],{"class":725},[652,1107,1103],{"class":666},[652,1109,808],{"class":662},[652,1111,1112],{"class":666},"source ",[652,1114,1115],{"class":662},"===",[652,1117,676],{"class":662},[652,1119,884],{"class":679},[652,1121,881],{"class":662},[652,1123,670],{"class":662},[652,1125,831],{"class":666},[634,1127,1129],{"id":1128},"lock-error-codes-down","Lock error codes down",[618,1131,1132,1133,1136],{},"Catalog errors are wire format (see ",[1134,1135,56],"a",{"href":468},"), so assert through the factory rather than a string literal. A rename then fails in your test suite instead of in a host's alert or an agent's prompt:",[642,1138,1141],{"className":644,"code":1139,"filename":1140,"language":647,"meta":648,"style":648},"import { errors } from '..\u002Fsrc\u002Ferrors'\n\n\u002F\u002F in the test asserting throw behavior:\nexpect(() => charge(-5)).toThrow()\nexpect(errors.INSUFFICIENT_FUNDS.code).toBe('mylib.INSUFFICIENT_FUNDS')\n","test\u002Ferrors.test.ts",[622,1142,1143,1163,1167,1172,1204],{"__ignoreMap":648},[652,1144,1145,1147,1149,1152,1154,1156,1158,1161],{"class":654,"line":655},[652,1146,659],{"class":658},[652,1148,663],{"class":662},[652,1150,1151],{"class":666}," errors",[652,1153,670],{"class":662},[652,1155,673],{"class":658},[652,1157,676],{"class":662},[652,1159,1160],{"class":679},"..\u002Fsrc\u002Ferrors",[652,1162,683],{"class":662},[652,1164,1165],{"class":654,"line":686},[652,1166,719],{"emptyLinePlaceholder":718},[652,1168,1169],{"class":654,"line":715},[652,1170,1171],{"class":849},"\u002F\u002F in the test asserting throw behavior:\n",[652,1173,1174,1176,1178,1180,1182,1185,1187,1190,1193,1196,1198,1201],{"class":654,"line":722},[652,1175,856],{"class":755},[652,1177,759],{"class":666},[652,1179,762],{"class":662},[652,1181,765],{"class":725},[652,1183,1184],{"class":755}," charge",[652,1186,759],{"class":666},[652,1188,1189],{"class":662},"-",[652,1191,1192],{"class":862},"5",[652,1194,1195],{"class":666},"))",[652,1197,808],{"class":662},[652,1199,1200],{"class":755},"toThrow",[652,1202,1203],{"class":666},"()\n",[652,1205,1206,1208,1211,1213,1216,1218,1221,1223,1225,1227,1229,1232,1234],{"class":654,"line":747},[652,1207,856],{"class":755},[652,1209,1210],{"class":666},"(errors",[652,1212,808],{"class":662},[652,1214,1215],{"class":666},"INSUFFICIENT_FUNDS",[652,1217,808],{"class":662},[652,1219,1220],{"class":666},"code)",[652,1222,808],{"class":662},[652,1224,876],{"class":755},[652,1226,759],{"class":666},[652,1228,881],{"class":662},[652,1230,1231],{"class":679},"mylib.INSUFFICIENT_FUNDS",[652,1233,881],{"class":662},[652,1235,831],{"class":666},[618,1237,1238,1239,1242],{},"The string literal lives in one line, and it states the wire format your package promised. If you delete or rename the catalog entry, the test stops compiling at ",[622,1240,1241],{},"errors.INSUFFICIENT_FUNDS",", which is the point.",[618,1244,1245,1246,1249],{},"For emitted events carrying an error, the code lands in the event the same way, so the same assertion works against a collected event's ",[622,1247,1248],{},"error"," tree.",[634,1251,1253],{"id":1252},"keep-the-generated-reference-in-sync","Keep the generated reference in sync",[618,1255,1256,1257,1259,1260,1262,1263,1266],{},"If you generate an error reference from the catalog, the committed file drifts the first time someone edits a ",[622,1258,628],{}," and forgets to rebuild. One test closes that gap: regenerate in memory and compare to what is on disk. ",[1134,1261,475],{"href":476}," has the script and the test; the assertion is ",[622,1264,1265],{},"expect(committed).toBe(toMarkdown(readCatalog()))",", and it fails in the pull request that changed the sentence instead of in a consumer's session a week later.",[634,1268,1270],{"id":1269},"what-sampling-does-to-your-tests","What sampling does to your tests",[618,1272,1273,1274,1277,1278,1281,1282,1285,1286,1288,1289,1291],{},"The test host configures sampling like any host. Defaults keep everything (",[622,1275,1276],{},"minLevel: 'debug'",", no rates), so events arrive. If a test seems to lose events, check whether an earlier test in the same process called ",[622,1279,1280],{},"initLogger()"," with rates or ",[622,1283,1284],{},"enabled: false",": configuration is process-wide and the last call wins, which is the same mechanism ",[1134,1287,463],{"href":464}," warns library code about. ",[1134,1290,66],{"href":67}," documents what a real host can do to your events, including dropping them entirely.",[1293,1294,1295],"style",{},"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 .sMK4o, html code.shiki .sMK4o{--shiki-light:#39ADB5;--shiki-default:#89DDFF;--shiki-dark:#89DDFF}html pre.shiki code .sTEyZ, html code.shiki .sTEyZ{--shiki-light:#90A4AE;--shiki-default:#EEFFFF;--shiki-dark:#BABED8}html pre.shiki code .sfazB, html code.shiki .sfazB{--shiki-light:#91B859;--shiki-default:#C3E88D;--shiki-dark:#C3E88D}html pre.shiki code .spNyl, html code.shiki .spNyl{--shiki-light:#9C3EDA;--shiki-default:#C792EA;--shiki-dark:#C792EA}html pre.shiki code .sBMFI, html code.shiki .sBMFI{--shiki-light:#E2931D;--shiki-default:#FFCB6B;--shiki-dark:#FFCB6B}html pre.shiki code .s2Zo4, html code.shiki .s2Zo4{--shiki-light:#6182B8;--shiki-default:#82AAFF;--shiki-dark:#82AAFF}html pre.shiki code .swJcz, html code.shiki .swJcz{--shiki-light:#E53935;--shiki-default:#F07178;--shiki-dark:#F07178}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 .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 .sbssI, html code.shiki .sbssI{--shiki-light:#F76D47;--shiki-default:#F78C6C;--shiki-dark:#F78C6C}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":648,"searchDepth":686,"depth":686,"links":1297},[1298,1299,1300,1301,1302],{"id":636,"depth":686,"text":637},{"id":905,"depth":686,"text":906},{"id":1128,"depth":686,"text":1129},{"id":1252,"depth":686,"text":1253},{"id":1269,"depth":686,"text":1270},"Test the events your package emits and the errors it throws: a collecting drain, the memory drain, and factory codes that fail on rename.","md",null,{},{"title":485,"icon":488},{"title":485,"description":1303},"GGQw4zc4unLCd5iBgZRZ8VaQetwnaUf3v7b3HVH8vek",[1311,1313],{"title":480,"path":481,"stem":482,"description":1312,"icon":483,"children":-1},"Convert a package with dozens of bare throws to an evlog catalog in five ordered steps, without a breaking release and without a big-bang rewrite.",{"title":41,"path":495,"stem":496,"description":1314,"icon":497,"children":-1},"Observe what flows through the pipeline, plug into it, or build your own bricks. The map of every extension point evlog exposes.",1789294040108]