
在 GraphQL Yoga 中,可通过 useLogger 插件捕获执行阶段的错误,并安全访问操作名、错误详情及请求上下文(如 context),实现与 Apollo Server didEncounterErrors 类似的错误可观测性能力。
在 graphql yoga 中,可通过 `uselogger` 插件捕获执行阶段的错误,并安全访问操作名、错误详情及请求上下文(如 `context`),实现与 apollo server `didencountererrors` 类似的错误可观测性能力。
GraphQL Yoga 作为轻量、现代且符合规范的 GraphQL 服务器实现,其插件系统设计更偏向组合式与函数式风格,不直接提供与 Apollo Server 完全同名的生命周期钩子(如 didEncounterErrors)。但其内置的 useLogger 插件正是为此类场景而生——它不仅用于日志记录,更是一个可靠的错误拦截与上下文增强入口。
useLogger 在 GraphQL 执行流程的关键节点(如 execute 阶段)触发,当查询执行失败并生成 errors 时,args.result.errors 即包含所有抛出的 GraphQLError 实例;同时,args.operationName、args.variables、args.query 等字段均可用。更重要的是:args.context 是完整传递的请求上下文对象,这意味着你可安全访问认证信息、数据库连接、追踪 ID 等自定义字段,完全满足错误诊断、审计或告警等生产需求。
以下为标准配置示例:
import { createYoga, useLogger } from 'graphql-yoga';
const yoga = createYoga({
schema,
plugins: [
useLogger({
logFn: (eventName, args) => {
// 仅在执行出错时处理
if (eventName === 'execute' && args.result?.errors?.length > 0) {
const { errors, operationName, context } = args;
// ✅ 安全访问上下文(含用户、req、db 等)
console.error('[GraphQL Error]', {
operationName,
errorCount: errors.length,
userId: context?.user?.id, // 示例:记录当前用户
requestId: context?.requestId,
});
errors.forEach((error, index) => {
console.error(`Error ${index + 1}:`, {
message: error.message,
locations: error.locations,
path: error.path,
extensions: error.extensions,
});
});
}
},
}),
],
});⚠️ 注意事项:
- useLogger 的 logFn 会在多个事件(如 parse、validate、execute)中被调用,务必通过 eventName === 'execute' 和 args.result?.errors 进行精准过滤,避免重复日志或空引用错误;
- args.context 是运行时注入的完整上下文,但需确保你在 createYoga 的 context 选项中已正确定义(例如返回 Promise 或同步对象),否则可能为 undefined;
- 若需对错误进行修改(如脱敏、添加追踪码),useLogger 仅用于读取和日志——如需拦截/重写错误,请搭配 useSchema 或自定义 formatError 函数;
- 生产环境建议将 console.error 替换为结构化日志库(如 pino)并集成 APM(如 Sentry),利用 error.extensions.code 做分类告警。
总结而言,useLogger 不仅是 Yoga 的日志工具,更是其面向可观测性的核心扩展点。它以简洁 API 提供了比 didEncounterErrors 更丰富的事件粒度与上下文保真度,是 Apollo 迁移中值得重点掌握的替代方案。










