---
title: "Express"
description: "一个 `app.use(evlog())` 就能将请求日志记录器放到 `req.log` 上，在响应结束时发射宽事件，并将其传递给你的错误处理器。"
canonical_url: "https://evlog.zhcndoc.com/integrate/frameworks/express"
---
# Express

> 一个 `app.use(evlog())` 就能将请求日志记录器放到 `req.log` 上，在响应结束时发射宽事件，并将其传递给你的错误处理器。

`evlog/express` 中间件会在 `req.log` 上自动创建一个请求范围的日志记录器，并在响应结束时发射一个宽事件。

<prompt :actions="["copy","cursor","claude"]" description="在我的 Express 应用中设置 evlog" icon="i-simple-icons-express">

在我的 Express 应用中设置 evlog。

- 安装 evlog：pnpm add evlog
- 创建 evlog.config.ts，其中包含 export default defineEvlog({ service: 'my-api' })
- 在启动时导入 evlog.config.ts，并调用 initLogger(toLoggerConfig(config))
- 从 'evlog/express' 导入中间件并添加 app.use(evlog(toMiddlewareOptions(config)))
- 在路由中通过 req.log 访问日志记录器，或在调用栈任意位置使用 useLogger()
- 使用 log.set() 积累上下文，使用 throw createError() 抛出结构化错误
- 将 drain、enrich、include 和 keep 放入 evlog.config.ts；toMiddlewareOptions(config) 会将它们传给 evlog()

