---
title: "Fastify"
description: "该插件会在 `request.log` 上覆盖 Fastify 内置的 pino 日志记录器，并从 onRequest、onResponse 和 onError hook 发出一个宽事件"
canonical_url: "https://evlog.zhcndoc.com/integrate/frameworks/fastify"
---
# Fastify

> 该插件会在 `request.log` 上覆盖 Fastify 内置的 pino 日志记录器，并从 onRequest、onResponse 和 onError hook 发出一个宽事件

`evlog/fastify` 插件会自动创建一个请求范围的日志记录器，可通过 `request.log` 和 `useLogger()` 访问，并在响应完成时触发宽事件。

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

在我的 Fastify 应用中设置 evlog。

- 安装 evlog：pnpm add evlog
- 创建 evlog.config.ts，其中包含 export default defineEvlog({ service: 'my-api' })
- 在启动时导入 evlog.config.ts，并调用 initLogger(toLoggerConfig(config))
- 在应用中注册 evlog：import evlog from 'evlog/fastify' 并使用 app.register(evlog, toMiddlewareOptions(config))
- 在路由处理程序中通过 request.log 访问日志记录器，或在任何地方使用 useLogger()
- 使用 log.set() 在请求过程中累积上下文
- 将 drain、enrich、include 和 keep 放入 evlog.config.ts；注册时传入 toMiddlewareOptions(config)

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

::。

## 快速开始

### 1. 安装

<code-group>

```bash [pnpm]
pnpm add evlog fastify
```

```bash [bun]
bun add evlog fastify
```

```bash [yarn]
yarn add evlog fastify
```

```bash [npm]
npm install evlog fastify
```

</code-group>
</prompt>

### 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 Fastify from 'fastify'
import { initLogger, toLoggerConfig, toMiddlewareOptions } from 'evlog'
import { evlog } from 'evlog/fastify'
import config from '../evlog.config'

initLogger(toLoggerConfig(config))

const app = Fastify({ logger: false })

await app.register(evlog, toMiddlewareOptions(config))

app.get('/health', async (request) => {
  request.log.set({ route: 'health' })
  return { ok: true }
})

await app.listen({ port: 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>

`request.log` 是 evlog 的宽事件日志记录器，会覆盖请求对象上的 Fastify 内置 pino 日志记录器。pino 日志记录器仍可通过 `fastify.log` 在服务器级别访问，用于结构化日志记录。

## 宽事件

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

```typescript [src/index.ts]
app.get('/users/:id', async (request) => {
  const { id } = request.params as { id: string }

  request.log.set({ user: { id } })

  const user = await db.findUser(id)
  request.log.set({ user: { name: user.name, plan: user.plan } })

  const orders = await db.findOrders(id)
  request.log.set({ orders: { count: orders.length, totalRevenue: sum(orders) } })

  return { 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()` 可以从调用栈中的任何位置访问请求范围的日志记录器，而无需将请求对象传递到服务层：

```typescript [src/services/user.ts]
import { useLogger } from 'evlog/fastify'

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 (request) => {
  const { id } = request.params as { id: string }
  const user = await findUser(id)
  return user
})
```

`request.log` 和 `useLogger()` 返回相同的日志记录器实例。`useLogger()` 使用 `AsyncLocalStorage` 在异步边界之间传播日志记录器。

## 后台工作 (`log.fork`)

使用 `request.log.fork(label, fn)` 执行应在响应之后发出一个**单独**的子宽事件的异步工作。请参阅宽事件中的[发出之后](https://evlog.zhcndoc.com/learn/wide-events#after-emit-sealing-and-background-work)。

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

app.post('/orders', async (request, reply) => {
  request.log.fork!('fulfill', async () => {
    const log = useLogger()
    log.set({ step: 'ok' })
  })
  return { ok: true }
})
```

## 错误处理

使用 `createError` 创建包含 `why`、`fix` 和 `link` 字段的结构化错误。Fastify 通过 `onError` 捕获抛出的错误：

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

app.get('/checkout', async (_request, reply) => {
  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.setErrorHandler((error, _request, reply) => {
  const parsed = parseError(error)
  reply.status(parsed.status).send({
    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-...
```

## 配置

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

## 排水与增强器

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

```typescript [src/index.ts]
import { createAxiomDrain } from 'evlog/axiom'
import { createUserAgentEnricher } from 'evlog/enrichers'

const userAgent = createUserAgentEnricher()

await app.register(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())

await app.register(evlog, { drain })
```

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

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

## 尾部采样

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

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

## 路由过滤

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

```typescript [src/index.ts]
await app.register(evlog, {
  include: ['/api/**'],
  exclude: ['/_internal/**', '/health'],
  routes: {
    '/api/auth/**': { service: 'auth-service' },
    '/api/payment/**': { service: 'payment-service' },
  },
})
```

## 本地运行

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

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

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

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

</card>

::。

## 下一步

- [宽事件](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>

---

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


## Sitemap

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