Формат лог файлов#

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

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

Для просмотра и редактирования лог файлов предназначена утилита «Просмотр Логов».

Формат имени файла

Лог файл имеет уникальное имя для каждой программы IngortechSCADA. Как правило, имя лог файла совпадает с именем программы, которая в него пишет. Некоторые программы, такие как сервер РТС поддерживают указание произвольного имени лог файла с использованием настроек программы или ключей командной строки.

Имя лог файла имеет следующий формат:

ИМЯ_ГГГГ-ММ-ДД[.ЧИСЛО].log

Где:

ИМЯ:: Уникальное имя лог файла программы.
ГГГГ-ММ-ДД:: Дата заполнения лог файла в формате: год-месяц-день.
ЧИСЛО:: Номер лог файла в серии. Используется, если лог файл был перемещен из-за ограничений указанных в файле HLOG.
log:: Расширение файла.

Содержимое лог файла

Лог файл хранит данные не более чем за сутки и автоматически создается при работе программы. Т.е. при непрерывной работе данные в нем будут сохранены за период с 00:00 по 23:59. При наступлении новых суток будет автоматически создан лог файл с новой датой в названии.

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

Формат данных

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

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

Пример данных лог файла:

07-11-2022 20:23:04.0573 00001A50 000024BC 00000002 CFG: Check DB integrity...
07-11-2022 20:23:04.0612 00001A50 000024BC 00000002 Элемент (idx=20) содержит недопустимые символы в имени. Имя исправлено на [Команды управления АПТВxx]
07-11-2022 20:23:04.0613 00001A50 000024BC 00000002 Элемент (idx=21) содержит недопустимые символы в имени. Имя исправлено на [Команды управления оборудованиемxx]
07-11-2022 20:23:04.0613 00001A50 000024BC 00000002 CFG restriction: 1

Каждая строка имеет одинаковый формат и состоит из набора элементов, разделенных символом с кодом 32 (пробел):

07-11-2022 20:23:04.0612 00001A50 000024BC 00000002 Элемент (idx=20) содержит недопустимые символы в имени. Имя исправлено на [Команды управления АПТВxx]

07-11-2022 20:23:04.0612

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

00001A50

Идентификатор процесса программы.

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

000024BC

Идентификатор потока.

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

00000002

Код ошибки.

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

Сообщение

Сообщение сохраненное программой. В данном примере это текст

Элемент (idx=20) содержит недопустимые символы в имени. Имя исправлено на [Команды управления АПТВxx]