Журналировщик

Инструмент Sumor Cloud.
Дополнительная документация

Это легкий журналировщик для Node.JS. Он может выводить журналы на разных уровнях, и вы можете настраивать область, идентификатор и часовой пояс.

Установка

npm i @sumor/logger --save

Предварительные требования

Версия Node.JS

Требуется версия Node.JS 18.x или выше

Требуется модуль ES Node.JS

Поскольку этот пакет написан в виде модуля 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 - Привет, мир!

Изменение области

В некоторых случаях нам нужно категоризировать журналы. Для этой цели используется область.

import Logger from '@sumor/logger'
const logger = new Logger({
  scope: 'ДЕМО'
})
logger.trace('Привет, мир!')
// Вы увидите следующий вывод:
// 2020-01-01 00:00:00.000 TRACE ДЕМО - Привет, мир!

Идентификатор пользователя

В некоторых случаях нам нужен идентификатор пользователя. 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}'
  },
  info: {
    USER_LOGIN: 'Пользователь входит в систему и идентификатор пользователя {id}'
  },
  warn: {
    USER_LOGOUT: 'Пользователь выходит из системы и идентификатор пользователя {id}'
  },
  error: {
    USER_LOGIN_FAILED: 'Аутентификация пользователя не удалась и идентификатор пользователя {id}'
  },
  fatal: {
    USER_LOGIN_BLOCKED: 'Вход пользователя заблокирован и идентификатор пользователя {id}'
  }
}
const i18n = {
  zh: {
    USER_LOGIN: 'Пользователь входит в систему и идентификатор пользователя {id}'
  }
}
const logger1 = new Logger({
  code,
  i18n
})

logger1.code('USER_LOGIN', { id: 'USER001' })
// Вы увидите следующий вывод:
// 2020-01-01 00:00:00.000 INFO MAIN - Пользователь входит в систему и идентификатор пользователя 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 - Пользователь входит в систему и идентификатор пользователя 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 - Пользователь входит в систему и идентификатор пользователя USER001

Глобальная настройка языка

process.env.LANGUAGE = 'zh-CN'
import Logger from '@sumor/logger'

const code = {
  info: {
    USER_LOGIN: 'Пользователь входит в систему и идентификатор пользователя {id}'
  }
}
const i18n = {
  zh: {
    USER_LOGIN: 'Пользователь входит в систему и идентификатор пользователя {id}'
  }
}
const logger = new Logger({
  code,
  i18n
})

logger.code('USER_LOGIN', { id: 'USER001' })
// Вы увидите следующий вывод:
// 2020-01-01 00:00:00.000 INFO MAIN - Пользователь входит в систему и идентификатор пользователя 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 - самый высокий уровень, будет выведен

process.env.LOG_LEVEL = 'info' // изменение уровня журналирования в реальном времени
logger.info('Привет, мир!') // info - ниже warn, не будет выведен