ロガー

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