Сбор логов компонентов Access Manager

Уровни логирования

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

Рекомендуется использовать уровень логирования Trace, как наиболее информативный.

Уровни логирования

Trace	Наиболее подробный уровень. Логи с уровнем Trace содержат всю информацию о процессах работы компонента, включая детали о вызовах методов API.
Debug	При этом уровне логирования записи содержат подробности о ходе работы компонента, значимые переменные и другие данные, которые могут быть полезными при обнаружении и исправлении ошибок.
Info	При этом уровне логирования записываются информационные сообщения, которые уведомляют о нормальном функционировании компонента. Они могут включать такие события, как запуск или завершение процессов, отправка почты, редактирование профиля пользователя и другие.
Warn	Логирование этого уровня используется, чтобы записывать предупреждения и уведомления о потенциальных ошибках и внештатных ситуациях. События не являются критическими, но требуют внимания. При этом компонент может продолжать работу.
Error	Уровень логирования, используемый для записи ошибок, повлекших за собой некорректную работу компонента или возникновение серьезных проблем. Логи с уровнем Error указывают на проблемы, которые требуют вмешательства и исправления.
Fatal	Наименее подробный уровень логирования. Если задан этот уровень, будут записываться только самые критические ошибки и проблемы, которые приводят к немедленному завершению работы компонента или другим серьезным последствиям. Логи с уровнем Fatal обычно означают серьезные сбои, которые требуют немедленного вмешательства и исправления.

Core Server

Включение логирования

1. Откройте с правами администратора файл am/core/nlog.config.

2. Для тегов logger в параметре minlevel установите значение Trace, в параметре enabled установите true. 

   Пример

   <rules>
     <logger name="*" writeTo="defaultFile" minlevel="Warn" enabled="true">
       <filters defaultAction="Log">
         <when condition="equals('${logger}','metricTime')" action="Ignore" />
         <when condition="equals('${logger}','metricInfo')" action="Ignore" />
       </filters>
     </logger>
     <logger name="Microsoft.Hosting.Lifetime" writeTo="lifetimeConsole" final="false" />
     <logger name="metricTime" writeTo="metricsTimeFile" minlevel="Trace" enabled="false" />
     <logger name="metricInfo" writeTo="metricsInfoFile" minlevel="Trace" enabled="false" />
   </rules>

3. Сохраните файл и перезапустите контейнер с приложением.

Сбор логов

1. Очистите существующие логи сервера Indeed AM в каталоге am/core/Logs/<текущая_дата>.
2. Воспроизведите проблему.
3. Соберите архив с логами и отправьте в поддержку с подробным описанием действий пользователя и указанием точного времени воспроизведения проблемы.

Log Server

Включение логирования

1. Откройте с правами администратора файл am/ls/app-settings.json.

