Выбор библиотеки логирования C++: что важно

Что может быть проще, чем система логирования? Однако по мере роста проекта становится понятно, что выбор библиотеки логирования C++ — это не такой тривиальный вопрос, как кажется на первый взгляд.

Вероятно, каждый, кто занимался программированием, так или иначе поучаствовал в её создании — хотя бы написав свою первую программу:

#include <stdio.h>

int main()
{
  printf("Hello World!\n");
  return 1;
}

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

Как правило, выбор делается довольно формально: берётся библиотека из предыдущего проекта или первая подходящая из поиска. Но если смотреть на это чуть внимательнее, становится понятно, что различия между такими библиотеками гораздо глубже, чем кажется.

При этом выбор библиотеки логирования C++ не должен основываться только на одном критерии.

Выбор библиотеки логирования C++: ключевые критерии

Производительность

Первое, на что обычно обращают внимание — это скорость работы.

Логирование присутствует практически во всех частях системы. Чем более подробный лог мы хотим иметь, тем чаще выполняется код логирования. В результате даже относительно «вспомогательная» подсистема может начать заметно влиять на производительность.

На практике основные затраты возникают в двух местах: форматирование строки и синхронизация между потоками. Именно там чаще всего находятся горячие точки при профилировании.

По результатам сравнительных тестов популярных библиотек логирования, logme показывает одни из лучших результатов. Это достигается за счёт минимизации работы в hot path и аккуратной организации буферов и backend’ов.

Но сама по себе производительность — это лишь часть картины.

Удобство использования

Логирование пишется постоянно. Поэтому даже небольшие неудобства быстро превращаются в реальную проблему.

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

Например, классический вариант с подходом принятым в С:

Потоковый стиль:

И format-style (если включён std::format):

Такой подход позволяет использовать библиотеку естественно, без адаптации всего проекта под один формат.

Контроль частоты сообщений

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

В данном случае это не требуется.

LogmeI_Once("initialization completed");
LogmeI_Every(1000, "still processing...");

В первом случае сообщение будет выведено только один раз. Во втором — не чаще заданного интервала (в миллисекундах).

Это позволяет оставлять диагностические сообщения прямо в коде, не опасаясь, что при проблеме они превратятся в лавину повторяющихся строк.

Работа «из коробки»

Отдельно стоит отметить, насколько просто начать использовать библиотеку.

Во многих решениях для того, чтобы увидеть первый лог, нужно сначала написать заметный объём конфигурационного кода: создать logger, подключить backend, задать формат и уровни.

В logme это решается. Достаточно подключить заголовок:

И сразу можно писать:

Сообщение уже будет выведено в консоль.

Причём это не просто текст. По умолчанию используется console backend с подсветкой, и сообщения различаются по типу — информационные, предупреждения, ошибки. Это поведение доступно сразу, без дополнительной настройки.

Конфигурирование

При этом простота старта не означает ограниченность.

Для более сложных сценариев logme поддерживает полноценную конфигурацию — как через JSON, так и программно. Можно настраивать каналы, backend’ы, маршрутизацию сообщений, уровни и флаги вывода.

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

Динамическое управление

Ещё одна важная особенность — возможность управлять логированием во время работы приложения.

В рассматриваемой библиотеке есть механизм runtime-контроля, позволяющий включать и отключать каналы, менять уровни логирования и поведение backend’ов без перезапуска процесса.

Это особенно полезно в production-среде. Можно временно включить подробный лог для нужного компонента, собрать информацию и затем вернуть всё обратно, не влияя на остальную систему.

Встроенная трассировка и profiler

Помимо обычного логирования, в logme есть полезные инструменты для трассировки выполнения кода.

Например, можно логировать вход в и выход из функции с печатью параметров на входе и выходе просто написав:

int Calculate(int a, int b) 
{   
  int result{};
  LogmeP(result, ARGS2(a, b));
  result = a + b;

  using namespace std::chrono;
  std::this_thread::sleep_for(5ms);
  return result; 
} 

int main() 
{   
  auto ch = Logme::Instance->GetDefaultChannelPtr();
  auto flags = ch->GetFlags();
  flags.Duration = true;
  ch->SetFlags(flags);

  Calculate(10, 34);
  return 0; 
}

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

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

Итог

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

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

В итоге выбор библиотеки логирования C++ определяется сочетанием производительности, удобства и возможностей управления.

Библиотека logme интересна именно сочетанием этих свойств. Он позволяет начать с минимального кода, не навязывает стиль, даёт инструменты для контроля объёма логов и предоставляет дополнительные возможности вроде трассировки и измерения времени выполнения.

Именно такие детали в итоге и определяют, насколько система логирования будет полезна в реальном проекте.