Журналирование Консоли управления Docsvision

Для Консоль управления Docsvision поддерживается два типа журналов:

  • Журналы работы приложения — сюда относится журнал Консоли управления Docsvision и Сервиса настроек, предназначеные для отслеживания состояния служб, диагностики проблем и анализа причин сбоев. Журнал сохраняется в виде файла и хранится в файловой системе сервера Docsvision.

  • Журнал операций пользователя — сохраняется в БД Сервиса настроек и содержит события взаимодействия с самой консолью.

Журнал работы приложения

Журналы консоли управления и сервиса настроек можно посмотреть в каталоге /var/log/docsvision для Linux и C:\ProgramData\Docsvision для Windows.

Не удаляйте папку с журналом модуля, т.к. у службы Консоли управления Docsvision отсутствуют права на создание новой папки.

Чтобы изменить путь хранения файла журнала по умолчанию, нужно в конфигурационном файле модуля appsettings.json изменить параметр NLog  targets  logFile  fileName с указанием нужного пути:

Путь к файлу журнала:
{
  "NLog": {
    "targets": {
      "logFile": {
        "type": "File",
        "fileName": "${gdc:baseLogFolder}/docsvision/managementconsole/${shortdate}_ManagementConsole.log"
      }
    }
  }
}

Журнал операций пользователя

В журнале операций пользователя фиксируются действия, выполняемые в Консоли управления Docsvision. Записи в журнале создаются после подтверждения действия, при начале операции или ее завершении.

Для журналирования операций пользователя используется отдельная система, не связанная с основными механизмами журналирования. Журнал сохраняется в таблицах dvsettings_ApplicationLog и dvsettings_SystemLog БД Сервиса настроек автоматически и без участия администратора. Такое решение позволяет отделить действия пользователя от технических журналов.

События могут быть сгруппированы или разделены в зависимости от идентификатора сервиса (Управление процессами, Файловый сервис и т.д.) и идентификатора операции (когда одно действие вызывает несколько изменений. Например, изменение нескольких параметров на странице настроек с последующим нажатием кнопки Применить.

Для всех действий фиксируется:

  • Идентификатор события

  • Дата/время

  • Тип события

  • Уровень журналирования

  • Инициатор действия

  • Результат (успех/ошибка)

  • Текст ошибки при наличии

  • Идентификатор сервиса

В журнал попадают следующие события / Дополнительная информация по ним:

  1. Вход в Консоль управления Docsvision и выход из системы / Логин пользователя.

  2. Факт регистрации, удаления компонентов / Тип компонента.

  3. Изменение любых параметров в конфигурации компонентов / Путь параметра в Сервисе настроек, тип редактора, значения до и после изменения. Для чувствительных зашифрованных данных фиксируется только факт изменения.

  4. Выполнение операций с базами данных / Параметры запроса (имя базы и тд).

    • Настройка локализаций, решений и видов карточек по умолчанию для Web-клиента.

    • Настройки долей процессов, переустановка шаблонов для модуля Управление процессами.

    • Управление персональными лицензиями, автоматическое отключение сессий для Сервера приложений.

    • Настройка свойств БД.

  5. Изменения на странице расширенных настроек / Путь параметра, значения до и после изменения. Значения чувствительных зашифрованных настроек не фиксируются.

  6. Копирование настроек с сервера на сервер (импорт настроек компонента) / идентификатор целевого сервиса, сервер откуда скопировано. Содержимое настроек не логируется.

  7. Управление Службой фоновых операций и соединениями / Название сервиса и процесса.

  8. Работа с очередями и сообщениями / Идентификатор сообщения и идентификатор карточки сообщений.

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

Уровень журналирования событий консоли определяется следующим образом:

  • Error (1) — ошибки при выполнении операции или применении конфигурации. Например, ошибка подключения к БД.

  • Warning (2) — предупреждения о неудачных действиях пользователя, не являющихся ошибкой. Например, если пользователь ввёл неверный логин или пароль.

  • Information (3) — информационные события об изменениях, сообщения о начале\завершении обработки сообщения, успешные действия. Например, успешное изменение настройки.