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

Введение

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

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

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

Лог работы

За формирование и вывод отладочных сообщений отвечает параметр WriteToDebugOutput типа REG_DWORD, располагающийся в ветке [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. Параметр типа REG_DWORD, содержащий уровень логирования. Для данного параметра могут быть установлены следующие значения:

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

Важно. Фиксация всей отладочной информации влияет на производительность платформы и значительно увеличивает объём отладочной информации в файле.

• 1. Уровень логирования - Debug. Дополнительно к уровню Info фиксируется информация об аутентификации пользователей по протоколу LDAP, если используется доменная/интегрированная доменная аутентификация;

• 2. По умолчанию. Уровень логирования - Info. Основной способ вывода отладочной информации, включающий в себя уровень Warning и информацию о длительности выполнения операций, параметрах запросов к репозиторию;

• 3. Уровень логирования - Warning. Дополнительно к уровню Error фиксируются предупреждения;

• 4. Уровень логирования - Error. Дополнительно к уровню Critical фиксируются ошибки;

• 5. Уровень логирования - Critical. Фиксируются только критичные ошибки.

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

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

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

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

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

Примечание. Отладочная информация среды разработки выводится, если для параметра SeverityLevel установлено значение «0», «1» или «2». Дополнительно фиксируются SQL-запросы к системным таблицам репозитория, которые формируются при обращении к объектам репозитория.

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

• в ветке [HKEY_CURRENT_USER\Software\Foresight\Foresight Analytics Platform\10.0\Debug] создайте параметр GCTrace типа REG_DWORD со значением «1». Параметр предназначен для регистрации всех сообщений сборщика мусора;

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

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

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

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

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

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

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

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

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

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

Важно. Планировщик и BI-сервер необходимо запускать на разных серверах.