Управление журналами

Содержание

Управление журналами#

Окно Настройка ведения журнала (Logging Settings) позволяет управлять параметрами журналирования платформы:

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

Для перехода к окну Настройка ведения журнала (Logging Settings) выберите на панели навигации Настройки ‣ Регистрация (Settings ‣ Logging).

Получение информации#

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

Полный список параметров:

Агрегатор протоколирования (Logging Aggregator) – FQDN или IP-адрес сервера, на котором размещена внешняя система управления журналами.
Порт агрегатора ведения журнала (Logging Aggregator Port) – номер порта, через который осуществляется подключение к внешней системе управления журналами.
Тип агрегатора ведения журнала (Logging Aggregator Type) – тип внешней системы управления журналами.

Возможные значения:
- --------- – внутренняя система управления журналами;
- logstash – Elastic Logstash;
- splunk – Splunk;
- loggly – Solarwinds Loggly;
- sumologic – Sumo Logic;
- other – внешняя система управления журналами с настройками, заданными вручную.
Имя пользователя агрегатора ведения журнала (Logging Aggregator Username) – название учетной записи, используемой для доступа к внешней системе управления журналами.
Пароль/токен агрегатора ведения журнала (Logging Aggregator Password/Token) – пароль или токен для доступа к внешней системе управления журналами.
Регистраторы, отправляющие данные в форму агрегатора журналов (Loggers Sending Data to Log Aggregator Form) – список типов регистраторов, отправляющих данные в агрегатор журналов.

Возможные значения:
- awx – внутренние события контроллера.
- activity_stream – изменение ресурсов.
- job_events – события, связанные с заданиями.
- system_tracking – факты, собранные при выполнении заданий.
  
  Примечание
  
  Для сбора фактов необходимо включить настройку Включить хранилище фактов (Enable Fact Storage) в свойствах шаблона задания.
- broadcast_websocket – ошибки широковещательных рассылок веб-сокетов.
- job_lifecycle – ошибки, связанные с обработкой заданий.
Значение по умолчанию:
```
- awx
- activity_stream
- job_events
- system_tracking
- broadcast_websocket
- job_lifecycle
```
Уникальный идентификатор для всего кластера (Cluster-wide unique identifier) – уникальный идентификатор кластера.
Протокол ведения журналов (Logging Aggregator Protocol) – протокол соединения с внешней системой управления журналами.

Возможные значения:
- HTTPS/HTTP.
  
  Примечание
  
  При выборе этого значения используется протокол HTTPS, если только протокол HTTP не указан явно в значении настройки Агрегатор протоколирования (Logging Aggregator).
- TCP.
- UDP.
Значение по умолчанию: HTTPS/HTTP.
Тайм-аут TCP-соединения (TCP Connection Timeout) – время в секундах, по истечении которого соединение с внешней системой управления журналами разрывается. Значение этой настройки используется только, если для настройки Протокол ведения журналов (Logging Aggregator Protocol) задано значение HTTPS/HTTP или TCP.

Значение по умолчанию: 5.
Порог уровня агрегатора ведения журнала (Logging Aggregator Level Threshold) – минимальный уровень сообщений, которые записываются в журнал. Уровни сообщений, от наименьшего к наибольшему:
1. DEBUG;
2. INFO;
3. WARNING;
4. ERROR;
5. CRITICAL.
Сообщения с уровнем ниже указанного будут пропущены обработчиком журнала.

Значение по умолчанию: INFO.
Примечание

Настройка Logging Aggregator Level Threshold применяется только к регистраторам, поддерживающим динамическое изменение уровня управления журналами.

Настройку уровня поддерживают следующие регистраторы:
- awx – любой уровень;
- broadcast_websocket – любой уровень.
Для следующих регистраторов используется фиксированный уровень, заданный системой, независимо от значения настройки:
- activity_stream – INFO;
- job_events – INFO;
- system_tracking – INFO;
- job_lifecycle – DEBUG.
Максимальное количество сообщений, которые можно хранить в очереди log action (Maximum number of messages that can be stored in the log action queue) – максимальное количество сообщений, которые могут храниться в очереди действий журнала.

