rlog

Введение

Система ведения журналов для фронтенда.

Инструкция по установке

npm i rubylog

Уровни журнала

В системе есть 5 уровней журнала: NONE, DEBUG, INFO, WARN и ERROR. Используйте их в зависимости от ситуации.

Для настройки используйте внешний файл, чтобы можно было легко изменить конфигурацию на месте.

• logger.trace(msg): выводит трассировку стека с уровнем 0.
  • • logger.debug(msg): выводит журнал отладки с уровнем 1.
      • Содержит подробную информацию о процессе выполнения программы и текущем состоянии переменных.
• logger.info(msg): выводит информационный журнал с уровнем 2.
  • Записывает значимые события и нормальное состояние программы, например, получение запроса или успешное выполнение.
• logger.warn(msg): выводит предупреждающий журнал с уровнем 3.
  • Описывает неожиданные условия выполнения, которые могут привести к проблемам в будущем. Например, низкий уровень свободного места на диске.
• logger.error(msg): выводит журнал ошибок с уровнем 4.
  • Регистрирует исключения во время выполнения и непредвиденные ошибки, требующие немедленного внимания. Ошибки, связанные с управлением системой, требуют вмешательства администратора. Ошибки пользователя, такие как неправильный ввод данных, не относятся к этой категории. Также регистрируются ошибки, связанные с тайм-аутами при запросах к бэкенду, чтению файлов или работе с базой данных.

Способы регистрации сообщений для разных уровней:

1. Trace: вывод в консоль.
2. Debug: вывод в консоль.
3. Info: сохранение в журнале.
4. Warn: сохранение в журнале.
5. Error: сохранение в журнале и отправка в реальном времени.

Использование

Ведение журнала:

//level: уровень журнала, log: содержимое журнала  
rlog.log(level, log);
//настраиваемые параметры журнала
const debugObj={
        info:'Debug信息',
        module:'视图1',
        debug:{'cardData':cardData},
        codeline:67,
        file:'view_overview.jsx'
}
rlog.log('info',"можно указать только текстовое сообщение");

rlog.info('можно выводить сообщения напрямую по уровню');

rlog.log('debug',debugObj);

//предопределённые методы журнала

rlog.getReactDrawTime('виджет');   //получить время рендеринга модуля react

rlog.event(e);      //вывести одно событие в журнал

Вклад

1. Форкните этот репозиторий.
2. Создайте ветку Feat_xxx.
3. Отправьте код.
4. Создайте запрос на слияние (Pull Request).