Nodejs Nestjs错误追踪插件sentry的使用

Nodejs Nestjs错误追踪插件sentry的使用
在NestJS项目中集成Sentry进行错误追踪是一个常见的需求。以下是如何配置和使用Sentry的步骤。

1. 安装依赖

首先，你需要安装@sentry/node包。你可以使用npm或yarn来安装：

npm install @sentry/node
# 或者
yarn add @sentry/node

2. 配置Sentry

接下来，在你的应用中配置Sentry。通常，你会在主文件（如main.ts）中进行配置。下面是一个基本的配置示例：

import { NestFactory } from '@nestjs/core';
import * as Sentry from '@sentry/node';

async function bootstrap() {
  const app = await NestFactory.create(AppModule);

  // 初始化Sentry
  Sentry.init({
    dsn: 'https://examplePublicKey@o0.ingest.sentry.io/0',
    environment: process.env.NODE_ENV, // 可选：设置环境
  });

  // 全局异常处理器，将异常发送到Sentry
  app.useGlobalFilters(new Sentry.NestJsSentryFilter());

  await app.listen(3000);
}
bootstrap();

3. 使用Sentry捕获错误

你可以在你的服务或控制器中手动捕获并发送错误到Sentry。例如：

import { Injectable } from '@nestjs/common';
import * as Sentry from '@sentry/node';

@Injectable()
export class AppService {
  async someMethodThatMayFail() {
    try {
      // 一些可能抛出错误的操作
    } catch (error) {
      // 手动捕获并发送错误到Sentry
      Sentry.captureException(error);
      throw error; // 重新抛出错误以便全局异常处理器可以处理它
    }
  }
}

4. 全局异常处理

如果你希望自动捕获所有未处理的异常，可以使用全局异常处理器。你已经在初始化Sentry时添加了app.useGlobalFilters(new Sentry.NestJsSentryFilter());，这会自动捕获所有通过Express中间件层抛出的异常，并将其发送到Sentry。

5. 自定义标签和上下文

你还可以添加自定义标签或上下文信息以更好地理解错误发生时的情况：

Sentry.configureScope((scope) => {
  scope.setTag('custom_tag', 'value');
  scope.setContext('user_info', {
    id: '123',
    email: 'user@example.com',
  });
});

6. 测试Sentry配置

最后，确保你的配置正确工作的一个好方法是在你的应用中故意引发一个错误，并检查Sentry仪表板是否收到了错误报告。

以上就是如何在NestJS项目中使用Sentry进行错误追踪的基本步骤。希望这对您有所帮助！


3 回复

当然，要给你的NestJS项目添加Sentry错误追踪，你可以按照这些步骤来：

  1. 安装Sentry SDK：首先，你需要通过npm安装[@sentry](/user/sentry)/node。打开终端，进入你的项目目录，然后运行：

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

  2. 配置Sentry：在你的应用入口文件（通常是main.ts）中，添加Sentry配置。例如：

    import * as Sentry from '[@sentry](/user/sentry)/node';

Sentry.init({
  dsn: '你的Sentry DSN',
});

async function bootstrap() {
  const app = await NestFactory.create(AppModule);
  await app.listen(3000);
}
bootstrap();

  3. 测试：现在，你可以故意抛出一个错误来测试Sentry是否工作正常。比如，在某个控制器中添加：

    [@Get](/user/Get)('test-error')
testError() {
  throw new Error('这是一个测试错误');
}

  4. 查看错误：访问/test-error，然后去你的Sentry面板查看新报告的错误。

这样，你就成功集成了Sentry到NestJS项目中，开始追踪和管理错误了！


NestJS 是一个用于构建高效、可扩展的服务器端应用程序的框架。 Sentry 是一个广泛使用的错误跟踪平台，可以帮助你捕获和修复应用中的错误。下面是如何在 NestJS 应用中集成 Sentry 的步骤。

1. 安装 Sentry SDK

首先，你需要安装 @sentry/node 包，这是一个官方提供的 Node.js 客户端。

npm install @sentry/node

2. 初始化 Sentry

接下来，在你的 NestJS 应用中初始化 Sentry。这通常在主文件（例如 main.ts）中完成。

import { NestFactory } from '@nestjs/core';
import * as Sentry from '@sentry/node';
import { AppModule } from './app.module';

async function bootstrap() {
  const app = await NestFactory.create(AppModule);

  // 初始化 Sentry
  Sentry.init({
    dsn: 'YOUR_SENTRY_DSN',
    environment: process.env.NODE_ENV || 'development',
  });

  await app.listen(3000);
}
bootstrap();

确保替换 'YOUR_SENTRY_DSN' 为你的实际 DSN（数据源名称）。

3. 配置 Sentry 错误处理器

你可以通过配置 Sentry 来捕获和处理 NestJS 中的异常。建议将错误处理逻辑放在全局异常过滤器中。

import { ExceptionFilter, Catch, ArgumentsHost, HttpException, HttpStatus } from '@nestjs/common';
import * as Sentry from '@sentry/node';

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

    const status =
      exception instanceof HttpException
        ? exception.getStatus()
        : HttpStatus.INTERNAL_SERVER_ERROR;

    Sentry.withScope((scope) => {
      scope.addEventProcessor(event =>
        Sentry.Handlers.parseRequest(event, request)
      );
      Sentry.captureException(exception);
    });

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

然后在你的应用模块中注册这个过滤器：

import { Module, NestModule, MiddlewareConsumer, RequestMethod } from '@nestjs/common';
import { APP_FILTER } from '@nestjs/core';

@Module({
  imports: [],
  controllers: [],
  providers: [
    {
      provide: APP_FILTER,
      useClass: AllExceptionsFilter,
    },
  ],
})
export class AppModule implements NestModule {
  configure(consumer: MiddlewareConsumer) {
    // 其他中间件配置
  }
}

以上就是在 NestJS 应用中集成 Sentry 错误追踪的基本步骤。这将帮助你有效地监控和管理你的应用错误。

NestJS集成Sentry进行错误追踪，首先安装@sentry/node和@nestjs/sentry包。在main.ts中初始化Sentry：

import * as Sentry from '@sentry/node';

Sentry.init({ dsn: '你的Sentry DSN' });

async function bootstrap() {
  const app = await NestFactory.create(AppModule);
  await app.listen(3000);
}
bootstrap();

配置@nestjs/sentry模块，在 AppModule 中导入并配置它。这样，所有的异常都会被自动捕获并报告给Sentry。

回到顶部