Модуль community.general.sensu_check — Управление проверками Sensu

Примечание

Этот модуль входит в коллекцию community.general (версия 9.5.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.general.

Чтобы использовать в книге задач, укажите: community.general.sensu_check.

Описание
Параметры
Атрибуты
Примеры

Описание

Управление проверками, которые должны выполняться на машине Sensu.
Большинство опций не имеют значения по умолчанию и не будут добавлены в определение проверки, если не указаны.
Все значения по умолчанию, кроме path, state, backup и metric, не управляются этим модулем.
Они просто указаны для вашего удобства.

Параметры

Параметр	Комментарии
aggregate boolean	Классифицирует проверку как агрегатную, делая её доступной через агрегатный API Значение по умолчанию `false`. Варианты: `false` `true`
backup boolean	Создать резервную копию файла (если да), включая информацию о временной метке, так чтобы вы могли восстановить исходный файл, если вы каким-то образом неправильно его повредили. Варианты: `false` ← (default) `true`
command string	Путь к проверке sensu для запуска (не требуется, когда `state=absent`)
custom dictionary	Хэш/словарь пользовательских параметров для смешивания с конфигурацией. Вы не можете переписать другие параметры модуля, используя это
dependencies list / elements=string	Другие проверки, от которых зависит эта проверка; если зависимости не пройдут, обработка этой проверки будет отключена
handle boolean	Следует ли обрабатывать проверку или нет Значение по умолчанию `false`. Варианты: `false` `true`
handlers list / elements=string	Список обработчиков, которые нужно уведомить, когда проверка завершается неудачей
high_flap_threshold integer	Верхний порог для обнаружения флага
interval integer	Интервал проверки в секундах
low_flap_threshold integer	Нижний порог для обнаружения флага
metric boolean	Является ли проверка метрикой Варианты: `false` ← (default) `true`
name string / required	Имя проверки Это ключ, который используется для определения того, существует ли проверка
occurrences integer	Количество событий, прежде чем обработчик должен предпринять действия Если не указано, значение по умолчанию равно 1.
path string	Путь к JSON-файлу проверки, который нужно добавить/удалить. Будет создан, если он не существует (если только `state=absent`). Родительские папки должны существовать, когда `state=present`, иначе будет выброшена ошибка Значение по умолчанию: `"/etc/sensu/conf.d/checks.json"`
publish boolean	Следует ли вообще планировать проверку. Вы все еще можете выполнить её через API sensu Значение по умолчанию `false`. Варианты: `false` `true`
refresh integer	Количество секунд, которые обработчики должны ждать, прежде чем предпринять второе действие
source string	Источник проверки, используемый для создания клиента Sensu JIT для внешнего ресурса (например, сетевого коммутатора).
standalone boolean	Следует ли планировать проверку клиентом или сервером sensu Эта опция устраняет необходимость указания параметра `subscribers` Значение по умолчанию `false`. Варианты: `false` `true`
state string	Должна ли проверка присутствовать или нет Варианты: `"present"` ← (default) `"absent"`
subdue_begin string	Когда отключить обработку сбоев проверки
subdue_end string	Когда включить обработку сбоев проверки

subscribers list / elements=string	Список подписчиков/каналов, для которых должен выполняться этот чек См. sensu_subscribers для подписки машины на канал
timeout integer	Тайм-аут для проверки Если не указано, по умолчанию используется 10.
ttl integer	Время жизни (в секундах), после которого проверка считается устаревшей

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная	Может работать в `check_mode` и возвращать прогноз состояния изменений без изменения целевого объекта.
diff_mode	Поддержка: нет	Вернет подробности о том, что изменилось (или, возможно, нуждается в изменении в `check_mode`), когда режим diff включен.

Примеры

# 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: true
    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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/sensu_check_module.html