框架
Express
在 Express 应用中自动创建请求范围的日志记录器，发射宽事件、结构化错误、排水适配器和增强器，并进行尾部采样。
evlog/express 中间件会在 req.log 上自动创建一个请求范围的日志记录器，并在响应结束时发射一个宽事件。
提示
在 Express 应用中设置 evlog：
- 安装 evlog：pnpm add evlog
- 启动时调用 initLogger({ env: { service: 'my-api' } })
- 或者在 vite.config.ts 中使用 evlog/vite 插件进行自动初始化（替换 initLogger）
- 从 'evlog/express' 导入中间件并添加 app.use(evlog())
- 在路由中通过 req.log 访问日志记录器，或在调用栈任意位置使用 useLogger()
- 使用 log.set() 积累上下文，使用 throw createError() 抛出结构化错误
- 可选地向 evlog() 传递 drain、enrich、include 和 keep 选项
文档：https://www.evlog.dev/frameworks/express
适配器：https://www.evlog.dev/adapters
快速开始
1. 安装
终端
bun add evlog express
2. 初始化并注册中间件
src/index.ts
import express from 'express'
import { initLogger } from 'evlog'
import { evlog } from 'evlog/express'
initLogger({
env: { service: 'my-api' },
})
const app = express()
app.use(evlog())
app.get('/health', (req, res) => {
req.log.set({ route: 'health' })
res.json({ ok: true })
})
app.listen(3000)
日志记录器通过模块增强在所有地方都可通过 req.log 获得完整的 TypeScript 支持，因此无需额外的类型注解。
宽事件
在处理函数中逐步构建上下文。一个请求 = 一个宽事件：
src/index.ts
app.get('/users/:id', async (req, res) => {
const userId = req.params.id
req.log.set({ user: { id: userId } })
const user = await db.findUser(userId)
req.log.set({ user: { name: user.name, plan: user.plan } })
const orders = await db.findOrders(userId)
req.log.set({ orders: { count: orders.length, totalRevenue: sum(orders) } })
res.json({ user, orders })
})
所有字段会在响应结束时合并为一个宽事件并发出：
终端输出
14:58:15 INFO [my-api] GET /users/usr_123 200 in 12ms
├─ orders: count=2 totalRevenue=6298
├─ user: id=usr_123 name=Alice plan=pro
└─ requestId: 4a8ff3a8-...
useLogger()
使用 useLogger() 可以从调用栈中的任何位置访问请求范围的日志记录器，而无需将 req 传递到服务层：
src/services/user.ts
import { useLogger } from 'evlog/express'
export async function findUser(id: string) {
const log = useLogger()
log.set({ user: { id } })
const user = await db.findUser(id)
log.set({ user: { name: user.name, plan: user.plan } })
return user
}
src/index.ts
import { findUser } from './services/user'
app.get('/users/:id', async (req, res) => {
const user = await findUser(req.params.id)
res.json(user)
})
req.log 和 useLogger() 返回相同的日志记录器实例。useLogger() 使用 AsyncLocalStorage 在异步边界之间传播日志记录器。
错误处理
使用 createError 创建包含 why、fix 和 link 字段的结构化错误。Express 使用 4 个参数的错误处理中间件：
src/index.ts
import { createError, parseError } from 'evlog'
app.get('/checkout', () => {
throw createError({
message: 'Payment failed',
status: 402,
why: 'Card declined by issuer',
fix: 'Try a different payment method',
link: 'https://docs.example.com/payments/declined',
})
})
app.use((err, req, res, next) => {
req.log.error(err)
const parsed = parseError(err)
res.status(parsed.status).json({
message: parsed.message,
why: parsed.why,
fix: parsed.fix,
link: parsed.link,
})
})
错误会被捕获并记录，同时包含自定义上下文和结构化错误字段：
终端输出
14:58:20 ERROR [my-api] GET /checkout 402 in 3ms
├─ error: name=EvlogError message=Payment failed status=402
└─ requestId: 880a50ac-...
配置
请参阅 配置参考 获取所有可用选项（initLogger、中间件选项、采样、静默模式等）。
排水与增强器
在middleware选项中直接配置排水适配器和增强器：
src/index.ts
import { createAxiomDrain } from 'evlog/axiom'
import { createUserAgentEnricher } from 'evlog/enrichers'
const userAgent = createUserAgentEnricher()
app.use(evlog({
drain: createAxiomDrain(),
enrich: (ctx) => {
userAgent(ctx)
ctx.event.region = process.env.FLY_REGION
},
}))
管道（批处理与重试）
对于生产环境，使用 createDrainPipeline 包装适配器以批量发送事件并在失败时重试：
src/index.ts
import type { DrainContext } from 'evlog'
import { createAxiomDrain } from 'evlog/axiom'
import { createDrainPipeline } from 'evlog/pipeline'
const pipeline = createDrainPipeline<DrainContext>({
batch: { size: 50, intervalMs: 5000 },
retry: { maxAttempts: 3 },
})
const drain = pipeline(createAxiomDrain())
app.use(evlog({ drain }))
在服务器关闭时调用
drain.flush() 以确保所有缓冲事件都已发送。参见 管道文档 了解所有选项。尾部采样
使用 keep 强制保留特定事件，无论头部采样如何：
src/index.ts
app.use(evlog({
drain: createAxiomDrain(),
keep: (ctx) => {
if (ctx.duration && ctx.duration > 2000) ctx.shouldKeep = true
},
}))
路由过滤
使用 include 和 exclude 控制记录哪些路由：
src/index.ts
app.use(evlog({
include: ['/api/**'],
exclude: ['/_internal/**', '/health'],
routes: {
'/api/auth/**': { service: 'auth-service' },
'/api/payment/**': { service: 'payment-service' },
},
}))
客户端日志记录
使用 evlog/http 从任何前端向 Express 服务器发送结构化日志。这适用于任何客户端框架（React、Vue、Svelte、原生 JS）。
浏览器设置
client.ts
import { initLogger, log } from 'evlog'
import { createHttpLogDrain } from 'evlog/http'
const drain = createHttpLogDrain({
drain: { endpoint: '/v1/ingest' },
})
initLogger({ drain })
log.info({ action: 'page_view', path: location.pathname })
摄入端点
添加一个 POST 路由接收来自浏览器的批量 DrainContext[]：
src/index.ts
import type { DrainContext } from 'evlog'
app.post('/v1/ingest', express.json(), (req, res) => {
const batch = req.body as DrainContext[]
for (const ctx of batch) {
console.log('[BROWSER]', JSON.stringify(ctx.event))
}
res.sendStatus(204)
})
请参阅完整的 HTTP 排水适配器文档，了解批处理、重试、sendBeacon 回退和身份验证选项。
本地运行
终端
git clone https://github.com/hugorcd/evlog.git
cd evlog
bun install
bun run example:express
打开 http://localhost:3000 探索交互式测试 UI。
下一步
深入你的 Express 集成：