ロガー
これは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('こんにちは、世界！')
// 次の出力が表示されます:
// 2020-01-01 00:00:00.000 TRACE MAIN - こんにちは、世界！
スコープの変更
場合によっては、ログをカテゴリ別に分類する必要があります。scopeがこの目的で使用されます。
import Logger from '@sumor/logger'
const logger = new Logger({
scope: 'DEMO'
})
logger.trace('こんにちは、世界！')
// 次の出力が表示されます:
// 2020-01-01 00:00:00.000 TRACE DEMO - こんにちは、世界！
識別子の変更
場合によっては、識別子ユーザーが必要です。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より低いため、出力されません