Логгер

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

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

Установка

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('Привет, Мир!')
// Вы увидите следующий вывод:
// 2020-01-01 00:00:00.000 TRACE MAIN - Привет, Мир!

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

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

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 - самый высокий уровень, будет выведен

Когда вы используете эту библиотеку в нескольких библиотеках, вы можете использовать следующий код:

import Logger from '@sumor/logger'
const logger = new Logger()
process.env.LOG_LEVEL = 'info'

logger.trace('Привет, Мир!') // trace - самый низкий уровень, не будет выведен
logger.debug('Привет, Мир!') // debug - ниже уровнем, чем info, не будет выведен
logger.info('Привет, Мир!') // info имеет такой же уровень, как и info, будет выведен
logger.warn('Привет, Мир!') // warn - выше уровня, чем info, будет выведен
logger.error('Привет, Мир!') // error - выше уровня, чем info, будет выведен

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