Nodejs Nestjs错误追踪插件nestjs-raven的使用

nestjs-raven 是一个用于 NestJS 应用程序的错误追踪插件，它基于 Sentry 的 Raven 客户端。Sentry 是一个广泛使用的错误跟踪平台，可以帮助开发者实时监控和修复应用程序中的错误。以下是使用 nestjs-raven 插件的基本步骤：

1. 安装依赖

首先，你需要安装 [@sentry](/user/sentry)/node 和 nestjs-raven（现在可能已经是 @sentry/integrations）：

npm install [@sentry](/user/sentry)/node nestjs-raven --save

如果你的项目使用的是 Yarn，则可以使用以下命令：

yarn add [@sentry](/user/sentry)/node nestjs-raven

2. 配置 Sentry

接下来，你需要配置 Sentry 来接收错误报告。这通常在你的 NestJS 应用的主入口文件中完成。

创建或编辑 app.module.ts 文件，添加 Sentry 的配置：

import { Module, OnModuleInit } from '@nestjs/common';
import * as Raven from 'raven';

@Module({
  imports: [],
  controllers: [],
  providers: [],
})
export class AppModule implements OnModuleInit {
  onModuleInit() {
    // 初始化 Sentry 客户端
    Raven.config('YOUR_SENTRY_DSN', {
      environment: process.env.NODE_ENV,
    }).install();
  }
}

请确保将 'YOUR_SENTRY_DSN' 替换为你的 Sentry DSN (数据源名称)。

3. 使用 Sentry

你可以在服务中直接使用 Raven 来手动发送错误报告，或者通过 NestJS 异常过滤器来自动捕获并上报未处理的异常。

例如，在一个服务中手动发送错误：

import { Injectable } from '@nestjs/common';
import * as Raven from 'raven';

@Injectable()
export class SomeService {
  async doSomethingThatMightFail() {
    try {
      // 这里执行可能会失败的操作
      throw new Error('Something went wrong');
    } catch (err) {
      // 手动报告错误到 Sentry
      Raven.captureException(err);
    }
  }
}

4. 自动捕获未处理的异常

为了自动捕获所有未处理的异常，你可以创建一个全局异常过滤器，并使用 Raven 发送这些异常：

import { ExceptionFilter, Catch, ArgumentsHost, HttpException } from '@nestjs/common';
import * as Raven from 'raven';

@Catch()
export class AllExceptionsFilter implements ExceptionFilter {
  catch(exception: unknown, host: ArgumentsHost) {
    const ctx = host.switchToHttp();
    const response = ctx.getResponse();
    const request = ctx.getRequest();

    console.error(exception); // 或者你也可以使用 Raven 记录错误
    Raven.captureException(exception);

    response.status(500).json({
      statusCode: 500,
      timestamp: new Date().toISOString(),
      path: request.url,
    });
  }
}

// 在 main.ts 中应用这个过滤器
async function bootstrap() {
  const app = await NestFactory.create(AppModule);
  app.useGlobalFilters(new AllExceptionsFilter());
  await app.listen(3000);
}
bootstrap();

以上就是使用 nestjs-raven 插件的基本指南。请注意，根据你的项目结构，实际实现细节可能会有所不同。