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

ПРИМЕЧАНИЕ. Если в компании используются мобильные приложения Solo и Jazz, администратор может включить дополнительное логирование сервиса NOMAD для получения детальной информации о работе сервера.

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

Лог-файлы ведутся в структурированном виде в формате JSON. Это обеспечивает их единый формат и упрощает автоматизированный анализ.

Для просмотра лог-файлов серверных компонентов рекомендуется использовать утилиту DirectumLogViewer. Она отображает записи лог-файлов в удобном для чтения виде. Кроме того, утилита подсвечивает сообщения с уровнями логирования Debug и Error, а также позволяет фильтровать записи по уровню логирования и по тексту сообщений.

Скачайте утилиту с репозитория GitHub и запустите ее. При первом запуске укажите папку и список открываемых лог-файлов. В списке задаются имена лог-файлов с использованием макропеременных. Например, ${machinename}.WebServer.${shortdate} – лог файлы веб-сервера, которые в своем имени содержат имя компьютера и дату. По кнопке можно в любой момент вернуться к настройкам и изменить список лог файлов или выбрать другую папку с ними.

Для просмотра лог-файлов серверных компонентов можно использовать утилиты, которые открывают текст в форматированном виде: Notepad++, Visual Studio Code, LogExpert и т.п. Эти утилиты можно использовать как альтернативу или дополнение к DirectumLogViewer.

Для просмотра лог-файлов сервиса NOMAD рекомендуется использовать утилиты LogViewPlus или LogExpert.

Примеры использования Notepad++ при анализе лог-файлов:

•чтобы найти все сообщения определенного уровня логирования, в окне поиска введите "Error" (с кавычками) и нажмите на кнопку Найти все в текущем документе. Найденные строки отобразятся в нижней части окна;

•чтобы найти сообщения сразу в нескольких открытых лог-файлах, в окне поиска заполните параметры и нажмите на кнопку Найти все во всех открытых документах;

•для удобного просмотра объемных сообщений, которые выходят за границы экрана, включите перенос строк;

•если надо расширить стандартную функциональность приложения, воспользуйтесь плагином JSTool. Он позволяет отформатировать отдельную строку или все строки в лог-файле (CTRL+ALT+M), а также открыть сообщение в отдельной области просмотра (CTRL+ALT+J).

Конвертация лог-файлов

С помощью утилиты DirectumLogConverter можно сконвертировать лог-файл в простой текст или в формат CSV. Простой текст подходит для чтения в любом текстовом редакторе. Формат CSV позволяет открыть лог-файл в приложении Microsoft Excel и использовать все его возможности для анализа.

Чтобы сконвертировать лог-файл, скачайте утилиту с репозитория GitHub и запустите ее через командную строку. Команда запуска зависит от варианта конвертации:

•в простой текст:

dlc <Исходный лог-файл>.log

•в формат CSV:

dlc –c <Исходный лог-файл>.log

После конвертации создается файл <Имя файла>_converted.log.

Рекомендации по хранению лог-файлов

При активной работе системы быстро растет количество лог-файлов. Чтобы со временем лог-файлы не заняли все свободное место на диске, рекомендуется:

•хранить лог-файлы на отдельном диске, свободном от файлов операционной системы и исполняемых файлов программ. Иначе, если диск переполнится, Directum RX перестанет записывать новые лог-файлы. Работа операционной системы при этом не пострадает;

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

Очистка лог-файлов  

Чтобы настроить регулярную очистку лог-файлов, в планировщике заданий операционной системы настройте выполнение по расписанию команды do clean_logs:

do clean_logs --config_path="<Путь до config.yml>" --skip_last_modified_days="<Количество дней>"

Где:

--config_path – путь до конфигурационного файла, в котором указана папка с лог-файлами. Если путь не указан, то по умолчанию используется файл config.yml в папке с Directum Launcher;

--skip_last_modified_days – количество дней, за которое файлы нужно оставить. Если количество дней не указано, то остаются лог-файлы, созданные за последние 7 дней. Чтобы удалить все лог-файлы, в качестве значения ключа укажите 0.

Пример команды:

do clean_logs --config_path="D:\DirectumLauncher\etc\config.yml" --skip_last_modified_days="7"

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

© Компания Directum, 2024