Все о лог-файлах DIRECTUM

8 3

Публикую этот пост для тех, кто не видел статью базы знаний, написанную мной в 2009 году. Бонусом к статье является скрипт GetDirectumLogs.vbs, который копирует лог-файлы DIRECTUM (подробности в последнем разделе статьи).

Введение

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

  • Клиентская часть DIRECTUM
  • Служба WorkFlow
  • Сервер сеансов
  • Служба файловых хранилищ
  • Службы ввода и преобразования (DCTS)
  • Утилита SASystemActivator
  • Утилита SAKeyRegistration
  • Утилита STConverter
  • Репликация
  • Сервер веб-доступа к DIRECTUM
  • Расширения DIRECTUM для SharePoint
  • Набор средств интеграции DIRECTUM
  • Программы установки DIRECTUM

Клиентская часть DIRECTUM

Имя лог-файла
*.sbrte.log - документы, ЗЗУ, справочники, сценарии, отчеты
*.sbdte.log - утилиты экспорта-импорта
*.sblogon.log - служба паролей
*.sbsce.log - сценарии, запускаемые SAJobRunner
*.sblauncher.log - загрузка пользовательских компонент
*.isbexec.log - обработчик ISB-файлов
*.sajobrunner.log - утилита запуска агентов
*.sblanguagesetup.log - утилита установки текущего языка системы
* - <имя компьютера>.is-builder
 
Путь до лог-файла
Задается в ходе установки клиентской части DIRECTUM.
Путь сохраняется в параметре «LogPath» файла «LogSettings.xml», который находится в папке «%ALLUSERSPROFILE%\Application Data\NPO Computer\IS-Builder». Если параметр «LogPath» пуст или файла настроек нет или не удается записать лог-файл в заданную папку, лог-файл записывается в папку профиля пользователя «%APPDATA%\NPO Computer\IS-Builder». Если папки профиля пользователя не доступна (не существует), то лог-файл записывается в каталог «%SystemDrive%\Documents and Settings\Default User\Application Data\NPO Computer\IS-Builder» (для Windows XP, 2000, 2003) или «%SystemDrive%\Users\Default\AppData\Roaming\NPO Computer\IS-Builder» (для Windows Vista).
 
В каких случаях записывается информация
При возникновении ошибок в ходе работы клиентской части DIRECTUM.
 
Фиксируемая информация
Дата ошибки
Время ошибки
ИД процесса
Код системы
Логин пользователя
Тип исключения
Текст сообщения об ошибки
Стек вызова метода, который повлек ошибку
Процесс или приложение, которое вызвало ошибку
Версия системы, в которой вызвана ошибка
Тип и код компоненты, при работе с которой вызвана ошибка
 
Примечание
Клиентская часть DIRECTUM ведет лог-файл профайлинга, предназначенный для мониторинга производительности системы. Подробно о механизме профайлинга написано в разделе «Профайлинг производительности системы» руководства администратора.
Также свои лог-файлы могут вести прикладные сценарии DIRECTUM. Более подробная информация об этом находится в описании сценариев.
 
См. также:
Раздел «Log-файлы» руководства администратора DIRECTUM.

Служба WorkFlow

Имя лог-файла
*.sbworkflowproc.log
*.sbworkflowsrv.log
* - <имя компьютера>.is-builder
 
Путь до лог-файла
Аналогично клиентской части DIRECTUM.
 
В каких случаях записывается информация
*.sbworkflowproc.log - при возникновении ошибок в ходе обработки задач.
*.sbworkflowsrv.log - при возникновении ошибок в работе службы Workflow (например, «Система на сервере XXX и базе YYY не обслуживается службой», ошибки при старте/остановке службы).
 
Фиксируемая информация
Аналогично клиентской части DIRECTUM.
 
Примечание
Также служба SBWorkflowSrv пишет информацию в журнал событий Windows. Посмотреть журнал можно с помощью оснастки Windows «Просмотр событий»: категория - Приложение, источник - SBWorkflowProcessingServer.

Сервер сеансов

Протоколы сервера сеансов

Имя файла протокола
Сервер сеансов может вести два протокола: протокол обращений к серверу сеансов и протокол регистрации пользователей. Имена протоколов задаются вместе с путями до них.
 
Путь до файлов протокола
Задается в параметрах файла «SBSessionSrvSettings.xml», который находится в папке с сервером сеансов.
 
В каких случаях записывается информация
В зависимости от настроек, указанных в файле «SBSessionSrvSettings.xml».
 
Фиксируемая информация
протокол обращений к серверу сеансов - количество обращений к серверу сеансов по протоколу TCP/IP;
протокол регистрации пользователей - когда и какие пользователи входили в систему, и когда выходили из нее, а также указывается количество свободных лицензий в каждый момент времени.
 
См. также
Раздел «Файл SBSessionSrvSettings.xml» руководства администратора DIRECTUM.

