框架
Astro
在 Astro 服务器中间件中实现广泛的事件和结构化错误。
Astro 没有专门的 evlog 集成。相反,可以在 Astro 中间件中使用核心 evlog 包手动创建请求作用域的日志记录器。
提示
在 Astro 应用中设置 evlog:
- 安装 evlog:pnpm add evlog
- 从 'evlog' 导入 initLogger 和 createRequestLogger
- 在 Astro 中间件中调用 initLogger({ env: { service: 'my-app' } })
- 为每个请求使用 createRequestLogger({ method, path }) 创建请求日志记录器
- 在 API 路由和中间件中使用 log.set() 来累积上下文
- 在返回响应前调用 log.emit()(没有自动的 emit 生命周期)
文档:https://www.evlog.dev/frameworks/astro
适配器:https://www.evlog.dev/adapters
这是一个指南级别的集成。它使用通用的
createRequestLogger API,而不是框架特定的模块。快速开始
1. 安装
终端
bun add evlog
2. 创建中间件
src/middleware.ts
import { defineMiddleware } from 'astro:middleware'
import { initLogger, createRequestLogger } from 'evlog'
initLogger({
env: { service: 'my-astro-app' },
})
export const onRequest = defineMiddleware(async ({ request, locals }, next) => {
const url = new URL(request.url)
const log = createRequestLogger({
method: request.method,
path: url.pathname,
})
locals.log = log
try {
const response = await next()
log.emit()
return response
} catch (error) {
log.error(error instanceof Error ? error : new Error(String(error)))
log.emit()
throw error
}
})
3. 定义 locals 类型
src/env.d.ts
/// <reference types="astro/client" />
import type { RequestLogger } from 'evlog'
declare namespace App {
interface Locals {
log: RequestLogger
}
}
广泛事件
在页面和 API 路由中从 Astro.locals 访问日志记录器:
src/pages/api/users/[id].ts
import type { APIRoute } from 'astro'
export const GET: APIRoute = async ({ params, locals }) => {
locals.log.set({ user: { id: params.id } })
const user = await db.findUser(params.id)
locals.log.set({ user: { name: user.name, plan: user.plan } })
return new Response(JSON.stringify(user), {
headers: { 'Content-Type': 'application/json' },
})
}
终端输出
14:58:15 INFO [my-astro-app] GET /api/users/usr_123
├─ user: id=usr_123 name=Alice plan=pro
└─ requestId: 4a8ff3a8-...
错误处理
使用 createError 创建结构化错误:
src/pages/api/checkout.ts
import type { APIRoute } from 'astro'
import { createError, parseError } from 'evlog'
export const POST: APIRoute = async ({ request, locals }) => {
const body = await request.json()
locals.log.set({ cart: { items: body.items } })
if (!body.paymentMethod) {
const error = createError({
status: 400,
message: 'Missing payment method',
why: 'No payment method was provided',
fix: 'Include a paymentMethod field in the request body',
})
locals.log.error(error)
const parsed = parseError(error)
return new Response(JSON.stringify(parsed), { status: parsed.status })
}
return new Response(JSON.stringify({ success: true }))
}
配置
请参阅 配置参考 了解所有可用选项(initLogger、中间件选项、采样、静默模式等)。
排水处理
在 initLogger 中配置排水处理:
src/middleware.ts
import { initLogger, createRequestLogger } from 'evlog'
import { createAxiomDrain } from 'evlog/axiom'
import { createDrainPipeline } from 'evlog/pipeline'
import type { DrainContext } from 'evlog'
const pipeline = createDrainPipeline<DrainContext>({
batch: { size: 50, intervalMs: 5000 },
})
const drain = pipeline(createAxiomDrain())
initLogger({
env: { service: 'my-astro-app' },
drain,
})
请参阅 适配器文档 了解所有可用的排水适配器。