Логи Системы


Типы логов

ADVANTA умеет записывать детальные технические логи о:

  • событиях;
  • ошибках;
  • производительности Системы;
  • процессе создания LINQ-контекста.

Все настройки детальных системных логов расположены здесь: Администрирование → Общие настройки → Общие настройки → Система сбора информации об ошибках.

Настройка логирования

  • Включить логирование производительности системных процессов - поставить чек-бокс можно только после того, как заполнено поле "Путь к логу производительности системных процессов".
  • Путь к логу производительности системных процессов - место для вставки абсолютной ссылки на сервер, куда будут записываться логи. Например:
C:\Logs\
  • Максимальный размер логов производительности системных процессов, МБ - максимальный размер файлов с логами. Файлы логов не превысят указанный максимальный размер, и перезапись записей идет по кругу. При достижении максимального размера новые записи затирают самые старые.
  • Писать в логи производительности системных процессов все запросы - чек-бокс, который даёт записывать не только ключевые события.
  • Писать в логи производительности системных процессов в Seq - писать логи через Seq или нет. (Можно включить, только при условии, что поле "Url адрес системы обработки логов Seq" заполнено.)
  • Url адрес системы обработки логов Seq - Url адрес системы обработки логов Seq, развёрнутый на вашем сервере. Например:
http://192.168.0.78:8888

  • Выгрузить логи производительности системных процессов - экспорт архива файлов с логами производительности системных процессов с вашего сервера (по пути, который указан в поле "Путь к логу производительности системных процессов").
  • Выгрузить системные логи - НЕ ОТНОСИТСЯ к логированию производительности. Экспорт системного лога log4net. Лог настраивается отдельно в ходе первоначальной установки и настройки Системы ADVANTA (см. следующий раздел на этой странице).
  • Исключения для логов производительности системных процессов - фильтр по URL. Укажите здесь все те фразы, которые содержатся в URL тех страниц, которые не должны логироваться. Это может относиться как ко всем однотипным объектам, так и к конкретным (если будет указаны их GUID).

Ошибки и события

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

Как настроить лог событий и лог ошибок

Новый формат для 4.х - Serilog

Положите в папке веб-приложения рядом с Advanta.dll файл serilog.config со следующим содержимым. Поменяйте значение атрибутов "path" на ваш каталог логов на сервере (желательно использовать абсолютный путь).

{
  "Serilog": {
    "Using": [
      "Serilog.Sinks.File"
    ],
 
    "MinimumLevel": {
      "Default": "Information",
      "Override": {
        "Microsoft": "Warning",
        "System": "Warning",
        "Microsoft.AspNetCore": "Warning"
      }
    },
 
    "WriteTo": [
      {
        "Name": "File",
        "Args": {
          "path": "C:/SL_Files/Logs/log-.txt",
          "rollingInterval": "Day",
          "fileSizeLimitBytes": 104857600,
          "rollOnFileSizeLimit": true,
          "retainedFileCountLimit": 30,
          "shared": true,
          "buffered": false,
          "outputTemplate": "{Timestamp:yyyy-MM-dd HH:mm:ss.fff} [{Level:u3}] {Message:lj} {Properties:j}{NewLine}{Exception}"
        }
      },
      {
        "Name": "File",
        "Args": {
          "path": "C:/SL_Files/Logs/errors-.txt",
          "rollingInterval": "Day",
          "restrictedToMinimumLevel": "Error",
          "fileSizeLimitBytes": 104857600,
          "rollOnFileSizeLimit": true,
          "retainedFileCountLimit": 30,
          "shared": true,
          "buffered": false,
          "outputTemplate": "{Timestamp:yyyy-MM-dd HH:mm:ss.fff} [{Level:u3}] {Message:lj} {Properties:j}{NewLine}{Exception}"
        }
      }
    ]
  }
}

Первый блок— «действия» (все записи), второй блок — только ошибки/фатальные.

Если предпочтительно получение логов в формате JSON, то используйте следующий конфиг:

