ロガー
Sumor Cloud ツール。
追加のドキュメント
これは 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('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 より低いため、出力されません