Лог-файлы сервера сеансов

Имя лог-файла
<имя компьютера>.is-builder.sbsessionsrv.log
 
Путь до лог-файла
Аналогично клиентской части DIRECTUM.
 
В каких случаях записывается информация
При возникновении ошибок в ходе работы сервера сеансов.
 
Фиксируемая информация
Аналогично клиентской части DIRECTUM.
 
Примечание
Также служба SBSessionSrv пишет информацию в журнал событий Windows. Посмотреть журнал можно с помощью оснастки Windows «Просмотр событий»: категория - Приложение, источник - SBSessionServer.

Служба файловых хранилищ

Имя лог-файла
<имя компьютера>.is-builder.sbfilestorageserver.log
 
Путь до лог-файла
Аналогично клиентской части DIRECTUM.
 
В каких случаях записывается информация
При возникновении ошибок в ходе работы службы файловых хранилищ.
 
Фиксируемая информация
Аналогично клиентской части DIRECTUM.
 
Примечание
Также служба SBSessionSrv пишет информацию в журнал событий Windows. Посмотреть журнал можно с помощью оснастки Windows «Просмотр событий»: категория - Приложение, источник - SBFileStorageService.

Службы ввода и преобразования (DCTS)

Имя лог-файла
Лог-файл служба ведет в журнале событий Windows.
 
Путь до лог-файла
Посмотреть журнал можно с помощью оснастки Windows «Просмотр событий», имя журнала «DCTS EventLog».
 
В каких случаях записывается информация
В зависимости от настроек, указанных в файле «LogSettings.config», который находится в папке со службами (можно включать/выключать запись ошибок, предупреждений и информационных сообщений).
 
Фиксируемая информация
Для ошибок фиксируется полный стек, в других случаях - только сообщение.
 
См. также
Раздел «Протокол работы служб ввода» руководства по службам ввода документов DIRECTUM.

Утилита SASystemActivator

Имя лог-файла
<имя компьютера>.is-builder.sasystemactivator.log
 
Путь до лог-файла
Аналогично клиентской части DIRECTUM.
 
В каких случаях записывается информация
При возникновении ошибок в ходе работы утилиты.
 
Фиксируемая информация
Аналогично клиентской части DIRECTUM.

Утилита SAKeyRegistration

Имя лог-файла
<имя компьютера>.is-builder.sakeyregistration.log
 
Путь до лог-файла
Аналогично клиентской части DIRECTUM.
 
В каких случаях записывается информация
При возникновении ошибок в ходе работы утилиты.
 
Фиксируемая информация
Аналогично клиентской части DIRECTUM.

Утилита STConverter

Имя лог-файла
<имя компьютера>.is-builder.stconverter.log - лог-файл утилиты STConverter
stconverter.log - протокол конвертации
 
Путь до лог-файла
Путь до лог-файла утилиты определяется аналогично клиентской части DIRECTUM.
Путь до протокола конвертации указывается в ходе работы утилиты STConverter.
 
В каких случаях записывается информация
<имя компьютера>.is-builder.stconverter.log - при возникновении ошибок в ходе работы утилиты STConverter.
stconverter.log - всегда.
 
Фиксируемая информация
<имя компьютера>.is-builder.stconverter.log - аналогично клиентской части DIRECTUM.
stconverter.log - последовательность действий, которая выполняется в ходе конвертации.

Репликация

Протоколы репликации

Имя файла протокола
ID_<ИД сеанса>_<прием данных от вторичного сервера>_<код вторичного сервера> - протокол приема данных от вторичного сервера
ID_<ИД сеанса>_<прием данных от главного сервера>_<код главного сервера> - протокол приема данных от главного сервера
ID_<ИД сеанса>_<передача данных на вторичный сервер>_<код вторичного сервера> - протокол передачи данных на вторичный сервер
ID_<ИД сеанса>_<передача данных на главный сервер>_<код главного сервера> - протокол передачи данных на главный сервер
 
Путь до файлов протокола
Располагаются в папке «<Каталог репликации>\<Код сервера>\Protokol» каталога репликации. Каталог репликации задается в параметрах обмена данными в компонентах «Обмен данными с главным сервером» и «Обмен данными со вторичным сервером» или в компоненте «Агент репликации».
 
В каких случаях записывается информация
Всегда.
 
Фиксируемая информация
В протоколе фиксируется результат передачи/приема действий изменения данных.

Лог-файл репликации

Имя лог-файла
<имя компьютера>.err
 
Путь до лог-файла
Задается в параметре «MB_ALogPath» в установках системы DIRECTUM. Если значение данного параметра не указано, то лог располагается в папке, куда установлена клиентская часть системы DIRECTUM.
 
В каких случаях записывается информация
Необходимость ведения лога задается в параметре «MB_AExistLog».
 
Фиксируемая информация
В лог-файле фиксируются ошибки в работе компонент репликации.

