如何在Nest.js应用中记录MongoDB连接错误

一、捕获并记录详细连接错误 #

默认的MongooseModule仅输出重试提示，无法定位具体问题。你需要通过自定义连接逻辑，监听Mongoose的错误事件，将详细错误写入日志文件：

方案：使用forRootAsync自定义连接配置 #

替换原有的MongooseModule.forRoot为异步配置，手动监听连接错误并写入日志：

import { Module, Logger } from '@nestjs/common';
import { MongooseModule, MongooseModuleOptions } from '@nestjs/mongoose';
import * as fs from 'fs';
import * as path from 'path';

// 自定义日志写入函数，追加到指定文件
const logMongoError = (message: string) => {
  const logFilePath = path.resolve(__dirname, '../logs/mongo-connection-errors.log');
  const timestamp = new Date().toISOString();
  const logEntry = `[${timestamp}] ${message}\n`;
  fs.appendFileSync(logFilePath, logEntry, 'utf8');
};

@Module({
  imports: [
    MongooseModule.forRootAsync({
      useFactory: () => {
        const dbConnectionString = `${process.env.MONGO_URL}&tlsCAFile=/etc/mongo-cert/mongoCA.pem&tlsAllowInvalidCertificates=true`;
        const logger = new Logger('AppModule');
        logger.log(`DB Connection string: ${dbConnectionString}`);

        return {
          uri: dbConnectionString,
          // 自定义连接工厂，添加事件监听
          connectionFactory: (connection) => {
            // 捕获连接错误
            connection.on('error', (err) => {
              const errorDetails = `Mongoose连接失败: ${err.message}\n${err.stack || ''}`;
              logger.error(errorDetails);
              logMongoError(errorDetails);
            });
            // 捕获连接断开事件
            connection.on('disconnected', () => {
              const msg = 'Mongoose连接已断开';
              logger.warn(msg);
              logMongoError(msg);
            });
            return connection;
          },
        } as MongooseModuleOptions;
      },
    }),
    HealthModule,
    HttpModule,
  ],
  controllers: [AppController],
  providers: [AppService],
})
export class AppModule {}

如果你的项目已经集成了Winston/Pino这类日志库，可以直接用注入的日志服务替代上面的logMongoError函数，更符合Nest.js的日志规范。

二、结合你的环境差异补充排查点 #

除了日志，结合本地MongoDB 3.6、IaaS环境5.0的版本差异，还有几个常见问题：

• 驱动版本不兼容：MongoDB 5.0要求Mongoose版本≥6.x，检查package.json中的mongoose版本，若低于6.x，建议升级到适配版本（注意@nestjs/mongoose也要对应升级到兼容版本）。
• TLS配置差异：MongoDB 5.0对TLS版本的默认要求更高，可尝试在连接字符串中添加&tlsVersion=TLS1.2强制指定版本。
• 权限与认证源：确认连接字符串中的authSource参数是否正确，若你的数据库用户不是在admin库创建的，需要明确指定&authSource=你的数据库名。

三、验证效果 #

修改代码后重启服务，当连接失败时，mongo-connection-errors.log会生成包含错误栈的详细日志，比如证书验证失败、网络超时、权限不足等信息，直接指向问题根源。

内容的提问来源于stack exchange，提问作者piccy