Расширенное логирование и получение дополнительной отладочной информации

Введение

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

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

В описании ниже в качестве примера указывается раздел реестра [HKEY_CURRENT_USER], который используется при работе только текущего пользователя. Если предполагается задание настроек для всех пользователей операционной системы или настройки задаются при работе с BI-сервером «Форсайт. Аналитическая платформа», то должен использоваться раздел реестра [HKEY_LOCAL_MACHINE].

Лог работы

За формирование и вывод отладочных сообщений отвечает DWORD-параметр WriteToDebugOutput, располагающийся в ветке [HKEY_CURRENT_USER\Software\Foresight\Foresight Analytics Platform\10.0\Log]. По умолчанию данный параметр может отсутствовать в реестре, при этом ядром платформы будут выводиться отладочные сообщения. Для отключения вывода всех отладочных сообщений, кроме информации о загружаемых и выгружаемых библиотеках, создайте параметр WriteToDebugOutput со значением 0.

Для вывода отладочной информации в файл внесите изменения в реестр:

1. Создайте раздел «Log» в ветке реестра [HKEY_CURRENT_USER\Software\Foresight\Foresight Analytics Platform\10.0], если он отсутствует;

2. В разделе «Log» создайте параметры:

• FileName. Строковый параметр, содержащий путь и наименование файла, в который будет выводиться отладочная информация;

• SeverityLevel. DWORD-параметр, содержащий уровень логирования. Для данного параметра могут быть установлены следующие значения:

• 0. Фиксируется вся отладочная информация, генерируемая в ядре «Форсайт. Аналитическая платформа»;

• 1. Фиксируется предупреждения, ошибки и критичные ошибки;

• 2. Фиксируются ошибки и критичные ошибки;

• 3. Фиксируются только критичные ошибки.

• IsolatedByDate. DWORD-параметр, указывающий необходимость разбиения файла по датам. Если параметр создан и имеет значение «1», то каждый день будет создаваться новый файл, в который будет выводиться отладочная информация. Текущая дата будет добавлена к имени файла.

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

Отладочная информация среды разработки

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

1. Убедитесь, что в реестре содержится раздел «Log» с параметрами FileName и SeverityLevel.

Примечание. Отладочная информация среды разработки выводится, если для параметра SeverityLevel установлено значение «0».

2. Добавьте следующие параметры:

• в ветке [HKEY_CURRENT_USER\Software\Foresight\Foresight Analytics Platform\10.0\Debug] создайте DWORD-параметры и установите им значение «1»:

• GCTrace. Необходимость регистрации всех сообщений сборщика мусора;

• DisableMetabaseSqlLog. Отключение вывода в отладочную информацию SQL-запросов к системным таблицам репозитория, которые формируются при обращении к объектам репозитория.

• в ветке [HKEY_CURRENT_USER\Software\Foresight\Foresight Analytics Platform\10.0\DevEnv] создайте DWORD-параметры и установите им значение «1»:

• DevEnvDebug. Фиксация информации о создании компонентов;

• DevEnvParserDebug. Фиксация информации парсера среды разработки.

• в ветке [HKEY_CURRENT_USER\Software\Foresight\Foresight Analytics Platform\10.0\Fore] создайте параметры:

• CheckLeaks. DWORD-параметр включает проверку наличия утечек памяти при закрытии репозитория в настольном приложении. Для включения проверки установите параметру значение «1». Если есть утечки, то будет выведен диалог сохранения утечек в файл;

• LeaksGraphFile. Путь и наименование файла, в который будут сохраняться список утечек памяти при закрытии репозитория. Если параметр задан, то диалог не выводится, а происходит сохранение в указанный файл. Файл создаётся в формате TGF (trivial graph format);

• ExternRefLogging. DWORD-параметр включает логирование изменения внешних ссылок при входе в репозиторий;

• ExtRefChangesFile. Путь и наименование файла, в который будет сохраняться лог изменения внешних ссылок объектов при закрытии репозитория. Файл создаётся в формате TXT.

Отладочная информация планировщика задач

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

1. Убедитесь, что в реестре содержится раздел «Log» с параметрами FileName и SeverityLevel.

Примечание. Отладочная информация планировщика задач выводится, если для параметра SeverityLevel установлено значение «0».

2. Создайте раздел «Scheduler» в ветке реестра [HKEY_CURRENT_USER\Software\Foresight\Foresight Analytics Platform\10.0], если он отсутствует;

3. В разделе «Scheduler» создайте DWORD-параметр и установите ему значение «3»:

• Trace. Фиксация трассировочных, отладочных и информационных сообщений, предупреждений и всех видов ошибок.

В ОС Linux для фиксации отладочной информации планировщика задач в файле задайте раздел <LOG> в структуре конфигурационного файла.