sensu.sensu_go.check – Управление проверками Sensu

Примечание

Этот плагин входит в коллекцию sensu.sensu_go (версия 1.8.0).

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

Чтобы использовать его в playbook, укажите: sensu.sensu_go.check.

Новое в версии 1.0.0: модуля sensu.sensu_go

Обзор
Требования
Параметры
См. также
Примеры
Возвращаемые значения

Обзор

Создание, обновление или удаление проверки Sensu Go.
Дополнительную информацию см. в документации Sensu Go по адресу https://docs.sensu.io/sensu-go/latest/reference/checks/.

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

python >= 2.7

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
annotations словарь			Пользовательские метаданные с меньшими ограничениями, как пары ключ/значение. Сохраняются Sensu, но недоступны как токены или идентификаторы и предназначены в основном для использования с внешними инструментами.
auth словарь			Параметры аутентификации. Каждый из них можно определить и через переменные окружения.
	api_key строка добавлен в 1.3.0 sensu.sensu_go		Ключ API, который следует использовать при аутентификации. Если не задан, проверяется значение переменной окружения SENSU_API_KEY. Заменяет параметры auth.user и auth.password. Для получения дополнительной информации о ключе API обратитесь к официальной документации Sensu по адресу https://docs.sensu.io/sensu-go/latest/guides/use-apikey-feature/.
	ca_path путь добавлен в 1.5.0 sensu.sensu_go		Путь к пакету CA, который следует использовать для проверки сертификата бэкенда. Если этот параметр не задан, модуль использует пакет CA, используемый python. Также можно установить этот параметр через переменную окружения SENSU_CA_PATH.
	password строка	По умолчанию: "P@ssw0rd!"	Пароль пользователя Sensu. Если не задан, проверяется значение переменной окружения SENSU_PASSWORD. Этот параметр игнорируется, если задан параметр auth.api_key.
	url строка	По умолчанию: "http://localhost:8080"	Расположение API бэкенда Sensu. Если не задан, проверяется значение переменной окружения SENSU_URL.
	user строка	По умолчанию: "admin"	Имя пользователя для подключения к API Sensu. Если не задан, проверяется значение переменной окружения SENSU_USER. Этот параметр игнорируется, если задан параметр auth.api_key.
	verify логическое значение добавлен в 1.5.0 sensu.sensu_go	Варианты: no yes ←	Флаг, управляющий проверкой сертификатов. Если вы используете самозаверяющие сертификаты, вы можете установить этот параметр в `false`. Используйте этот параметр ТОЛЬКО в сценариях разработки! Если вы используете самозаверяющие сертификаты в продакшене, см. параметр auth.ca_path. Также можно установить этот параметр через переменную окружения SENSU_VERIFY.
check_hooks словарь			Сопоставление кодов ответов с хуками, которые будут выполняться агентом при получении данного кода. Обратите внимание, что структура этого параметра немного отличается от описанной по адресу https://docs.sensu.io/sensu-go/latest/reference/checks/#check-hooks-attribute. Для получения дополнительной информации о точной структуре сопоставления см. пример хуков проверки ниже.
command строка			Команда проверки для выполнения. Требуется, если state равен `present`.
cron строка			Расписание запросов проверки с использованием синтаксиса crontab. Не может быть использовано при использовании опции interval.
env_vars словарь			Сопоставление имен и значений переменных окружения, используемых при выполнении команд.
handlers список / элементы=строка			Список обработчиков, получающих результаты проверок.
high_flap_threshold целое число			Пороговое значение высокого скачка.
interval целое число			Интервал запросов проверки. Не может быть использовано при использовании опции cron.
labels словарь			Пользовательские поля метаданных, к которым можно получить доступ в Sensu в виде пар ключ/значение.
low_flap_threshold целое число			Пороговое значение низкого скачка.
name строка / обязательно			Имя ресурса Sensu. Это имя (в сочетании с пространством имен, где применимо) однозначно идентифицирует ресурс, над которым Ansible работает. Если ресурс с выбранным именем уже существует, Ansible-модуль обновит его в соответствии с указанием в задаче. См. спецификацию атрибута метаданных name в документации upstream по адресу https://docs.sensu.io/sensu-go/latest/reference/ для получения дополнительной информации о допустимых именах и других ограничениях.
namespace строка		По умолчанию: "default"	Пространство имен RBAC для работы. Если не указано, используется значение переменной окружения SENSU_NAMESPACE.
output_metric_format строка		Варианты: graphite_plaintext influxdb_line nagios_perfdata opentsdb_line	Включить разбор метрик в указанном формате из вывода этой проверки.
output_metric_handlers список / элементы=строка			Список обработчиков, получающих результаты проверок. Не уверен, зачем это нужно.
proxy_entity_name строка			Имя сущности, с которой связать эту проверку вместо агента, на котором она была запущена.
proxy_requests словарь			Позволяет назначить проверку для выполнения для нескольких сущностей в соответствии с их атрибутами сущностей.
	entity_attributes список / элементы=строка		Список проверок атрибутов для определения, против каких прокси-сущностей должна планироваться эта проверка.
	splay логическое значение	Варианты: no yes	Включает или выключает распределение расписания запросов проверки.
	splay_coverage целое число		Процент `interval` для распределения проверок.