Сервер веб-доступа к DIRECTUM

Имя лог-файла
Задается вместе с путем до лог-файла. Как правило, лог-файл называется «log.log».
 
Путь до лог-файла
Задается в ходе установки Сервера веб-доступа к DIRECTUM.
Путь сохраняется в параметре «LogFileName» файла «Web.config» (для версии 4.5 и выше) или «Settings\Settings.xml» (для версии ниже 4.5), который находится в корневом каталоге веб-узла. Как правило, лог-файл располагается в папке «C:\Inetpub\wwwroot\Directum\logs».
 
В каких случаях записывается информация
При возникновении ошибок и предупреждений в ходе работы веб-доступа.
 
Фиксируемая информация
Дата ошибки
Время ошибки
Тики процессора
Тип сообщения: ошибка/предупреждение
Библиотека породившая исключение (для ошибок)
Пользователь
URL
IP-адрес клиента
Текст сообщения
Стек вызова
Строгое имя сборки
ИД сессии
Тип браузера
 
См. также
Раздел Утилита конфигурирования сервера веб-доступа \ Закладка «Общие» книги «Компоненты системы DIRECTUM».

Расширения DIRECTUM для SharePoint

Имя лог-файла
Задается вместе с путем до лог-файла. Как правило, лог-файл называется «error.log».
 
Путь до лог-файла
Задается в ходе установки Расширений DIRECTUM для SharePoint.
Путь сохраняется в параметре «LogPath» файла «Settings.xml», который находится в корневом каталоге веб-узла. Как правило, лог-файл располагается в папке «C:\Inetpub\wwwroot\wss\VirtualDirectories\80\logs».
 
В каких случаях записывается информация
При возникновении ошибок в ходе работы расширений.
 
Фиксируемая информация
Аналогично серверу веб-доступа.

Набор средств интеграции DIRECTUM

Имя лог-файла
*_export_log.txt - выгрузка из DIRECTUM
*_import_log.txt - загрузка в DIRECTUM
* - код записи справочника «Интегрированные системы».
 
Путь до лог-файла
Указан в параметре «Протоколы» на закладке «Настройки обмена данными» записи справочника «Интегрированные системы».

Программы установки DIRECTUM

Имя лог-файла
Задается ключом командной строки /L утилиты msiexec.exe (setup.exe). Если ключ не указан, но настроена политика безопасности Windows для ведения логов установки, файл лога будет создан в папке «%TEMP%» со случайным уникальным именем «MSI*.LOG». Подробнее можно прочитать в статье Logging.
 
Путь до лог-файла
Аналогично имени лог-файла.
 
В каких случаях записывается информация
Когда настроено ведение лог-файла.
 
Фиксируемая информация
В зависимости от ключей, переданных в командной строке или настроек политики безопасности Windows. По-умолчанию в лог-файле фиксируются основные действия установщика. Подробнее о ключах установщика можно прочитать в статье Command-Line Switches for the Microsoft Windows Installer Tool.
 
Примечание
Для запуска программы установки Расширений DIRECTUM для SharePoint с ведением лог-файла необходимо сначала разархивировать установочный файл, после чего по аналогии с другими программами установки, запустить распакованный файл setup.exe с нужными командами.
 
См. также

Скрипт для получение лог-файлов DIRECTUM

Название
GetDirectumLogs.vbs
 
Описание
Копирует лог-файлы DIRECTUM текущего компьютера в <Указанная папка>\DirectumLogs (если не указана, то в <Текущая папка>\DirectumLogs).

Использование
GetDirectumLogs.vbs [-i] [-w[=<имя веб-узла веб-доступа>]] [-p[=<имя веб-узла УПЭ>]] [-o=<путь до выходной папки>]

Параметры
-i  Копировать лог-файлы IS-Builder (клиентской части, WorkFlow, сервера сеансов, DSS, SASystemActivator, SAKeyRegistration)
-w[=<имя веб-узла веб-доступа>]  Копировать лог-файлы веб-доступа. Если имя узла не указано, то используется имя по умолчанию
-p[=<имя веб-узла УПЭ>]  Копировать лог-файлы УПЭ. Если имя узла не указано, то используется имя по умолчанию
-o=<путь до выходной папки>  Путь до папки , в которую копируются лог файлы

GetDirectumLogs.vbs (10,98 Кб)

8
Авторизуйтесь, чтобы оценить материал.
4
Иван Середкин
Константин Широбоков
  1. В оснастке "просмотр событий" свой журнал создает не только DCTS, но и DICS (DCTSEventLog и DICSEventLog соответственно). 
  2. Насколько я понял, скрипт не производит сбор записей журналов событий ОС?

 

Иван Середкин
Насколько я понял, скрипт не производит сбор записей журналов событий ОС?
Верно, в текущей версии скрипт не собирает записи журналов событий, но доработать его можно.

Авторизуйтесь, чтобы написать комментарий