{
  "Serilog": {
    "Using": [
      "Serilog.Sinks.File",
      "Serilog.Formatting.Compact"
    ],
 
    "MinimumLevel": {
      "Default": "Information",
      "Override": {
        "Microsoft": "Warning",
        "System": "Warning",
        "Microsoft.AspNetCore": "Warning"
      }
    },
 
    "WriteTo": [
      {
        "Name": "File",
        "Args": {
          "path": "C:/SL_Files/Logs/log-.json",
          "formatter": "Serilog.Formatting.Compact.CompactJsonFormatter, Serilog.Formatting.Compact",
          "rollingInterval": "Day",
          "fileSizeLimitBytes": 104857600,
          "rollOnFileSizeLimit": true,
          "retainedFileCountLimit": 30,
          "shared": true,
          "buffered": false
        }
      },
      {
        "Name": "File",
        "Args": {
          "path": "C:/SL_Files/Logs/errors-.json",
          "formatter": "Serilog.Formatting.Compact.CompactJsonFormatter, Serilog.Formatting.Compact",
          "restrictedToMinimumLevel": "Error",
          "rollingInterval": "Day",
          "fileSizeLimitBytes": 104857600,
          "rollOnFileSizeLimit": true,
          "retainedFileCountLimit": 30,
          "shared": true,
          "buffered": false
        }
      }
    ]
  }
}

Устаревший вариант - Log4net

В версии 4.х не работает.

Как передать ошибку в поддержку

  1. Cохраните файл serilog.config в корневой директории веб-приложения ADVANTA.
  2. Перезапустите dotnet-приложение или пул приложений IIS.
  3. Воспроизведите ошибку.
  4. Выгрузите файл с логами и передайте его в поддержку вместе с данными о времени воспроизведения и ссылками на страницы Системы, где выполнялось воспроизведение ошибки.

Как выгрузить лог событий

Если у вас есть доступ к директории, где размещается ADVANTA на вашем веб-сервере, вы можете скопировать эти файлы оттуда.

Если прямого доступа к файлам на сервере нет, выгрузите логи в интерфейсе Администратора в ADVANTA:

  1. Администрирование → Общие настройки → Общие настройки → Система сбора информации об ошибках
  2. Выгрузить системные логи → "Выгрузить".

Как читать лог событий

