[{"data":1,"prerenderedAt":1542},["ShallowReactive",2],{"navigation_docs":3,"-use-cases-audit-schema":576,"-use-cases-audit-schema-surround":1537},[4,35,85,138,318,453,512,551],{"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},"Extend","\u002Fextend","6.extend",[458,462,467,472,476,481,485,489,493,497,502,507],{"title":41,"path":459,"stem":460,"icon":461},"\u002Fextend\u002Foverview","6.extend\u002F0.overview","i-lucide-blocks",{"title":463,"path":464,"stem":465,"icon":466},"Stream","\u002Fextend\u002Fstream","6.extend\u002F1.stream","i-lucide-radio-tower",{"title":468,"path":469,"stem":470,"icon":471},"Custom framework","\u002Fextend\u002Fcustom-framework","6.extend\u002F10.custom-framework","i-lucide-puzzle",{"title":473,"path":474,"stem":475,"icon":466},"Diagnostics channel","\u002Fextend\u002Fdiagnostics-channel","6.extend\u002F11.diagnostics-channel",{"title":477,"path":478,"stem":479,"icon":480},"FS reader","\u002Fextend\u002Ffs-reader","6.extend\u002F2.fs-reader","i-lucide-folder-search",{"title":415,"path":482,"stem":483,"icon":484},"\u002Fextend\u002Fconsumer-recipes","6.extend\u002F3.consumer-recipes","i-lucide-chef-hat",{"title":486,"path":487,"stem":488,"icon":461},"Plugins","\u002Fextend\u002Fplugins","6.extend\u002F4.plugins",{"title":490,"path":491,"stem":492,"icon":443},"Custom enrichers","\u002Fextend\u002Fcustom-enrichers","6.extend\u002F5.custom-enrichers",{"title":494,"path":495,"stem":496,"icon":69},"Tail sampling","\u002Fextend\u002Ftail-sampling","6.extend\u002F6.tail-sampling",{"title":498,"path":499,"stem":500,"icon":501},"Identity headers","\u002Fextend\u002Fidentity-headers","6.extend\u002F7.identity-headers","i-lucide-fingerprint",{"title":503,"path":504,"stem":505,"icon":506},"Custom drains","\u002Fextend\u002Fcustom-drains","6.extend\u002F8.custom-drains","i-lucide-share-2",{"title":508,"path":509,"stem":510,"icon":511},"Drain pipeline","\u002Fextend\u002Fdrain-pipeline","6.extend\u002F9.drain-pipeline","i-lucide-workflow",{"title":436,"path":513,"stem":514,"children":515,"page":34},"\u002Freference","7.reference",[516,520,525,528,533,537,542,546],{"title":41,"path":517,"stem":518,"icon":519},"\u002Freference\u002Foverview","7.reference\u002F0.overview","i-lucide-book-marked",{"title":521,"path":522,"stem":523,"icon":524},"Configuration","\u002Freference\u002Fconfiguration","7.reference\u002F1.configuration","i-lucide-settings",{"title":383,"path":526,"stem":527,"icon":112},"\u002Freference\u002Fperformance","7.reference\u002F2.performance",{"title":529,"path":530,"stem":531,"icon":532},"Vite Plugin","\u002Freference\u002Fvite-plugin","7.reference\u002F3.vite-plugin","i-custom-vite",{"title":534,"path":535,"stem":536,"icon":388},"Best Practices","\u002Freference\u002Fbest-practices","7.reference\u002F4.best-practices",{"title":538,"path":539,"stem":540,"icon":541},"vs Other Loggers","\u002Freference\u002Fvs-other-loggers","7.reference\u002F5.vs-other-loggers","i-lucide-scale",{"title":543,"path":544,"stem":545,"icon":443},"Agent Skills","\u002Freference\u002Fagent-skills","7.reference\u002F6.agent-skills",{"title":547,"path":548,"stem":549,"icon":550},"Cost","\u002Freference\u002Fcost","7.reference\u002F7.cost","i-lucide-receipt",{"title":552,"path":553,"stem":554,"children":555,"page":34},"Compare","\u002Fcompare","8.compare",[556,560,564,568,572],{"title":557,"path":558,"stem":559,"icon":541},"evlog vs Pino","\u002Fcompare\u002Fpino","8.compare\u002F1.pino",{"title":561,"path":562,"stem":563,"icon":204},"evlog vs OpenTelemetry","\u002Fcompare\u002Fopentelemetry","8.compare\u002F2.opentelemetry",{"title":565,"path":566,"stem":567,"icon":541},"evlog vs LogTape","\u002Fcompare\u002Flogtape","8.compare\u002F3.logtape",{"title":569,"path":570,"stem":571,"icon":541},"evlog vs Winston: formats and request events","\u002Fcompare\u002Fwinston","8.compare\u002F4.winston",{"title":573,"path":574,"stem":575,"icon":541},"evlog vs Consola: reporters and request context","\u002Fcompare\u002Fconsola","8.compare\u002F5.consola",{"id":577,"title":578,"body":579,"description":1526,"extension":1527,"links":1528,"meta":1533,"navigation":1534,"path":397,"seo":1535,"stem":398,"__hash__":1536},"docs\u002F5.use-cases\u002F4.audit\u002F02.schema.md","Audit Schema",{"type":580,"value":581,"toc":1517},"minimark",[582,594,602,1091,1095,1133,1136,1248,1266,1270,1292,1367,1371,1417,1429,1433,1451,1454,1458,1500,1513],[583,584,585,589,590,593],"p",{},[586,587,588],"code",{},"event.audit"," is a typed field on every wide event. Downstream queries filter on ",[586,591,592],{},"audit IS NOT NULL"," to materialise an audit dataset out of regular logs.",[595,596,598,601],"h2",{"id":597},"auditfields-type",[586,599,600],{},"AuditFields"," type",[603,604,605],"code-collapse",{},[606,607,612],"pre",{"className":608,"code":609,"language":610,"meta":611,"style":611},"language-typescript shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","interface AuditFields {\n  action: string                          \u002F\u002F 'invoice.refund'\n  actor: {\n    type: 'user' | 'system' | 'api' | 'agent'\n    id: string\n    displayName?: string\n    email?: string\n    \u002F\u002F For type === 'agent', mirrors evlog\u002Fai fields:\n    model?: string\n    tools?: string[]\n    reason?: string\n    promptId?: string\n  }\n  target?: { type: string, id: string, [k: string]: unknown }\n  outcome: 'success' | 'failure' | 'denied'\n  reason?: string\n  changes?: { before?: unknown, after?: unknown, patch?: AuditPatchOp[] }\n  causationId?: string                    \u002F\u002F ID of the action that caused this one\n  correlationId?: string                  \u002F\u002F Shared by every action in one operation\n  version?: number                        \u002F\u002F Defaults to 1\n  idempotencyKey?: string                 \u002F\u002F Auto-derived; safe retries across drains\n  context?: {                             \u002F\u002F Filled by auditEnricher\n    requestId?: string\n    traceId?: string\n    ip?: string\n    userAgent?: string\n    tenantId?: string\n  }\n  signature?: string                      \u002F\u002F Set by signed({ strategy: 'hmac' })\n  prevHash?: string                       \u002F\u002F Set by signed({ strategy: 'hash-chain' })\n  hash?: string\n}\n","typescript","",[586,613,614,631,648,658,705,716,727,737,743,753,767,777,787,793,844,877,887,929,942,955,969,982,995,1005,1015,1025,1035,1045,1050,1063,1076,1086],{"__ignoreMap":611},[615,616,619,623,627],"span",{"class":617,"line":618},"line",1,[615,620,622],{"class":621},"spNyl","interface",[615,624,626],{"class":625},"sBMFI"," AuditFields",[615,628,630],{"class":629},"sMK4o"," {\n",[615,632,634,638,641,644],{"class":617,"line":633},2,[615,635,637],{"class":636},"swJcz","  action",[615,639,640],{"class":629},":",[615,642,643],{"class":625}," string",[615,645,647],{"class":646},"sHwdD","                          \u002F\u002F 'invoice.refund'\n",[615,649,651,654,656],{"class":617,"line":650},3,[615,652,653],{"class":636},"  actor",[615,655,640],{"class":629},[615,657,630],{"class":629},[615,659,661,664,666,669,673,676,679,681,684,686,688,690,693,695,697,699,702],{"class":617,"line":660},4,[615,662,663],{"class":636},"    type",[615,665,640],{"class":629},[615,667,668],{"class":629}," '",[615,670,672],{"class":671},"sfazB","user",[615,674,675],{"class":629},"'",[615,677,678],{"class":629}," |",[615,680,668],{"class":629},[615,682,683],{"class":671},"system",[615,685,675],{"class":629},[615,687,678],{"class":629},[615,689,668],{"class":629},[615,691,692],{"class":671},"api",[615,694,675],{"class":629},[615,696,678],{"class":629},[615,698,668],{"class":629},[615,700,701],{"class":671},"agent",[615,703,704],{"class":629},"'\n",[615,706,708,711,713],{"class":617,"line":707},5,[615,709,710],{"class":636},"    id",[615,712,640],{"class":629},[615,714,715],{"class":625}," string\n",[615,717,719,722,725],{"class":617,"line":718},6,[615,720,721],{"class":636},"    displayName",[615,723,724],{"class":629},"?:",[615,726,715],{"class":625},[615,728,730,733,735],{"class":617,"line":729},7,[615,731,732],{"class":636},"    email",[615,734,724],{"class":629},[615,736,715],{"class":625},[615,738,740],{"class":617,"line":739},8,[615,741,742],{"class":646},"    \u002F\u002F For type === 'agent', mirrors evlog\u002Fai fields:\n",[615,744,746,749,751],{"class":617,"line":745},9,[615,747,748],{"class":636},"    model",[615,750,724],{"class":629},[615,752,715],{"class":625},[615,754,756,759,761,763],{"class":617,"line":755},10,[615,757,758],{"class":636},"    tools",[615,760,724],{"class":629},[615,762,643],{"class":625},[615,764,766],{"class":765},"sTEyZ","[]\n",[615,768,770,773,775],{"class":617,"line":769},11,[615,771,772],{"class":636},"    reason",[615,774,724],{"class":629},[615,776,715],{"class":625},[615,778,780,783,785],{"class":617,"line":779},12,[615,781,782],{"class":636},"    promptId",[615,784,724],{"class":629},[615,786,715],{"class":625},[615,788,790],{"class":617,"line":789},13,[615,791,792],{"class":629},"  }\n",[615,794,796,799,801,804,806,808,810,813,816,818,820,822,825,829,831,833,836,838,841],{"class":617,"line":795},14,[615,797,798],{"class":636},"  target",[615,800,724],{"class":629},[615,802,803],{"class":629}," {",[615,805,601],{"class":636},[615,807,640],{"class":629},[615,809,643],{"class":625},[615,811,812],{"class":629},",",[615,814,815],{"class":636}," id",[615,817,640],{"class":629},[615,819,643],{"class":625},[615,821,812],{"class":629},[615,823,824],{"class":765}," [",[615,826,828],{"class":827},"sHdIc","k",[615,830,640],{"class":629},[615,832,643],{"class":625},[615,834,835],{"class":765},"]",[615,837,640],{"class":629},[615,839,840],{"class":625}," unknown",[615,842,843],{"class":629}," }\n",[615,845,847,850,852,854,857,859,861,863,866,868,870,872,875],{"class":617,"line":846},15,[615,848,849],{"class":636},"  outcome",[615,851,640],{"class":629},[615,853,668],{"class":629},[615,855,856],{"class":671},"success",[615,858,675],{"class":629},[615,860,678],{"class":629},[615,862,668],{"class":629},[615,864,865],{"class":671},"failure",[615,867,675],{"class":629},[615,869,678],{"class":629},[615,871,668],{"class":629},[615,873,874],{"class":671},"denied",[615,876,704],{"class":629},[615,878,880,883,885],{"class":617,"line":879},16,[615,881,882],{"class":636},"  reason",[615,884,724],{"class":629},[615,886,715],{"class":625},[615,888,890,893,895,897,900,902,904,906,909,911,913,915,918,920,923,926],{"class":617,"line":889},17,[615,891,892],{"class":636},"  changes",[615,894,724],{"class":629},[615,896,803],{"class":629},[615,898,899],{"class":636}," before",[615,901,724],{"class":629},[615,903,840],{"class":625},[615,905,812],{"class":629},[615,907,908],{"class":636}," after",[615,910,724],{"class":629},[615,912,840],{"class":625},[615,914,812],{"class":629},[615,916,917],{"class":636}," patch",[615,919,724],{"class":629},[615,921,922],{"class":625}," AuditPatchOp",[615,924,925],{"class":765},"[] ",[615,927,928],{"class":629},"}\n",[615,930,932,935,937,939],{"class":617,"line":931},18,[615,933,934],{"class":636},"  causationId",[615,936,724],{"class":629},[615,938,643],{"class":625},[615,940,941],{"class":646},"                    \u002F\u002F ID of the action that caused this one\n",[615,943,945,948,950,952],{"class":617,"line":944},19,[615,946,947],{"class":636},"  correlationId",[615,949,724],{"class":629},[615,951,643],{"class":625},[615,953,954],{"class":646},"                  \u002F\u002F Shared by every action in one operation\n",[615,956,958,961,963,966],{"class":617,"line":957},20,[615,959,960],{"class":636},"  version",[615,962,724],{"class":629},[615,964,965],{"class":625}," number",[615,967,968],{"class":646},"                        \u002F\u002F Defaults to 1\n",[615,970,972,975,977,979],{"class":617,"line":971},21,[615,973,974],{"class":636},"  idempotencyKey",[615,976,724],{"class":629},[615,978,643],{"class":625},[615,980,981],{"class":646},"                 \u002F\u002F Auto-derived; safe retries across drains\n",[615,983,985,988,990,992],{"class":617,"line":984},22,[615,986,987],{"class":636},"  context",[615,989,724],{"class":629},[615,991,803],{"class":629},[615,993,994],{"class":646},"                             \u002F\u002F Filled by auditEnricher\n",[615,996,998,1001,1003],{"class":617,"line":997},23,[615,999,1000],{"class":636},"    requestId",[615,1002,724],{"class":629},[615,1004,715],{"class":625},[615,1006,1008,1011,1013],{"class":617,"line":1007},24,[615,1009,1010],{"class":636},"    traceId",[615,1012,724],{"class":629},[615,1014,715],{"class":625},[615,1016,1018,1021,1023],{"class":617,"line":1017},25,[615,1019,1020],{"class":636},"    ip",[615,1022,724],{"class":629},[615,1024,715],{"class":625},[615,1026,1028,1031,1033],{"class":617,"line":1027},26,[615,1029,1030],{"class":636},"    userAgent",[615,1032,724],{"class":629},[615,1034,715],{"class":625},[615,1036,1038,1041,1043],{"class":617,"line":1037},27,[615,1039,1040],{"class":636},"    tenantId",[615,1042,724],{"class":629},[615,1044,715],{"class":625},[615,1046,1048],{"class":617,"line":1047},28,[615,1049,792],{"class":629},[615,1051,1053,1056,1058,1060],{"class":617,"line":1052},29,[615,1054,1055],{"class":636},"  signature",[615,1057,724],{"class":629},[615,1059,643],{"class":625},[615,1061,1062],{"class":646},"                      \u002F\u002F Set by signed({ strategy: 'hmac' })\n",[615,1064,1066,1069,1071,1073],{"class":617,"line":1065},30,[615,1067,1068],{"class":636},"  prevHash",[615,1070,724],{"class":629},[615,1072,643],{"class":625},[615,1074,1075],{"class":646},"                       \u002F\u002F Set by signed({ strategy: 'hash-chain' })\n",[615,1077,1079,1082,1084],{"class":617,"line":1078},31,[615,1080,1081],{"class":636},"  hash",[615,1083,724],{"class":629},[615,1085,715],{"class":625},[615,1087,1089],{"class":617,"line":1088},32,[615,1090,928],{"class":629},[595,1092,1094],{"id":1093},"action-naming","Action naming",[1096,1097,1098,1106,1107,1110,1111,1114,1115,1114,1118,1121,1122,1125,1126,1129,1130,1132],"tip",{},[1099,1100,1101,1102,1105],"strong",{},"Naming convention for ",[586,1103,1104],{},"action","."," Use ",[586,1108,1109],{},"noun.verb"," (",[586,1112,1113],{},"invoice.refund",", ",[586,1116,1117],{},"user.invite",[586,1119,1120],{},"apiKey.revoke","). Past tense if the action already happened (",[586,1123,1124],{},"invoice.refunded","), present tense if ",[586,1127,1128],{},"withAudit()"," will resolve the outcome. Keep a small fixed dictionary in one file, because auditors and SIEM rules query on ",[586,1131,1104],{},", so a typo is a missing alert.",[583,1134,1135],{},"A single dictionary file makes alerting straightforward:",[606,1137,1140],{"className":608,"code":1138,"filename":1139,"language":610,"meta":611,"style":611},"export const AUDIT_ACTIONS = {\n  USER_INVITE: 'user.invite',\n  USER_REMOVE: 'user.remove',\n  USER_ROLE_CHANGE: 'user.role-change',\n  INVOICE_REFUND: 'invoice.refund',\n  API_KEY_REVOKE: 'apiKey.revoke',\n} as const\n","src\u002Faudit\u002Factions.ts",[586,1141,1142,1159,1175,1191,1207,1222,1237],{"__ignoreMap":611},[615,1143,1144,1148,1151,1154,1157],{"class":617,"line":618},[615,1145,1147],{"class":1146},"s7zQu","export",[615,1149,1150],{"class":621}," const",[615,1152,1153],{"class":765}," AUDIT_ACTIONS ",[615,1155,1156],{"class":629},"=",[615,1158,630],{"class":629},[615,1160,1161,1164,1166,1168,1170,1172],{"class":617,"line":633},[615,1162,1163],{"class":636},"  USER_INVITE",[615,1165,640],{"class":629},[615,1167,668],{"class":629},[615,1169,1117],{"class":671},[615,1171,675],{"class":629},[615,1173,1174],{"class":629},",\n",[615,1176,1177,1180,1182,1184,1187,1189],{"class":617,"line":650},[615,1178,1179],{"class":636},"  USER_REMOVE",[615,1181,640],{"class":629},[615,1183,668],{"class":629},[615,1185,1186],{"class":671},"user.remove",[615,1188,675],{"class":629},[615,1190,1174],{"class":629},[615,1192,1193,1196,1198,1200,1203,1205],{"class":617,"line":660},[615,1194,1195],{"class":636},"  USER_ROLE_CHANGE",[615,1197,640],{"class":629},[615,1199,668],{"class":629},[615,1201,1202],{"class":671},"user.role-change",[615,1204,675],{"class":629},[615,1206,1174],{"class":629},[615,1208,1209,1212,1214,1216,1218,1220],{"class":617,"line":707},[615,1210,1211],{"class":636},"  INVOICE_REFUND",[615,1213,640],{"class":629},[615,1215,668],{"class":629},[615,1217,1113],{"class":671},[615,1219,675],{"class":629},[615,1221,1174],{"class":629},[615,1223,1224,1227,1229,1231,1233,1235],{"class":617,"line":718},[615,1225,1226],{"class":636},"  API_KEY_REVOKE",[615,1228,640],{"class":629},[615,1230,668],{"class":629},[615,1232,1120],{"class":671},[615,1234,675],{"class":629},[615,1236,1174],{"class":629},[615,1238,1239,1242,1245],{"class":617,"line":729},[615,1240,1241],{"class":629},"}",[615,1243,1244],{"class":1146}," as",[615,1246,1247],{"class":621}," const\n",[1096,1249,1250,1251,1258,1259,1261,1262,1265],{},"For more than a handful of actions, prefer ",[1252,1253,1255],"a",{"href":1254},"\u002Fuse-cases\u002Faudit\u002Frecording#defineauditcatalog",[586,1256,1257],{},"defineAuditCatalog"," over a plain object dictionary: same ",[586,1260,1109],{}," convention, but you get autocomplete on the action union and per-entry ",[586,1263,1264],{},"target"," type inference for free.",[595,1267,1269],{"id":1268},"say-who-acted","Say who acted",[1271,1272,1273,1106,1276,1279,1280,1283,1284,1287,1288,1291],"warning",{},[1099,1274,1275],{},"Don't fake the actor.",[586,1277,1278],{},"actor.type: 'system'"," for cron jobs, queue workers, and background tasks; ",[586,1281,1282],{},"actor.type: 'api'"," for machine-to-machine calls authenticated by a token; ",[586,1285,1286],{},"actor.type: 'agent'"," for AI tool calls. Logging a synthetic ",[586,1289,1290],{},"'user'"," for system actions is the single fastest way to fail an audit review.",[1293,1294,1295,1310],"table",{},[1296,1297,1298],"thead",{},[1299,1300,1301,1307],"tr",{},[1302,1303,1304],"th",{},[586,1305,1306],{},"actor.type",[1302,1308,1309],{},"When to use",[1311,1312,1313,1323,1333,1343],"tbody",{},[1299,1314,1315,1320],{},[1316,1317,1318],"td",{},[586,1319,1290],{},[1316,1321,1322],{},"A human authenticated through your normal auth flow.",[1299,1324,1325,1330],{},[1316,1326,1327],{},[586,1328,1329],{},"'system'",[1316,1331,1332],{},"Cron jobs, queue workers, scheduled tasks, internal background processes.",[1299,1334,1335,1340],{},[1316,1336,1337],{},[586,1338,1339],{},"'api'",[1316,1341,1342],{},"Machine-to-machine calls from another service authenticated by a token.",[1299,1344,1345,1350],{},[1316,1346,1347],{},[586,1348,1349],{},"'agent'",[1316,1351,1352,1353,1356,1357,1114,1360,1114,1363,1366],{},"AI tool calls (combine with ",[586,1354,1355],{},"evlog\u002Fai"," fields like ",[586,1358,1359],{},"model",[586,1361,1362],{},"tools",[586,1364,1365],{},"promptId",").",[595,1368,1370],{"id":1369},"record-how-it-ended","Record how it ended",[1293,1372,1373,1385],{},[1296,1374,1375],{},[1299,1376,1377,1382],{},[1302,1378,1379],{},[586,1380,1381],{},"outcome",[1302,1383,1384],{},"Meaning",[1311,1386,1387,1397,1407],{},[1299,1388,1389,1394],{},[1316,1390,1391],{},[586,1392,1393],{},"'success'",[1316,1395,1396],{},"The action completed as requested.",[1299,1398,1399,1404],{},[1316,1400,1401],{},[586,1402,1403],{},"'failure'",[1316,1405,1406],{},"The action was attempted but failed (downstream error, race condition, etc.).",[1299,1408,1409,1414],{},[1316,1410,1411],{},[586,1412,1413],{},"'denied'",[1316,1415,1416],{},"The action was rejected by an authorisation check.",[583,1418,1419,1421,1422,1424,1425,1366],{},[586,1420,1403],{}," and ",[586,1423,1413],{}," are different things, and auditors care a lot about denied actions because they signal probing or misconfigured access controls. Always log denials (see ",[1252,1426,1428],{"href":1427},"\u002Fuse-cases\u002Faudit\u002Frecording#logauditdeny","Recording Events",[595,1430,1432],{"id":1431},"make-a-retry-safe","Make a retry safe",[583,1434,1435,1438,1439,1114,1441,1114,1444,1446,1447,1450],{},[586,1436,1437],{},"idempotencyKey"," is auto-derived from a hash of ",[586,1440,1104],{},[586,1442,1443],{},"actor.id",[586,1445,1264],{},", and a coarse timestamp. The result: even if your drain retries an audit insert across a network blip, the duplicate row collapses on ",[586,1448,1449],{},"ON CONFLICT DO NOTHING",". You don't have to think about it, since it is filled in for you.",[583,1452,1453],{},"Use the field as the primary key in Postgres \u002F Bigtable \u002F DynamoDB so retries stay safe by construction.",[595,1455,1457],{"id":1456},"tie-an-action-to-what-caused-it","Tie an action to what caused it",[1293,1459,1460,1470],{},[1296,1461,1462],{},[1299,1463,1464,1467],{},[1302,1465,1466],{},"Field",[1302,1468,1469],{},"Use case",[1311,1471,1472,1486],{},[1299,1473,1474,1479],{},[1316,1475,1476],{},[586,1477,1478],{},"correlationId",[1316,1480,1481,1482,1485],{},"Shared by every audit event that belongs to the ",[1099,1483,1484],{},"same operation"," (e.g. one HTTP request that triggers a refund + an email + a webhook).",[1299,1487,1488,1493],{},[1316,1489,1490],{},[586,1491,1492],{},"causationId",[1316,1494,1495,1496,1499],{},"The id of the previous audit event that ",[1099,1497,1498],{},"caused"," this one. Useful for reconstructing chains of cascading actions.",[583,1501,1502,1503,1505,1506,1509,1510,1512],{},"Most teams set ",[586,1504,1478],{}," to ",[586,1507,1508],{},"requestId",". ",[586,1511,1492],{}," is opt-in and only worth filling when a single user action triggers many internal audit events.",[1514,1515,1516],"style",{},"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 .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 .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 .sfazB, html code.shiki .sfazB{--shiki-light:#91B859;--shiki-default:#C3E88D;--shiki-dark:#C3E88D}html pre.shiki code .sTEyZ, html code.shiki .sTEyZ{--shiki-light:#90A4AE;--shiki-default:#EEFFFF;--shiki-dark:#BABED8}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 .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}",{"title":611,"searchDepth":633,"depth":633,"links":1518},[1519,1521,1522,1523,1524,1525],{"id":597,"depth":633,"text":1520},"AuditFields type",{"id":1093,"depth":633,"text":1094},{"id":1268,"depth":633,"text":1269},{"id":1369,"depth":633,"text":1370},{"id":1431,"depth":633,"text":1432},{"id":1456,"depth":633,"text":1457},"The AuditFields type, action naming conventions, actor types, idempotency, and how the schema sits inside a regular wide event.","md",[1529,1532],{"label":41,"icon":44,"to":393,"color":1530,"variant":1531},"neutral","subtle",{"label":401,"icon":404,"to":402,"color":1530,"variant":1531},{},{"title":396,"icon":399},{"title":578,"description":1526},"qMN68PYOStVtO3s6sZ9UquPo4gsWyOhiAznEvy1QKik",[1538,1540],{"title":41,"path":393,"stem":394,"description":1539,"icon":44,"children":-1},"Audit logs as a thin layer over wide events. A tamper-evident trail from one enricher, one drain wrapper, and one helper.",{"title":401,"path":402,"stem":403,"description":1541,"icon":404,"children":-1},"log.audit and log.audit.deny, standalone audit(), withAudit, the defineAuditAction and defineAuditCatalog registries, and auditDiff.",1790280235744]