Увеличение значения этого параметра может повлиять на использование памяти. Когда очередь достигнет 75% от этого числа, она начнет записываться на диск. Когда очередь достигнет 90%, сообщения уровней NOTICE, INFO и DEBUG начнут отбрасываться.
Максимальный объем дискового пространства для внешнего агрегатора журналов (в ГБ) (Maximum disk persistance for external log aggregation (in GB)) – максимальный размер дискового пространства для внешней агрегации журналов (в ГБ).

Представляет объем данных для хранения на случай сбоя внешнего агрегатора журналов.

Значение по умолчанию: 1.
Расположение файловой системы для syslog-ng disk persistence (File system location for syslog-ng disk persistence) – расположение, где временно сохраняются журналы, если не могут быть переданы во внешний агрегатор. Когда соединение восстанавливается, передача автоматически продолжается (включая журналы, временно сохраненные в указанном каталоге).

Значение по умолчанию: /var/lib/awx.
Формат записи в журнал для ошибок API с кодом 4XX (Log Format For API 4XX Errors) – шаблон записей о событиях, связанных с кодами HTTP 4XX при обращении к точкам доступа API.

В шаблоне поддерживается использование следующих переменных:
- status_code – код статуса HTTP;
- user_name – название учетной записи пользователя, выполнившего запрос к точке доступа API;
- url_path – URL точки доступа API, обращение к которой привело к ошибке;
- remote_addr – адрес внешнего узла, выполнявшего запрос;
- error – сообщение об ошибке, возвращенное точкой доступа API.
Если точка доступа API не возвращает собственный текст сообщения об ошибке, в журнал записывается стандартное описание статуса HTTP, соответствующее коду ответа. Например, при обращении к несуществующему ресурсу (код 404) в журнал будет записано:
```
status_code=404 user_name=jdoe url_path=/api/v2/nonexistent/ remote_addr=192.168.1.10 error="Not Found"
```
А при ошибке аутентификации (код 401):
```
status_code=401 user_name=anonymous url_path=/api/v2/jobs/ remote_addr=203.0.113.5 error="Unauthorized"
```
Вести индивидуальный журнал по фактам, собранным системой (Log System Tracking Facts Individually) – если этот параметр включен, факты, отслеживаемые системой, будут регистрироваться в журнале для каждого пакета, сервиса или другой сущности, найденной при сканировании, что обеспечивает глубокую детализацию поискового запроса. Если этот параметр выключен, факты будут отправляться в виде единого словаря, что обеспечивает большую эффективность обработки фактов.

Значение по умолчанию: выключено.
Включить внешнее ведение журнала (Enable External Logging) – если эта настройка включена, для хранения журналов используется внешняя система управления журналами.

Примечание

Для включения этой настройки необходимо задать значения настроек Агрегатор протоколирования (Logging Aggregator) и Тип агрегатора ведения журнала (Logging Aggregator Type).
Включить/отключить проверку сертификата HTTPS (Enable/disable HTTPS certificate verification) – если эта настройка включена, при соединении с внешней системой управления журналами по протоколу HTTPS выполняется проверка сертификата.

Значение по умолчанию: включено.
Включить отладку syslog-ng (Enable syslog-ng debugging) – если этот параметр включен, детализация журналирования работы syslog-ng повышается, чтобы диагностировать проблемы с подключением и доставкой журналов во внешние системы.
Логирование в файл в CEF формате (Log to CEF file format) – если этот параметр включен, платформа записывает события в формате CEF в файл /var/log/cef.log.

Редактирование#

Для изменения действующих настроек ведения журнала в окне Настройка ведения журнала (Logging Settings) выполните следующие действия:

Нажмите кнопку Редактировать (Edit).
Внесите необходимые изменения.
Нажмите кнопку Сохранить (Save).