文档：[https://www.evlog.dev/integrate/frameworks/express](https://www.evlog.dev/integrate/frameworks/express)
适配器：[https://www.evlog.dev/integrate/adapters/overview](https://www.evlog.dev/integrate/adapters/overview)

</prompt>

## 快速开始

### 1. 安装

<code-group>

```bash [pnpm]
pnpm add evlog express
```

```bash [bun]
bun add evlog express
```

```bash [yarn]
yarn add evlog express
```

```bash [npm]
npm install evlog express
```

</code-group>

### 2. 创建 evlog.config.ts

```typescript [evlog.config.ts]
import { defineEvlog } from 'evlog'

export default defineEvlog({
  service: 'my-api',
})
```

所有选项都位于此文件中：采样、drain、`enrich` 和路由过滤器。`npx evlog init` 会为你写入它，以及下方的接入代码。请参阅[配置](https://evlog.zhcndoc.com/reference/configuration)。

### 3. 初始化并注册中间件

```typescript [src/index.ts]
import express from 'express'
import { initLogger, toLoggerConfig, toMiddlewareOptions } from 'evlog'
import { evlog } from 'evlog/express'
import config from '../evlog.config'

initLogger(toLoggerConfig(config))

const app = express()

app.use(evlog(toMiddlewareOptions(config)))

app.get('/health', (req, res) => {
  req.log.set({ route: 'health' })
  res.json({ ok: true })
})

app.listen(3000)
```

<callout color="info" icon="i-custom-vite">

**使用 Vite？** [`evlog/vite` 插件](https://evlog.zhcndoc.com/reference/vite-plugin) 会从生产构建中移除 `log.debug()`，并注入源代码位置。它不会读取 `evlog.config.ts`，因此保留 `initLogger(toLoggerConfig(config))` 调用：该调用会在插件自动初始化后运行，并替代它。

</callout>

日志记录器通过模块增强在所有地方都可通过 `req.log` 获得完整的 TypeScript 支持，因此无需额外的类型注解。

## 宽事件

在处理函数中逐步构建上下文。一个请求 = 一个宽事件：

```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 })
})
```

所有字段会在响应结束时合并为一个宽事件并发出：

```bash [终端输出]
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` 传递到服务层：

```typescript [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
}
```

```typescript [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` 在异步边界之间传播日志记录器。

## 后台工作（`log.fork`）

在响应结束后才完成的即发即弃异步工作无法再更新请求宽事件（日志记录器会在发出事件后被封存）。使用 **req.log.fork(label, fn)**，这样 `fn` 内部的 `useLogger()` 就会指向分叉出的日志记录器，该日志记录器会发出包含 `operation` 和 `_parentRequestId` 的独立事件。请参见宽事件中的[事件发出后](https://evlog.zhcndoc.com/learn/wide-events#after-emit-sealing-and-background-work)。

```typescript [src/index.ts]
import { evlog, useLogger } from 'evlog/express'

app.use(evlog())

app.post('/orders', (req, res) => {
  req.log.set({ orderId: 'ord_1' })
  req.log.fork!('fulfill_order', async () => {
    const log = useLogger()
    log.set({ step: 'inventory_ok' })
  })
  res.json({ ok: true })
})
```

## 错误处理

使用 `createError` 创建包含 `why`、`fix` 和 `link` 字段的结构化错误。Express 使用 4 个参数的错误处理中间件：

```typescript [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,
  })
})
```

错误会被捕获并记录，同时包含自定义上下文和结构化错误字段：

```bash [终端输出]
14:58:20 ERROR [my-api] GET /checkout 402 in 3ms
  ├─ error: name=EvlogError message=Payment failed status=402
  └─ requestId: 880a50ac-...
```

## 配置

有关所有可用选项（`initLogger`、中间件选项、采样、静默模式等），请参见 [配置参考](https://evlog.zhcndoc.com/reference/configuration)。所有选项都位于 `evlog.config.ts` 中。

## 排水与增强器

在 `evlog.config.ts` 中设置 `drain` 和 `enrich`，它们会通过 `toMiddlewareOptions(config)` 到达应用。也可以直接传入 middleware 选项；内联键会替换文件中的同名键，而不是与其合并：

```typescript [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` 包装适配器以批量发送事件并在失败时重试：

```typescript [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 }))
```

<callout color="info" icon="i-lucide-info">

在服务器关闭时调用 `drain.flush()` 以确保所有缓冲事件都已发送。有关所有选项，请参见 [Pipeline 文档](https://evlog.zhcndoc.com/extend/drain-pipeline)。
:::

## 尾部采样

使用 `keep` 强制保留特定事件，无论头部采样如何：

```typescript [src/index.ts]
app.use(evlog({
  drain: createAxiomDrain(),
  keep: (ctx) => {
    if (ctx.duration && ctx.duration > 2000) ctx.shouldKeep = true
  },
}))
```

## 路由过滤

使用 `include` 和 `exclude` 控制记录哪些路由：

```typescript [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）。

### 浏览器设置

```typescript [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[]`：

```typescript [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)
})
```

<callout color="neutral" icon="i-lucide-globe">

有关批处理、重试、sendBeacon 回退和身份验证选项，请参见完整的 [HTTP drain](https://evlog.zhcndoc.com/extend/drain-pipeline#http-drain-browser-to-server) 适配器文档。
:::

## 本地运行

```bash [Terminal]
git clone https://github.com/evloghq/evlog.git
cd evlog
pnpm install
pnpm example express
```

打开 [http://localhost:3000](http://localhost:3000) 探索交互式测试 UI。

<card-group>
<card icon="i-simple-icons-github" title="源代码" to="https://github.com/evloghq/evlog/tree/main/examples/express">

浏览 GitHub 上的完整 Express 示例源代码。

</card>

:::

## 下一步

深入你的 **Express** 集成：

- [宽事件](https://evlog.zhcndoc.com/learn/wide-events)：使用上下文分层设计完整事件
- [适配器](https://evlog.zhcndoc.com/integrate/adapters/overview)：将日志发送到 Axiom、Sentry、PostHog 等
- [采样](https://evlog.zhcndoc.com/learn/sampling)：使用头部和尾部采样控制日志量
- [结构化错误](https://evlog.zhcndoc.com/learn/structured-errors)：抛出包含 `why`、`fix` 和 `link` 字段的错误。

</card-group>
</callout>
</callout>

---

- [源代码](https://github.com/evloghq/evlog/tree/main/examples/express)


## Sitemap

See the full [sitemap](https://evlog.zhcndoc.com/sitemap.md) for all pages.