로거

Node.JS용 가벼운 로거입니다.
다양한 레벨로 로그를 출력할 수 있으며, 범위, ID 및 시간대를 사용자 정의할 수 있습니다.

설치

npm i @sumor/logger --save

전제 조건

Node.JS 버전

Node.JS 버전 16.x 이상이 필요합니다.

Node.JS ES 모듈 필요

이 패키지는 ES 모듈로 작성되었으므로 다음 코드를 package.json 파일에 추가해 주세요:

{
  "type": "module"
}

사용법

일반적인 사용법

import Logger from '@sumor/logger'
const logger = new Logger()

logger.trace('안녕하세요!')
// 다음과 같은 출력이 표시됩니다:
// 2020-01-01 00:00:00.000 TRACE MAIN - 안녕하세요!

범위 변경

특정 경우에 로그를 카테고리화해야 할 때 scope를 사용합니다.

import Logger from '@sumor/logger'
const logger = new Logger({
  scope: '예시'
})
logger.trace('안녕하세요!')
// 다음과 같은 출력이 표시됩니다:
// 2020-01-01 00:00:00.000 TRACE 예시 - 안녕하세요!

사용자 식별자 변경

특정 경우에 사용자 식별자가 필요할 때 id를 사용합니다.

import Logger from '@sumor/logger'
const logger = new Logger({
  id: 'USER001'
})
logger.trace('안녕하세요!')
// 다음과 같은 출력이 표시됩니다:
// 2020-01-01 00:00:00.000 TRACE MAIN USER001 - 안녕하세요!

레벨 변경

대부분의 경우 특정 레벨의 로그만 필요할 때 저장하고 표시할지 여부를 결정할 수 있습니다.

import Logger from '@sumor/logger'
const logger = new Logger()
logger.trace('안녕하세요!') // trace는 가장 낮은 수준이므로 모든 로그가 출력됩니다
logger.debug('안녕하세요!')
logger.info('안녕하세요!')
logger.warn('안녕하세요!')
logger.error('안녕하세요!')
logger.fatal('안녕하세요!') // fatal은 가장 높은 수준이므로 중대한 오류만 출력됩니다

시간대 변경

import Logger from '@sumor/logger'
const logger1 = new Logger({
  offset: 2 * 60 // UTC+2의 오프셋은 2시간입니다
})
logger1.info('안녕하세요!')
// 다음과 같은 출력이 표시됩니다:
// 2020-01-01 02:00:00.000 INFO MAIN - 안녕하세요!

const logger2 = new Logger({
  offset: 8 * 60 // UTC+8의 오프셋은 8시간입니다
})
logger2.info('안녕하세요!')
// 다음과 같은 출력이 표시됩니다:
// 2020-01-01 08:00:00.000 INFO MAIN - 안녕하세요!

사전 정의된 코드

import Logger from '@sumor/logger'
const code = {
  trace: {
    HTTP_ACCESS: '사용자가 HTTP를 통해 액세스하고 IP 주소는 {ip}입니다'
  },
  debug: {
    USER_TOKEN_LOADED: '사용자 로그인 정보가 읽혀지고 사용자 ID는 {id}입니다'
  },
  info: {
    USER_LOGIN: '사용자가 로그인하고 사용자 ID는 {id}입니다'
  },
  warn: {
    USER_LOGOUT: '사용자가 로그아웃하고 사용자 ID는 {id}입니다'
  },
  error: {
    USER_LOGIN_FAILED: '사용자 로그인이 실패하고 사용자 ID는 {id}입니다'
  },
  fatal: {
    USER_LOGIN_BLOCKED: '사용자 로그인이 차단되었고 사용자 ID는 {id}입니다'
  }
}
const i18n = {
  zh: {
    USER_LOGIN: '사용자가 로그인하고 사용자 ID는 {id}입니다'
  }
}
const logger1 = new Logger({
  code,
  i18n
})

logger1.code('USER_LOGIN', { id: 'USER001' })
// 다음과 같은 출력이 표시됩니다:
// 2020-01-01 00:00:00.000 INFO MAIN - 사용자가 로그인하고 사용자 ID는 USER001입니다

const logger2 = new Logger({
  code,
  i18n,
  language: 'zh-US'
})

logger2.code('USER_LOGIN', { id: 'USER001' })
// 다음과 같은 출력이 표시됩니다:
// 2020-01-01 00:00:00.000 INFO MAIN - 사용자가 로그인하고 사용자 ID는 USER001입니다

const logger3 = new Logger({
  code,
  i18n,
  language: 'zh-CN'
})

logger3.code('USER_LOGIN', { id: 'USER001' })
// 다음과 같은 출력이 표시됩니다:
// 2020-01-01 00:00:00.000 INFO MAIN - 사용자가 로그인하고 사용자 ID는 USER001입니다

전역 언어 설정

process.env.LANGUAGE = 'zh-CN'
import Logger from '@sumor/logger'

const code = {
  info: {
    USER_LOGIN: '사용자가 로그인하고 사용자 ID는 {id}입니다'
  }
}
const i18n = {
  zh: {
    USER_LOGIN: '사용자가 로그인하고 사용자 ID는 {id}입니다'
  }
}
const logger = new Logger({
  code,
  i18n
})

logger.code('USER_LOGIN', { id: 'USER001' })
// 다음과 같은 출력이 표시됩니다:
// 2020-01-01 00:00:00.000 INFO MAIN - 사용자가 로그인하고 사용자 ID는 USER001입니다

레벨 필터

특정 레벨의 로그를 필터링하려면 다음 코드를 사용할 수 있습니다:

import Logger from '@sumor/logger'
const logger = new Logger({
  level: 'info'
})
logger.trace('안녕하세요!') // trace는 가장 낮은 수준이므로 출력되지 않음
logger.debug('안녕하세요!') // debug는 info보다 낮으므로 출력되지 않음
logger.info('안녕하세요!') // info는 info와 같으므로 출력됨
logger.warn('안녕하세요!') // warn은 info보다 높으므로 출력됨
logger.error('안녕하세요!') // error는 info보다 높으므로 출력됨
logger.fatal('안녕하세요!') // fatal은 가장 높은 수준이므로 출력됨

이 라이브러리를 여러 라이브러리에서 사용할 때 다음 코드를 사용할 수 있습니다:

import Logger from '@sumor/logger'
const logger = new Logger()
process.env.LOG_LEVEL = 'info'

logger.trace('안녕하세요!') // trace는 가장 낮은 수준이므로 출력되지 않음
logger.debug('안녕하세요!') // debug는 info보다 낮으므로 출력되지 않음
logger.info('안녕하세요!') // info는 info와 같으므로 출력됨
logger.warn('안녕하세요!') // warn은 info보다 높으므로 출력됨
logger.error('안녕하세요!') // error는 info보다 높으므로 출력됨

process.env.LOG_LEVEL = 'warn' // 로그 레벨 실시간 변경
logger.info('안녕하세요!') // info는 warn보다 낮으므로 출력되지 않음