在Graphile Worker中使用AsyncLocalStorage实现全局上下文日志

背景介绍

在Node.js服务端开发中，日志记录是一个非常重要的功能，特别是在异步任务处理系统中。Graphile Worker作为一个优秀的PostgreSQL驱动的任务队列，其日志功能对于任务追踪和问题排查至关重要。本文将介绍如何结合AsyncLocalStorage和Pino日志库，在Graphile Worker中实现全局上下文日志记录。

AsyncLocalStorage简介

AsyncLocalStorage是Node.js提供的一个API，它允许我们在异步操作中存储和访问上下文数据。这意味着我们可以在任何异步调用链中获取到当前上下文的信息，而不需要显式地传递这些数据。

实现方案

基础日志设置

首先，我们创建一个基础的Pino日志实例：

const baseLogger = pino({});

上下文存储

然后，我们初始化AsyncLocalStorage来存储上下文数据：

const asyncContext = new AsyncLocalStorage<Map<string, any>>();

获取当前上下文日志

我们提供一个函数来获取当前上下文中的日志实例，如果没有上下文则返回基础日志：

function getLogger(): pino.Logger {
  return asyncContext.getStore()?.get('logger') || baseLogger;
}

包装执行器

关键部分是将Graphile Worker的执行器包装在一个上下文中：

function runExecutorInContext(fn: Task): Task {
  return (payload, helpers) => {
    const executionId = randomUUID();
    const childLogger = baseLogger.child({ executionId });
    const store = new Map([['logger', childLogger]]);

    // 记录任务信息
    childLogger.info('Job Info: %o', helpers.job);

    return asyncContext.run(store, () => {
      helpers.logger.info('Executing task');
      return fn(payload, helpers);
    });
  };
}

与Graphile Logger集成

更优雅的方式是直接使用Graphile的日志系统：

function runExecutorInContext(fn: Task): Task {
  return (payload, helpers) => {
    const executionId = randomUUID();
    helpers.logger = helpers.logger.scope({ executionId });
    const store = new Map([['logger', helpers.logger]]);

    return asyncContext.run(store, () => {
      return fn(payload, helpers);
    });
  };
}

优势分析

1. 上下文隔离：每个任务执行都有独立的日志上下文，不会互相干扰
2. 简化代码：不需要在每个函数中显式传递日志实例
3. 完整追踪：通过executionId可以追踪整个任务的执行流程
4. 灵活扩展：可以轻松添加更多上下文信息到日志中

实际应用

在实际项目中，我们可以这样使用：

// 定义任务
const myTask = runExecutorInContext(async (payload, helpers) => {
  getLogger().info('Processing task...');
  // 业务逻辑
});

// 注册任务
workerUtils.addJob('my_task', { data: 'value' });

注意事项

1. 确保AsyncLocalStorage的上下文在任务执行的整个生命周期中都有效
2. 注意错误处理，避免上下文泄漏
3. 在长时间运行的任务中，考虑定期刷新日志上下文

总结

通过结合AsyncLocalStorage和Graphile Worker的日志系统，我们可以实现强大的上下文感知日志记录功能。这种方法不仅提高了代码的整洁性，还大大增强了系统的可观测性，是构建可靠异步任务处理系统的重要技术。