hh-logger

A flexible and configurable logging library for NestJS, supporting Sentry and Datadog integrations.

Installation

Install the library using npm:

1npm install hh-logger

Configuration

Sentry Integration

To use Sentry, provide the necessary DSN and other configuration options.

Datadog Integration

To use Datadog, provide the necessary API key and other configuration options.

Usage

AppModule Configuration

Import the HhLoggerModule and configure it with your Sentry and Datadog credentials.

Example AppModule

1import { Module } from '@nestjs/common';
2import { AppController } from './app.controller';
3import { AppService } from './app.service';
4import { HhLoggerModule } from 'hh-logger';
5
6@Module({
7  imports: [
8    HhLoggerModule.forRoot({
9      sentry: {
10        dsn: 'your-sentry-dsn', // Replace with your Sentry DSN
11        environment: 'development',
12        debug: true,
13      },
14      datadog: {
15        apiKey: 'your-datadog-api-key', // Replace with your Datadog API key
16        hostname: 'your-datadog-hostname',
17        service: 'test-service',
18        env: 'development',
19        version: '1.0.0',
20      },
21    }),
22  ],
23  controllers: [AppController],
24  providers: [AppService],
25})
26export class AppModule {}

Example AppController

Inject the HhLoggerService and use it in your controllers to log messages.

1import { Controller, Get } from '@nestjs/common';
2import { HhLoggerService } from 'hh-logger';
3
4@Controller()
5export class AppController {
6  constructor(private readonly logger: HhLoggerService) {}
7
8  @Get()
9  getHello(): string {
10    this.logger.info('This is an info message');
11    this.logger.warn('This is a warning message');
12    this.logger.error('This is an error message');
13    return 'Hello World!';
14  }
15}

License

This project is licensed under the MIT License.