Vendure项目中实现纯净JSON日志输出的解决方案

背景介绍

在现代Web应用开发中，日志记录是系统监控和故障排查的重要环节。Vendure作为一个现代化的电子商务框架，提供了灵活的日志记录机制。在实际生产环境中，我们经常需要将日志以JSON格式输出，以便于日志收集系统（如ELK、Fluentd等）进行解析和处理。

问题描述

开发者在Vendure项目中实现自定义JSON日志记录器时，发现日志输出中包含了多余的进程上下文前缀（如[worker]），这破坏了日志的纯JSON格式，导致日志收集系统无法直接解析。

解决方案分析

自定义日志记录器实现

Vendure允许开发者通过实现VendureLogger接口来创建自定义日志记录器。以下是使用pino日志库实现JSON格式日志的典型代码：

export class VendureLoggerImpl implements VendureLogger {
  private logger;

  constructor({ level }: { level: string }) {
    this.logger = pino({
      formatters: {
        level: (label) => {
          return { level: label.toUpperCase() };
        },
      },
      level: level ?? 'info',
      customLevels: {
        verbose: 10,
      },
      messageKey: 'message',
      timestamp: () => {
        return ', "@timestamp":"' + new Date(Date.now()).toISOString() + '"';
      },
    });
  }

  // 实现各种日志级别的方法
  error(message: string, context?: string, trace?: string): void {
    this.logger.error({ message, context, trace });
  }
  // ...其他日志级别方法
}

进程上下文前缀问题

在实际运行中，日志输出会包含类似[worker]的前缀，这实际上是来自进程管理工具（如concurrently）的输出，而非Vendure框架本身添加的内容。concurrently是一个常用的Node.js进程管理工具，它可以同时运行多个命令，并为每个命令的输出添加前缀以便区分。

解决方案

要获得纯净的JSON日志输出，有以下几种解决方案：

1. 直接运行进程：不通过concurrently启动应用，而是直接运行主进程和工作进程

   node dist/index.js
   node dist/worker.js
   

2. 配置concurrently：如果必须使用concurrently，可以配置其不添加前缀

   concurrently --prefix none "command1" "command2"
   

3. 使用进程管理工具：考虑使用PM2等更专业的进程管理工具，它们提供更灵活的日志处理选项

最佳实践建议

1. 生产环境部署：在生产环境中，建议使用专业的进程管理工具如PM2，它不仅能更好地管理Node.js进程，还提供了完善的日志管理功能。

2. 日志格式化：确保日志格式统一，所有相关信息都应包含在JSON结构中，而不是作为前缀。

3. 上下文信息：将进程类型（worker/main）作为JSON字段包含在日志中，而不是依赖前缀。

4. 日志级别：合理设置日志级别，生产环境通常使用info级别，开发环境可以使用更详细的debug级别。

总结

通过理解日志前缀的来源并选择合适的进程管理方式，开发者可以在Vendure项目中实现纯净的JSON日志输出。这对于构建现代化的、可观测性强的电子商务系统至关重要。记住，良好的日志实践是系统可维护性的基石，值得投入适当的时间进行规划和实施。