publish логическое значение		Варианты: no yes	Включает или выключает запланированную публикацию запросов проверки.
round_robin логическое значение		Варианты: no yes	Массив переменных окружения для использования при выполнении команды.
runtime_assets список / элементы=строка			Список runtime-активов, необходимых для выполнения проверки.
secrets список / элементы=словарь добавлен в 1.6.0 sensu.sensu_go			Список секретов, доступных для команды.
	name строка / обязательно добавлен в 1.6.0 sensu.sensu_go		Имя переменной, содержащей конфиденциальные данные.
	secret строка / обязательно добавлен в 1.6.0 sensu.sensu_go		Имя секрета, содержащего конфиденциальные данные.
state строка		Варианты: present ← absent	Целевое состояние объекта Sensu.
stdin логическое значение		Варианты: no yes	Включает запись сериализованных JSON-данных в stdin команды проверки. Используется только с проверками, специально написанными для Sensu Go.
subscriptions список / элементы=строка			Список подписок, которые получают запросы проверок. Требуется, если state равен `present`.
timeout целое число			Таймаут выполнения проверки.
ttl целое число			Время, по истечении которого результат проверки считается устаревшим.

См. также

sensu.sensu_go.check_info: Официальная документация по модулю sensu.sensu_go.check_info.

Примеры

- name: Check executing command every 30 seconds
  sensu.sensu_go.check:
    name: check
    command: check-cpu.sh -w 75 -c 90
    subscriptions:
      - checks
    interval: 30
    publish: yes

- name: Check executing command with cron scheduler
  sensu.sensu_go.check:
    name: check
    command: check-cpu.sh -w 75 -c 90
    subscriptions:
      - systems
    handlers:
      - slack
    cron: "* * * * *"
    publish: yes

- name: Ad-hoc scheduling
  sensu.sensu_go.check:
    name: check
    command: check-cpu.sh -w 75 -c 90
    subscriptions:
      - systems
    handlers:
      - slack
    interval: 60
    publish: no

- name: Report events under proxy entity name instead of agent entity
  sensu.sensu_go.check:
    name: check
    command: http_check.sh https://sensu.io
    subscriptions:
      - proxy
    handlers:
      - slack
    interval: 60
    proxy_entity_name: sensu-site
    round_robin: yes
    publish: yes

- name: Event that triggers hooks
  sensu.sensu_go.check:
    name: check
    command: http_check.sh https://sensu.io
    subscriptions: [ proxy ]
    # The upstream JSON payload for the hooks below would look like this:
    #
    #   "check_hooks": [
    #     {"0": ["passing-hook", "always-run-this-hook"]},
    #     {"critical": ["failing-hook", "always-run-this-hook"]}
    #   ]
    #
    # Ansible task simplifies this structure into a simple mapping:
    check_hooks:
      "0":
        - passing-hook
        - always-run-this-hook
      critical:
        - failing-hook
        - always-run-this-hook

- name: Remove check
  sensu.sensu_go.check:
    name: my-check
    state: absent

Возвращаемые значения

Общие возвращаемые значения документированы здесь, следующие поля уникальны для этого модуля:

Ключ	Возвращаемое значение	Описание
объект словарь	успех	Объект, представляющий проверку Sensu. Пример: {'command': 'collect.sh', 'handlers': ['slack'], 'interval': 10, 'metadata': {'name': 'check_minimum', 'namespace': 'default'}, 'publish': True, 'subscriptions': ['system']}

Авторы

Пол Артур (@flowerysong)
Альджаз Косир (@aljazkosir)
Миха Плеско (@miha-plesko)
Тадей Боровсак (@tadeboro)

© 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/sensu/sensu_go/check_module.html