---
title: "Elysia"
description: "该插件会将 `log` 派生到每个路由上下文中，因此 Elysia 处理程序可以将其作为参数读取，并在响应完成时关闭广泛事件"
canonical_url: "https://evlog.zhcndoc.com/integrate/frameworks/elysia"
---
# Elysia

> 该插件会将 `log` 派生到每个路由上下文中，因此 Elysia 处理程序可以将其作为参数读取，并在响应完成时关闭广泛事件

`evlog/elysia` 插件会自动创建一个请求作用域的日志记录器，通过 `log` 在路由上下文和 `useLogger()` 中访问，并在响应完成时发出一个全量事件。

<prompt :actions="["copy","cursor","claude"]" description="在我的 Elysia 应用中设置 evlog" icon="i-custom-elysia">

在我的 Elysia 应用中设置 evlog。

- 安装 evlog：pnpm add evlog
- 创建 evlog.config.ts，其中包含 export default defineEvlog({ service: 'my-api' })
- 在启动时导入 evlog.config.ts，并调用 initLogger(toLoggerConfig(config))
- 从 'evlog/elysia' 导入 evlog，并将 .use(evlog(toMiddlewareOptions(config))) 添加到你的 Elysia 应用中
- 通过路由上下文解构中的 log 属性访问日志记录器
- 使用 'evlog/elysia' 中的 useLogger() 从任何位置访问日志记录器
- 将 drain、enrich、include 和 keep 放入 evlog.config.ts；toMiddlewareOptions(config) 会将它们传给 evlog()

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

::。

## 快速开始

### 1. 安装

<code-group>

```bash [pnpm]
pnpm add evlog elysia
```

```bash [bun]
bun add evlog elysia
```

```bash [yarn]
yarn add evlog elysia
```

```bash [npm]
npm install evlog elysia
```

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

initLogger(toLoggerConfig(config))

const app = new Elysia()
  .use(evlog(toMiddlewareOptions(config)))
  .get('/health', ({ log }) => {
    log.set({ route: 'health' })
    return { ok: true }
  })
  .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>

`log` 属性在所有路由处理程序中通过 Elysia 的 `derive` 自动可用。

## 广泛事件

通过在处理程序中逐步构建上下文。一个请求 = 一个广泛事件：

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

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

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

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

  return { user, orders }
})
```

所有字段在请求完成时合并为一个单一广泛事件并发出：

```bash [Terminal output]
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/elysia'

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

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

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

从路由上下文中使用 `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/elysia'

app
  .use(evlog())
  .post('/orders', ({ log }) => {
    log.fork!('ship', async () => {
      const l = useLogger()
      l.set({ shipped: true })
    })
    return { ok: true }
  })
```

## 错误处理

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

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

app
  .use(evlog())
  .get('/checkout', ({ log }) => {
    log.set({ cart: { items: 3, total: 9999 } })

    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',
    })
  })
  .onError(({ error, set }) => {
    const parsed = parseError(error)
    set.status = parsed.status
    return {
      message: parsed.message,
      why: parsed.why,
      fix: parsed.fix,
      link: parsed.link,
    }
  })
```

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

```bash [Terminal output]
14:58:20 ERROR [my-api] GET /checkout 402 in 3ms
  ├─ error: name=EvlogError message=Payment failed status=402
  ├─ cart: items=3 total=9999
  └─ requestId: 880a50ac-...
```

## 配置

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

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()`，以确保所有缓冲的事件都已发送。有关所有选项，请参阅[管道文档](https://evlog.zhcndoc.com/extend/drain-pipeline)。

</callout>

## 抽样

使用 `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` 从任何前端向 Elysia 服务器发送结构化日志。这适用于任何客户端框架（React、Vue、Svelte、vanilla 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', async ({ body }) => {
  const batch = body as DrainContext[]
  for (const ctx of batch) {
    console.log('[浏览器]', JSON.stringify(ctx.event))
  }
  return new Response(null, { status: 204 })
})
```

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

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

</callout>

## 本地运行

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

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

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

浏览完整的 Elysia 示例源代码。

</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>

---

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


## Sitemap

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