ロガー

これは 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!

スコープの変更

あるケースでは、ログをカテゴリー分けする必要があります。スコープ はその目的で使用されます。

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 より低いため、出力されません