Nest.js Error Monitoring

H.init("<YOUR_PROJECT_ID>", {
  tracingOrigins: ['localhost', 'example.myapp.com/backend'],
  networkRecording: {
    enabled: true,
    recordHeadersAndBody: true,
  },
});

Install the relevant Highlight SDK(s).

Install @highlight-run/nest with your package manager.

npm install --save @highlight-run/nest

Add the @highlight-run/nest app middleware.

Use the HighlightErrorFilter middleware to capture backend errors.

import { NestFactory } from '@nestjs/core';
import { AppModule } from './app.module';
import { HighlightInterceptor, H } from '@highlight-run/nest';

const env = {
  projectID: '<YOUR_PROJECT_ID>',
  serviceName: 'my-nestjs-app',
  serviceVersion: 'git-sha',
  environment: 'production',
  debug: false,
};

async function bootstrap() {
  H.init(env);
  const app = await NestFactory.create(AppModule);
  app.useGlobalInterceptors(new HighlightInterceptor(env));
  await app.listen(3000);
}
bootstrap();

Optionally, report manual errors in your app.

If you need to report exceptions outside of a handler, use the Highlight SDK.

const parsed = H.parseHeaders(request.headers)
H.consumeError(error, parsed?.secureSessionId, parsed?.requestId)

Verify that your SDK is reporting errors.

You'll want to throw an exception in one of your Nest.js handlers. Access the API handler and make sure the error shows up in Highlight.

import { Injectable } from '@nestjs/common'

@Injectable()
export class AppService {
  getHello(): string {
    console.log('hello, world!')
    console.warn('whoa there! ', Math.random())
    if (Math.random() < 0.2) {
      // error will be caught by the HighlightErrorFilter
      throw new Error(`a random error occurred! 0.5729668744288425`)
    }
    return 'Hello World!'
  }
}

Set up logging.

Start sending logs to Highlight! Follow the logging setup guide to get started.

Firebase Error Monitoring Node.js Error Monitoring