Logger Module

GEBRA project에서 공통으로 사용하기 위한 Nestjs module. Pino logger를 기반으로 Sentry 기능을 내장하고 있습니다.

설치

GEBRA Monorepo 내에서 사용하고자 하는 service의 package.json에 아래와 같이 dependency를 추가합니다.

{
  "dependencies": {
    "logger-module": "^1.0.0"
  }
}

package.json에 명시 이후 yarn (install) 명령어로 workspace 내 dependency를 업데이트 합니다.

사용법

NestJS root module에 아래와 같이 모듈을 import해줍니다.

@Module({
    imports: [
        LoggerModule.forRoot()
    ],
    controllers: [],
})

forRoot 매서드의 인자는 Nestjs Pino library의 인자와 동일한 값을 갖습니다.(참고)

Sentry 관련 기능

Logger의 info, warn, error 매서드 호출 시 항상 Sentry context에 로깅된 정보가 breadcrumb으로 추가됩니다.