2. Для тега NLog в параметрах minLevel и dbMinLevel установите значение Trace. В параметре enabled установите значение  true.

   Пример

   "NLog": {
   "variables": {
     "minLevel": "Trace",
     "dbMinLevel": "Trace"
   },
   "rules": {
     "20_Errors": {
       "logger": "*",
       "minLevel": "Error",
       "writeTo": "errorsFile",
       "enabled":  true
     },
     "47_Db": {
       "logger": "Microsoft.EntityFrameworkCore*",
       "minLevel": "${dbMinLevel}",
       "writeTo": "dbFile",
       "enabled":  true
     },
     "52_Full": {
       "logger": "*",
       "minLevel": "${minLevel}",
       "writeTo": "fullFile",
       "enabled":  true
     }
   }
   • 20_Errors — запись ошибок в файл errors.log;
   • 47_Db — запись событий, относящихся к базе данных (например соединение), в соответствии с уровнем логирования в параметре "variables":"minLevel";
   • 52_Full — запись всех событий в соответствии с уровнем логирования в параметре "variables":"minLevel".

3. Сохраните файл и перезапустите контейнер с приложением.

Сбор логов

1. Очистите существующие логи Indeed AM Log Server в каталоге am/ls/Logs/<текущая_дата>.
2. Воспроизведите проблему.
3. Соберите архив с логами и отправьте в поддержку с подробным описанием действий пользователя и указанием точного времени воспроизведения проблемы.

Management Console

Включение логирования

1. Откройте с правами администратора файл am/mc/nlog.config.

2. Для тега logger в параметре minlevel установите значение Trace, в параметре enabled установите true.

   Пример

   <rules>
     <logger name="*" writeTo="defaultFile" minlevel="Trace" enabled="true"/>
   </rules>

3. Сохраните файл и перезапустите контейнер с приложением.

Сбор логов

1. Очистите существующие логи Indeed AM Management Console в каталоге am/mc/Logs/<текущая_дата>.
2. Воспроизведите проблему.
3. Соберите архив с логами и отправьте в поддержку с подробным описанием действий пользователя и указанием точного времени воспроизведения проблемы.

User Console

Включение логирования

1. Откройте с правами администратора файл am/uc/nlog.config.

2. Для тега logger в параметре minlevel установите значение Trace, в параметре enabled установите true.

   Пример

   <rules>
     <logger name="*" writeTo="defaultFile" minlevel="Trace" enabled="true"/>
   </rules>

3. Сохраните файл и перезапустите контейнер с приложением.

Сбор логов

1. Очистите существующие логи Indeed AM User Console в каталоге am/uc/Logs/<текущая_дата>.
2. Воспроизведите проблему.
3. Соберите архив с логами и отправьте в поддержку с подробным описанием действий пользователя и указанием точного времени воспроизведения проблемы.

Identity Provider

Включение логирования

1. Откройте с правами администратора файл am/idp/nlog.config.

2. Для тега logger в параметре minlevel установите значение Trace, в параметре enabled установите true.

   Пример

   <rules>
      <logger name="*" writeTo="defaultFile" minlevel="Trace" enabled="true" />
   </rules>

3. Сохраните файл и перезапустите контейнер с приложением.

Сбор логов

1. Очистите существующие логи Indeed AM Identity Provider в каталоге am/idp/Logs/<текущая_дата>.
2. Воспроизведите проблему.
3. Соберите архив с логами и отправьте в поддержку с подробным описанием действий пользователя и указанием точного времени воспроизведения проблемы.

Key Server

Включение логирования

1. Откройте с правами администратора файл am/indeed-key/nlog.config.

2. Для тега logger в параметре minlevel установите значение Trace, в параметре enabled установите true.

   Пример

   <rules>
     <logger name="*" writeTo="defaultFile" minlevel="Trace" enabled="true">
       <filters defaultAction="Log">
         <when condition="equals('${logger}','metricTime')" action="Ignore" />
         <when condition="equals('${logger}','metricInfo')" action="Ignore" />
       </filters>
     </logger>
     <logger name="Microsoft.Hosting.Lifetime" writeTo="lifetimeConsole" final="false" />
     <logger name="metricTime" writeTo="metricsTimeFile" minlevel="Trace" enabled="true" />
     <logger name="metricInfo" writeTo="metricsInfoFile" minlevel="Trace" enabled="true" />
   </rules>

3. Сохраните файл и перезапустите контейнер с приложением.

Сбор логов

1. Очистите существующие логи сервера Indeed Key в каталоге am/indeed-key/Logs/<текущая_дата>.
2. Воспроизведите проблему.
3. Соберите архив с логами и отправьте в поддержку с подробным описанием действий пользователя и указанием точного времени воспроизведения проблемы.

Phone Management Server

Включение логирования

1. Откройте с правами администратора файл am/phone-management/configs/nlog.config.

2. Для тега logger в параметре minlevel установите значение Trace, в параметре enabled установите true.

   Пример

   <rules>
      <logger name="*" writeTo="defaultFile" minlevel="Trace" enabled="true" />
   </rules>

3. Сохраните файл и перезапустите контейнер с приложением.

Сбор логов

1. Очистите существующие логи Phone Management Server в каталоге am/phone-management/Logs/<текущая_дата>.
2. Воспроизведите проблему.
3. Соберите архив с логами и отправьте в поддержку с подробным описанием действий пользователя и указанием точного времени воспроизведения проблемы.

LDAP Proxy

Включение логирования

1. Откройте с правами администратора файл am/ldap-proxy/configs/nlog.config.

2. Для тега logger в параметре minlevel установите значение Trace, в параметре enabled установите true.

   Пример

   <rules>
      <logger name="*" writeTo="defaultFile" minlevel="Trace" enabled="true" />
   </rules>

3. Сохраните файл и перезапустите контейнер с приложением.

Сбор логов

1. Очистите существующие логи LDAP Proxy в каталоге am/ldap-proxy/Logs/<текущая_дата>.
2. Воспроизведите проблему.
3. Соберите архив с логами и отправьте в поддержку с подробным описанием действий пользователя и указанием точного времени воспроизведения проблемы.

SMS Proxy

Включение логирования

1. Откройте с правами администратора файл am/sms-proxy/nlog.config.

2. Для тега logger в параметре minlevel установите значение Trace, в параметре enabled установите true.

   Пример

   <rules>
      <logger name="*" writeTo="defaultFile" minlevel="Trace" enabled="true" />
   </rules>

3. Сохраните файл и перезапустите контейнер с приложением.

Сбор логов

1. Очистите существующие логи SMS Proxy в каталоге am/sms-proxy/Logs/<текущая_дата>.
2. Воспроизведите проблему.
3. Соберите архив с логами и отправьте в поддержку с подробным описанием действий пользователя и указанием точного времени воспроизведения проблемы.