ロガー

これは 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 です