community.general.sensu_check – Управление проверками Sensu
Примечание
Этот плагин входит в коллекцию community.general (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install community.general.
Для использования в книге задач, укажите: community.general.sensu_check.
Обзор
- Управление проверками, которые должны выполняться на машине Sensu.
- Большинство параметров не имеют значения по умолчанию и не будут добавлены в определение проверки, если не указаны.
- Все значения по умолчанию, кроме path, state, backup и metric, не управляются этим модулем,
- они просто указаны для удобства.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| aggregate boolean |
| Классифицирует проверку как агрегированную, делая её доступной через агрегированный API Значение по умолчанию: false. |
| backup boolean |
| Создать резервную копию файла (если yes), включая информацию о дате и времени, чтобы вы могли восстановить исходный файл, если вы каким-то образом неправильно его перезаписали. |
| command string | Путь к проверке sensu для запуска (не требуется, когда state=absent) | |
| custom dictionary | Значение по умолчанию: {} | Словарь пользовательских параметров для добавления в конфигурацию. Вы не можете перезаписать другие параметры модуля с помощью этого |
| dependencies list / elements=string | Значение по умолчанию: [] | Другие проверки, от которых зависит эта проверка, если зависимости не выполнены, обработка этой проверки будет отключена |
| handle boolean |
| Следует ли обрабатывать проверку Значение по умолчанию: false. |
| handlers list / elements=string | Значение по умолчанию: [] | Список обработчиков, которые должны быть уведомлены о сбое проверки |
| high_flap_threshold integer | Высокий порог для обнаружения сбоев | |
| interval integer | Интервал проверки в секундах | |
| low_flap_threshold integer | Низкий порог для обнаружения сбоев | |
| metric boolean |
| Является ли проверка метрикой |
| name string / required | Имя проверки Это ключ, используемый для определения наличия проверки | |
| occurrences integer | Количество событий до того, как обработчик должен принять меры Если не указано, по умолчанию 1. | |
| path string | Значение по умолчанию: "/etc/sensu/conf.d/checks.json" | Путь к json файлу проверки для добавления/удаления. Будет создан, если не существует (если state=absent). Родительские папки должны существовать, когда state=present, иначе будет ошибка |
| publish boolean |
| Должна ли проверка планироваться вообще. Вы всё ещё можете вызывать её через API sensu Значение по умолчанию: false. |
| refresh integer | Количество секунд, которые обработчики должны ждать перед вторым действием | |
| source string | Источник проверки, используемый для создания JIT-клиента Sensu для внешнего ресурса (например, сетевого коммутатора). | |
| standalone boolean |
| Должна ли проверка планироваться клиентом или сервером sensu Этот параметр устраняет необходимость указания параметра subscribers Значение по умолчанию: false. |
| state string |
| Должна ли проверка существовать или нет |
| subdue_begin string | Когда следует отключить обработку сбоев проверки | |
| subdue_end string | Когда следует включить обработку сбоев проверки | |
| subscribers list / elements=string | Значение по умолчанию: [] | Список подписчиков/каналов, для которых должна выполняться эта проверка См. sensu_subscribers для подписки машины на канал |
| timeout integer | Таймаут для проверки Если не указано, по умолчанию 10. | |
| ttl integer | Время жизни в секундах, до тех пор, пока проверка не будет считаться устаревшей |
Примеры
# Fetch metrics about the CPU load every 60 seconds,
# the sensu server has a handler called 'relay' which forwards stats to graphite
- name: Get cpu metrics
community.general.sensu_check:
name: cpu_load
command: /etc/sensu/plugins/system/cpu-mpstat-metrics.rb
metric: yes
handlers: relay
subscribers: common
interval: 60
# Check whether nginx is running
- name: Check nginx process
community.general.sensu_check:
name: nginx_running
command: /etc/sensu/plugins/processes/check-procs.rb -f /var/run/nginx.pid
handlers: default
subscribers: nginx
interval: 60
# Stop monitoring the disk capacity.
# Note that the check will still show up in the sensu dashboard,
# to remove it completely you need to issue a DELETE request to the sensu api.
- name: Check disk
community.general.sensu_check:
name: check_disk_capacity
state: absent
Авторы
- Anders Ingemann (@andsens)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/general/sensu_check_module.html