...
| Раскрыть |
|---|
Параметры в разделе [default]:- cert_expiration_days:
Задает порог в днях до истечения срока действия сертификата, после которого начинает выдаваться предупреждение (например, если установить значение 7, то предупреждение появится за 7 дней до истечения). Значение по умолчанию: 28. - timeout:
Устанавливает максимальное время (в секундах) для выполнения каждой проверки. Если проверка выполняется дольше указанного времени, она считается прерванной с ошибкой. Значение по умолчанию: 10. - output_type:
Определяет формат вывода результатов. Допустимые значения:
– json (по умолчанию, машиночитаемый формат),
– human (удобочитаемый формат для пользователей),
– prometheus (формат для экспозиции метрик Prometheus). - output_file:
Указывает путь к файлу, в который будет записываться вывод вместо стандартного вывода (stdout). - indent:
При использовании JSON-вывода задаёт уровень отступов для форматирования результата (делает вывод более читаемым). - verbose:
Включают Активирует подробное логирование и режим отладки для получения дополнительной информации о работе инструмента. Эти опции полезны Эта опция полезна для диагностики, однако при автоматических запусках они могут она может создавать избыточный вывод. - debug:
Активирует режим отладки, при котором в выводе появляются дополнительные подробности, что полезно для диагностики проблем. - severity:
Позволяет фильтровать вывод freeipa‑healthcheck по уровню серьезности, чтобы отображались только результаты с заданными уровнями. Допустимые значения:
– SUCCESS (успешно),
– WARNING (предупреждение),
– ERROR (ошибка),
– CRITICAL (критическая ошибка).
Параметры в разделе [excludes]:source:
Позволяет подавлять результаты, поступающие из определённого источника (например, ipahealthcheck.ipa.certs). check:
Позволяет подавлять конкретные имена проверок (например, IPADNSSystemRecordsCheck). key:
Позволяет подавлять результаты по конкретному ключу (обычно это уникальный идентификатор, например, ID запроса на сертификат).
|
...
| Блок кода |
|---|
| title | /etc/ipahealthcheck/ipahealthcheck.conf |
|---|
|
[default]
cert_expiration_days = 7
timeout = 25
output_type = json
output_file = /var/log/ipa-health.log
indent = 2
verbose = True
severity = ERROR CRITICAL
debug = False
[excludes]
source = ipahealthcheck.ipa.certs
check = IPADNSSystemRecordsCheck |
Также все параметры конфигурации поддерживаются в виде аргументов командой строки.
| Раскрыть |
|---|
Аргументы командной строки:- --list-sources:
Выводит список доступных источников (sources) и проверок (checks), что помогает определить, какие группы тестов доступны в вашей установке. - --config=FILE:
Задает файл конфигурации, который будет использоваться при запуске. Если указать пустую строку, то файл конфигурации не загружается. По умолчанию используется /etc/ipahealthcheck/ipahealthcheck.conf. - --source=SOURCE:
Позволяет подавлять результаты, поступающие из определённого источника (например, ipahealthcheck.ipa.certs). - --check=CHECK:
Позволяет подавлять конкретные имена проверок (например, IPADNSSystemRecordsCheck). - --output-type=TYPE:
Определяет формат вывода результатов. Допустимые значения:
– json (по умолчанию, машиночитаемый формат),
– human (удобочитаемый формат для пользователей),
– prometheus (формат для экспозиции метрик Prometheus). - --failures-only:
При активном использовании этого параметра в вывод будут включены только проверки, завершившиеся предупреждениями, ошибками или критическими сбоями (WARNING, ERROR, CRITICAL). По умолчанию включена. - --all:
Выводит все результаты проверок, независимо от их уровня. Этот параметр отменяет действие --failures-only. - --severity=SEVERITY:
Позволяет фильтровать вывод по уровню серьезности, чтобы отображались только результаты с заданными уровнями. Допустимые значения:
– SUCCESS
– WARNING
– ERROR
– CRITICAL - --verbose:
Активирует подробное логирование для получения дополнительной информации о работе инструмента. Эта опция полезна для диагностики, однако при автоматических запусках она может создавать избыточный вывод. - --debug:
Активирует режим отладки, при котором в выводе появляются дополнительные подробности, что полезно для диагностики проблем. - --output-file=FILENAME:
Указывает путь к файлу, в который будет записываться вывод вместо стандартного вывода (stdout). - --input-file=FILENAME:
Позволяет прочитать результаты предыдущего запуска (обычно в формате JSON) и отобразить их в другом формате или просто повторно показать сохранённые данные. - --indent=INDENT:
При использовании JSON-вывода задаёт уровень отступов для форматирования результата. - --metric-prefix=PREFIX:
При использовании формата вывода prometheus задает префикс, который будет добавляться к именам метрик.
|
Пример готовых команд может выглядеть так:
- Выполнение конкретной проверки сертификатов с фильтрацией по уровню серьезности и показом только ошибок:
| Блок кода |
|---|
|
ipa-healthcheck --source=ipahealthcheck.ipa.certs --check=IPACertExpirationCheck --severity=ERROR --severity=CRITICAL --failures-only --output-type=human |
1111