logger
이것은 Node.JS용 가벼운 로거입니다. 다양한 레벨에서 로그를 출력하고 범위, ID 및 시간대를 사용자 정의할 수 있습니다.
설치
npm i @sumor/logger --save
전제 조건
Node.JS 버전
Node.JS 버전 18.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는 이를 위해 사용됩니다.
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 오프셋은 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 오프셋은 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입니다
레벨 필터링
레벨별로 로그를 필터링하고 싶을 때 다음 코드를 사용할 수 있습니다:
import Logger from '@sumor/logger'
const logger = new Logger({
level: 'info'
})
logger.trace('Hello World!') // trace는 가장 낮은 레벨이기 때문에 출력되지 않습니다
logger.debug('Hello World!') // debug는 info보다 낮으므로 출력되지 않습니다
logger.info('Hello World!') // info는 info와 같으므로 출력됩니다
logger.warn('Hello World!') // warn은 info보다 높으므로 출력됩니다
logger.error('Hello World!') // error는 info보다 높으므로 출력됩니다
logger.fatal('Hello World!') // fatal은 가장 높은 레벨이므로 출력됩니다
이 라이브러리를 여러 라이브러리에 걸쳐 사용할 때 다음 코드를 사용할 수 있습니다:
import Logger from '@sumor/logger'
const logger = new Logger()
process.env.LOG_LEVEL = 'info'
logger.trace('Hello World!') // trace는 가장 낮은 레벨이기 때문에 출력되지 않습니다
logger.debug('Hello World!') // debug는 info보다 낮으므로 출력되지 않습니다
logger.info('Hello World!') // info는 info와 같으므로 출력됩니다
logger.warn('Hello World!') // warn은 info보다 높으므로 출력됩니다
logger.error('Hello World!') // error는 info보다 높으므로 출력됩니다
process.env.LOG_LEVEL = 'warn' // 실시간 로그 레벨 변경
logger.info('Hello World!') // info는 warn보다 낮으므로 출력되지 않습니다