EasyLogger

Easylogger

---

1. Введение

EasyLogger-это сверхлегкий вес (ROM <1,6K, RAM <0,3K), высокопроизводительная библиотека журналов C/C ++, которая идеально подходит для ресурсов, чувствительных к программным проектам, таким как: продукты IoT, носимые устройства, умные дома и многое другое. По сравнению с известными библиотеками журналов C/C ++, такими как Log4C и ZLOG, EasyLogger имеет более простые функции и предоставляет меньше интерфейсов пользователям, но он будет быстро начаться.

1.1 Основные функции

• Поддерживает пользовательские методы вывода (например: терминал, файл, база данных, последовательный порт, 485, Flash ...);
• Содержание журнала может включать уровни, временные метки, информацию о потоке, информацию о процессе и т. Д.;
• Вывод журнала разработан в виде метода безопасного потока и поддерживает асинхронный выход и буферизованные выходные режимы;
• Поддерживает несколько операционных систем (RT-Thread, UCOS, Linux, Windows, Nuttx ...), а также поддерживает платформы с голой металлической;
• Журналы поддерживают необработанный формат и поддержку Hexdump ;
• Поддержать динамическую фильтрацию с помощью тегов , уровней и ключевых слов ;
• Журналы на всех уровнях поддерживают разные цвета для отображения;
• Сильно расширяется, поддерживает расширение новых функций в виде плагинов.

Объяснение существительных:

• 1. RAW FORMAT: неформатированный исходный журнал.
• 2. Теги: В программном обеспечении вы можете установить теги для журналов, которые необходимо печатать в соответствии с файлами, модулями, функциями и т. Д., Чтобы реализовать классификацию журналов.

1.2 Плагин

• 1. Flash: используйте интерфейс операции Flash, предоставленный библиотекой EasyFlash, и напрямую храните журналы в Flash без необходимости в файловой системе.
• 2. Файл: поддерживает передачу файла, сохранение цикла файла и другие функции, связанные с выводом журнала файла.
• 3. Следите за обновлениями ...

1,3 звезда и вилка

Позже я предоставлю больше плагинов. Мы также очень рады разработать и разработать более практичные плагины и функции для улучшения easylogger (GitHub | Oschina | Кодирование) . Если вы думаете, что этот проект с открытым исходным кодом великолепен, вы можете щелкнуть Star в правом верхнем углу домашней страницы проекта и порекомендовать его больше друзей.

2. Используйте

2.1 Конфигурация параметров

EasyLogger имеет свойства, такие как метод фильтрации, выходной формат и выходной переключатель.

• Метод фильтрации поддерживает фильтрацию в соответствии с метками, уровнями и ключевыми словами;
• Вывод журнала может быть включен/выключен динамически;
• Динамические и статические выходные уровни могут быть установлены
  • Статический: переключатель первого уровня, определяемый макросами, используемый на стадии компиляции;
  • Динамическая: вторичный переключатель используется на стадии работы через интерфейс API.

Примечание. В настоящее время методы конфигурации параметров и вывода являются режимом Singleton, то есть только один метод конфигурации поддерживается во всем мире. В этом режиме программное обеспечение будет проще, но оно не может поддерживать сложные методы вывода.

2.2 Уровень выхода

См. Android Logcat, самый высокий уровень - 0 (Assert), а самый низкий уровень - 5 (словес).

 0.[A]：断言(Assert)
1.[E]：错误(Error)
2.[W]：警告(Warn)
3.[I]：信息(Info)
4.[D]：调试(Debug)
5.[V]：详细(Verbose)

2.2.1 Вывод красочные журналы

Цветовой эффект по умолчанию журналов на каждом уровне выглядит следующим образом. Пользователи также могут устанавливать цвета и стили шрифтов журналов на elog_cfg.h в соответствии с их предпочтениями.

2.3 Выходная фильтрация

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

ПРИМЕЧАНИЕ. Располовный формат и журналы формата Hexdump не поддерживают теги и фильтрацию ключевых слов.

2.4 выходной формат

Выходной формат поддерживает: Уровень, время, метка, информация о процессе, информация по потоке, путь файла, номер строки, имя метода. Каждый уровень приоритета может установить выходной формат независимо.

2.5 Вывод метод

Через пользовательский портирование может быть поддержан любой метод вывода. Однако для новых функций, которые могут быть введены в определенном методе вывода, его необходимо реализовать с помощью плагинов, таких как передача файла, поиск журналов флэш-памяти и т. Д. Больше плагинов будет открытым исходным кодом позже. Ниже приведено краткое сравнение некоторых сценариев использования вывода:

• Терминал: удобно для пользователей, чтобы просмотреть динамически и не иметь функций хранения;
• Файлы и Flash: оба имеют функции хранения, и пользователи могут просматривать исторические журналы. Тем не менее, метод файла требует поддержки файловой системы, а метод Flash более подходит для небольших встроенных устройств без файловых систем.

2.6 Демо

2.6.1 Основные функции

На следующем рисунке показаны команды ввода в клемме для управления выходными и фильтрами настройки журнала, которые более интуитивно демонстрируют основные функции easyLogger.

• Демо-путь: demoosrt-threadstm32f10x
• Документация API: docszhapikernel.md
• Миграционная документация: docszhportkernel.md

2.6.2 Flash Log (сохранить журнал для Flash)

Следующий процесс заключается в выводе журналов через консоль и сохраняет выходные журналы в Flash. Перезапустите и прочитайте последний сохраненный журнал и, наконец, очистите журнал Flash.

• Демо-путь: demoosrt-threadstm32f10x
• Документация API: docszhapiflash.md
• Документация по миграции: docszhportflash.md

2.6.2 Журнал файлов (сохранить журнал в файл)

Плагин File позволяет автоматически сохранять журналы в файлы. Каждый файл может быть размером.

3. Документация

Для конкретного содержания см. Файл в разделе docszh . Обязательно используйте его после прочтения документа .

4. позже

• Флэш -хранение: добавьте функции хранения и чтения журнала в EasyFlash, позволяя easyLogger беспрепятственно соединяться с ним. Упростить хранение журналов в не файльных системах и иметь функцию исторического поиска журналов;
• Файл конфигурации: файл конфигурации под файловой системой;
• Передача файла: передача файла поддерживается емкостью и временем в файловой системе;
• Помощник журнала: Разработайте кроссплатформенный помощник, совместимый с системами Linux, Windows и Mac. Фронт: HTML5 + Bootstrap + AngularJS + NW.JS, Back-end: Rust + Iron + Rust-Websocket + Serial-RS;
• Асинхронный вывод: В настоящее время вывод журнала и код пользователя синхронизированы. Однако на платформах с низкой скоростью выхода скорость работы программного обеспечения будет снижена из -за добавления функций регистрации. Следовательно, асинхронный вывод будет добавлен позже, а фильтрация ключевых слов также может быть помещена в асинхронный выход;
• Arduino: добавил Arduino Lib и предоставил свою демонстрацию;

5. разрешение

MIT Copyright (c) [email protected]