로거

Node.JS용 가벼운 로거입니다. 로그를 여러 레벨로 출력할 수 있으며 scope, 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('Hello World!')
// 다음 출력을 볼 수 있습니다:
// 2020-01-01 00:00:00.000 TRACE MAIN - Hello World!

Scope 변경

어떤 경우에는 로그를 분류해야할 필요가 있습니다. scope가 그 목적을 위해 사용됩니다.

import Logger from '@sumor/logger'
const logger = new Logger({
  scope: 'DEMO'
})
logger.trace('Hello World!')
// 다음 출력을 볼 수 있습니다:
// 2020-01-01 00:00:00.000 TRACE DEMO - Hello World!

사용자 식별자 변경

어떤 경우에는 사용자 식별자가 필요할 수 있습니다. id가 그 목적을 위해 사용됩니다.

import Logger from '@sumor/logger'
const logger = new Logger({
  id: 'USER001'
})
logger.trace('Hello World!')
// 다음 출력을 볼 수 있습니다:
// 2020-01-01 00:00:00.000 TRACE MAIN USER001 - Hello World!

레벨 변경

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

import Logger from '@sumor/logger'
const logger = new Logger()
logger.trace('Hello World!') // trace는 가장 낮은 레벨이며 모든 로그가 출력됩니다
logger.debug('Hello World!')
logger.info('Hello World!')
logger.warn('Hello World!')
logger.error('Hello World!')
logger.fatal('Hello World!') // fatal은 가장 높은 레벨이며, 심각한 오류만 출력됩니다

시간대 변경

import Logger from '@sumor/logger'
const logger1 = new Logger({
  offset: 2 * 60 // UTC+2의 offset은 2시간입니다
})
logger1.info('Hello World!')
// 다음 출력을 볼 수 있습니다:
// 2020-01-01 02:00:00.000 INFO MAIN - Hello World!

const logger2 = new Logger({
  offset: 8 * 60 // UTC+8의 offset은 8시간입니다
})
logger2.info('Hello World!')
// 다음 출력을 볼 수 있습니다:
// 2020-01-01 08:00:00.000 INFO MAIN - Hello World!

미리 정의된 코드

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 입니다