Журналирование

Журналирование — это процесс записи хронологии событий, сообщений или действий программного обеспечения или пользователей, происходящих в системе, в специальные лог-файлы заданного формата. События записываются в режиме, при котором каждая новая запись добавляется в конец файла, а сам файл называется оперативным. При достижении/превышении определенного размера файла содержимое файла автоматически копируется в исторический файл.

Для просмотра лог-файлов рекомендуется использовать специальные утилиты по работе с логами, например, Log File Navigator (lnav).

Для действий, происходящих во внешних системах, например, БД, системы хранения контента, веб-сервера, службы каталогов, события в журнал не регистрируются.

Параметры лог-файлов

Оперативный и исторические файлы — это файлы формата JSONL, которые создаются автоматически при установке продукта и хранятся на устройствах, на которых они были сгенерированы, в каталогах:

  • /var/log/osmax/core — каталог для хранения файлов модуля бэкенда osmax-core;

  • /var/log/osmax/provisioner — каталог для хранения файлов модуля osmax-provisioner;

  • /var/log/osmax/salt/master — каталог для хранения файлов сервера управления (master);

  • /var/log/osmax/salt/minion — каталог для хранения файлов агентов (minions).

Имена файлов задаются согласно шаблонам:

  • шаблон имени оперативного файла:

    log{-applicationAlias}.log

    Где applicationAlias — название приложения, например: log-osmax-core.log.

  • шаблон имени исторического файла:

    log{-applicationAlias}.log.yyyy-MM-dd.{N}

    Где:

    • N — индекс файла;

    • applicationAlias — название приложения;

    • yyyy-MM-dd — дата ротации файла.

Исторические лог-файлы архивируются и имеют расширение .gz.

По умолчанию предельный размер оперативного файла составляет 10 МБ. Для лог-файлов бэкенда при необходимости можно задать другое значение. Для лог-файлов сервера управления (master) и агентов (minions) значение параметра не конфигурируется.

Описание полей лог-файла

Код поля Описание

Timestamp

Время фиксации события приложением/сервисом в формате: 2024-04-26T12:37:23.000Z

Level

Уровень логирования; возможные значения:

  • бэкенд:

    • ALL  —  все сообщения будут записываться в лог-файл;

    • INFO — информационные сообщения о ходе работы приложения/сервиса;

    • WARN — сообщения, содержащие предупреждение о потенциальной проблеме или необычном состоянии, которое не является ошибкой, но требует внимания;

    • DEBUG — сообщения, содержащие отладочную информацию;

    • TRACE — сообщения, содержащие детальную отладочную информацию;

    • ERROR — сообщения об ошибке, которая привела к некритическому сбою;

    • FATAL — сообщения об ошибке, которая привела к критическому сбою;

    • OFF — сообщения в лог-файл записываться не будут;

  • модуль координации (SaltStack):

    • all —  все сообщения будут записываться в лог-файл;

    • warning — сообщения, содержащие предупреждение о потенциальной проблеме или необычном состоянии, которое не является ошибкой, но требует внимания;

    • info — информационные сообщения о ходе работы модуля;

    • profile — профильная информация о производительности модуля координации (SaltStack);

    • debug — сообщения, содержащие отладочную информацию;

    • trace — сообщения, содержащие детальную отладочную информацию;

    • garbage — сообщения, содержащие детальную (чем trace) отладочную информацию;

    • error — сообщения об ошибке, которая привела к некритическому сбою;

    • critical — сообщения об ошибке, которая привела к критическому сбою;

    • quiet — сообщения в лог-файл записываться не будут

AppName

Логическое наименование модуля, инициировавшего событие; возможные значения:

  • osmax-core — бэкенд (ядро);

  • osmax-provisioner — бэкенд (модуль установки ОС);

  • salt-master — сервер управления (master);

  • salt-minion — агент (minion)

HostName

Наименование устройства, на котором производится запись событий.

В текущей версии продукта значение HostName будет указываться только для событий бэкенда

Message

Сообщение, описывающее произошедшее событие