ロガー

Sumor Cloud ツールです。
詳細なドキュメント

これは Node.JS 用の軽量ロガーです。
異なるレベルでログを出力し、スコープ、ID、タイムゾーンをカスタマイズすることができます。

CI テスト カバレッジ 監査

インストール

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!