Название чек-бокса В логе Описание
Процедура очистки памяти СистемыMemoryUsingStartPeriodicMaintenanceВыставляется значение параметра GCSettings.LargeObjectHeapCompactionMode в GCLargeObjectHeapCompactionMode.CompactOnce.
Это приведет к сжатию кучи больших объектов (LOH во время следующей блокирующей сборки мусора второго поколения.
Докуметация: https://docs.microsoft.com/ru-ru/dotnet/api/system.runtime.gcsettings.largeobjectheapcompactionmode
РасписаниеFormRequestDistributionController.MigrateFormFromProjectTypesМиграция старых автозапросов форм в новый тип.
Рассылка запросов на отчеты о статусеDirectoryRequestService.MakeAutoRequestsСоздание запросов на создание отчетов исполнителям.
Рассылка уведомлений о сроках проектовProjectsService.CheckProjectsTimeРаcсылаются события:
1. Превышение планируемого срока завершения проекта. Возникает, когда текущая дата больше планируемой даты завершения.
2. Превышение планируемого срока начала проекта. Возникает, когда текущая дата больше планируемой даты начала.
3. Уведомление о приближающемся завершении проекта. Возникает, когда текущая дата больше порога уведомления.
Рассылка писемMailDistributor.SendMailРассылка писем, которые ранее не отправлялись.
Биллинг геймификацииGamingCharging.ScheduledChargeРассчет баланса и рейтинга в геймификации.
Автоматические запросы по формамFormRequestDistributionController.ProcessAutoRequestsФормирование автоматических запросов пользователям по формам по расписанию.
Перестроение кубов по расписаниюCubeDataManager.UpdateCubesBySchedule
Построение excel-отчетов по расписаниюCalculateExcelReportService.CalculateReportsBySchedule
Пересчет значений виджетовCalculateWidgetValuestService.CalculateWidgetValuesBySchedule
Обновление Google токенов на подписку каналовGoogleCalendarServiceManager.UpdateOutdatedSyncronizationChannels
Отправка запросов на выполнение задач по связи FS с задержкойQuestionsManager.RegisterProjectStartTaskWithDependencyDelay
Копирование не завершенных проектов из предыдущего периодаCheckTimeSheetProjectsКопирование в табель не завершенных проектов из предыдущего периода
Проверка соединений пользователей с ExchangeExchangeServiceProvider.CheckConnectionsПроверка соединений пользователей с Microsoft Exchange Server.
Сбор статистики активности пользователейCollectingUserActivityStatistics
Напоминание о просроченных запросахRemindExpiredQuestionsРассылка напоминаний о просроченных запросах по формам и согласованиям.
Расширение активностей таймера в отдельных решенияхScheduler.Execute

Как выгрузить лог ошибок

Лог ошибок доступен только в директории вашего сервера, где размещается Система ADVANTA.

Местоположение лога определяется конфигурацией файла serilog.config. Как правило, это:

C:\SL_Files\Documents\logs\ErrorLog.txt

Логи производительности

Вы можете получать лог производительности процессов Системы.

Как настроить

Чтобы лог начал собираться и записываться: 1. Администрирование → Общие настройки → Общие настройки → Система сбора информации об ошибках

2. В портлете "Система логирования производительности системных процессов" заполните поля:

  • "Путь к логу производительности системных процессов" – путь к каталогу файловой системы на вашем сервере.
    Например: C:\Logs\
    • Создайте папку, где должен храниться лог, на веб-сервере. Если папки не существует, лог писаться не будет!
    • Проверьте, что у пользователя, из-под которого запущена ADVANT на Microsoft Server есть доступ к этой папке (запись).
  • Поставьте чек-бокс "Включить логирование производительности системных процессов".

3. Если развернут Seq, можно настроить также логирование через него:

  • Вставьте ссылку на Seq на вашем сервере в поле "Url адрес системы обработки логов Seq". Например: http://192.168.0.78:8888
  • Поставьте чек-бокс "Писать в логи производительности системных процессов в Seq".

Как выгрузить

Если у вас есть доступ к серверу, где хранятся документы для Системы ADVANTA, вы можете скопировать их оттуда.

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

Если доступа к файлам на сервере нет, выгрузите логи через интерфейсе ADVANTA:

  1. Администрирование → Общие настройки → Общие настройки → Система сбора информации об ошибках
  2. "Выгрузить логи производительности системных процессов" → Выгрузить.

Логи создания LINQ-контекста

Данная опция используется в целях отладки.

Чтобы включить логирование операций создания LINQ-контекста, необходимо сперва включить логи ошибок, затем добавить настройку в файле client.config: LinqToAdvantaLogGeneratedCode со значением 'true'.

  <appSettings>
    ...
    <add key="LinqToAdvantaLogGeneratedCode" value="true" />
  </appSettings>

Запись сгенерированного при перестроении LINQ-контекста C#-кода будет осуществляться в общий лог ошибок log4net.

В записях лога такие сообщения начинаются со строки "Building LINQ-context". Большинство записей статистического характера: отображают каких и сколько объектов обработано.

Запись, сообщение в которой начинается с "Building LINQ-context generatad C#-code" - содержит сгенерированный код. Это может быть огромная по размеру запись. Именно для неё введён параметр настройки LinqToAdvantaLogGeneratedCode в client.config.

Так как объём C#-кода при формировании LINQ-контекста может составлять несколько мегабайт, после использования и завершении отладки эту настройку следует выключить - установить в значение 'false'. Если LinqToAdvantaLogGeneratedCode имеет значение 'false' или отсутствует, то запись сгенерированного кода в лог не будет производиться.

По умолчанию значение этой опции в файле client.config установлено в значение 'false'.