sensu.sensu_go.event модуль – Управление событиями Sensu

Примечание

Этот модуль входит в состав коллекции sensu.sensu_go (версия 1.14.0).

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

Чтобы установить её, используйте: ansible-galaxy collection install sensu.sensu_go. Для использования этого модуля необходимы дополнительные требования, см. Требования для получения подробностей.

Для использования в книге задач укажите: sensu.sensu_go.event.

Новый в sensu.sensu_go 1.0.0

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

Описание

Отправка синтетического события в Sensu.
Для получения дополнительной информации см. документацию Sensu по адресу https://docs.sensu.io/sensu-go/latest/reference/events/.

Требования

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

python >= 2.7

Параметры

Параметр	Комментарии
auth словарь	Параметры аутентификации. Можно также определить каждый из них с помощью переменной среды.
api_key строка добавлено в sensu.sensu_go 1.3.0	Ключ API, который необходимо использовать при аутентификации. Если он не задан, будет проверено значение переменной среды SENSU_API_KEY. Заменяет параметры auth.user и auth.password. Для получения дополнительной информации о ключе API обратитесь к официальной документации Sensu по адресу https://docs.sensu.io/sensu-go/latest/guides/use-apikey-feature/.
ca_path путь добавлено в sensu.sensu_go 1.5.0	Путь к файлу сертификата CA, который необходимо использовать для проверки сертификата бэкенда. Если этот параметр не задан, модуль будет использовать файл CA, используемый Python. Также можно задать этот параметр через переменную среды SENSU_CA_PATH.
password строка	Пароль пользователя Sensu. Если он не задан, будет проверено значение переменной среды SENSU_PASSWORD. Этот параметр игнорируется, если задан параметр auth.api_key. Значение по умолчанию: `"P@ssw0rd!"`
url строка	Местоположение API бэкенда Sensu. Если он не задан, будет проверено значение переменной среды SENSU_URL. Значение по умолчанию: `"http://localhost:8080"`
user строка	Имя пользователя для подключения к API Sensu. Если он не задан, будет проверено значение переменной среды SENSU_USER. Этот параметр игнорируется, если задан параметр auth.api_key. Значение по умолчанию: `"admin"`
verify логическое значение добавлено в sensu.sensu_go 1.5.0	Флаг, контролирующий проверку сертификата. Если вы используете самозаверяющие сертификаты, можно установить этот параметр в значение `false`. Используйте этот параметр ТОЛЬКО в СРЕДЕ РАЗРАБОТКИ! Если вы используете самозаверяющие сертификаты в производственной среде, обратитесь к параметру auth.ca_path. Также можно установить этот параметр через переменную среды SENSU_VERIFY. Варианты: `false` `true` ← (по умолчанию)
check строка / обязательно	Имя проверки, связанной с этим событием. Она должна существовать перед созданием события.
check_attributes словарь	Дополнительные параметры проверки. Подробнее см. по адресу https://docs.sensu.io/sensu-go/latest/reference/events/#check-attributes.
duration число с плавающей точкой	Время выполнения команды в секундах.
executed целое число	Время выполнения запроса проверки.
history список / элементы=словарь	История состояния проверки для последних 21 выполнения проверки.
issued целое число	Время выдачи запроса проверки в секундах с начала эпохи Unix.
last_ok целое число	Последнее время, когда проверка вернула состояние OK (0) в секундах с начала эпохи Unix.
output строка	Вывод от выполнения команды проверки.
state строка	Состояние проверки. Варианты: `"passing"` `"failing"` `"flapping"`
status строка	Код возврата, полученный от проверки. Варианты: `"ok"` `"warning"` `"critical"` `"unknown"`
total_state_change целое число	Процентное изменение общего состояния для истории проверки.
entity строка / обязательно	Имя сущности, связанной с этим событием. Оно должно существовать перед созданием события.
metric_attributes словарь	Атрибуты метрики. Подробнее см. по адресу https://docs.sensu.io/sensu-go/latest/reference/events/#metric-attributes.

handlers список / элементы=строка	Массив Sensu обработчиков, используемых для событий, созданных проверкой. Каждый элемент массива должен быть строкой.
points список / элементы=словарь	Точки данных метрики, включающие имя, метку времени, значение и метки.
namespace строка	Пространство имен RBAC для работы. Если не задано, используется значение переменной окружения SENSU_NAMESPACE. По умолчанию: `"default"`
timestamp целое число	Временная метка в формате Unix, когда произошло событие.

Примечания

Примечание

События метрики минуют хранилище и отправляются в конвейер событий и соответствующие обработчики событий. Подробнее об этом см. на странице https://docs.sensu.io/sensu-go/latest/reference/events/#metric-only-events.

См. также

sensu.sensu_go.event_info: Список Sensu событий.

Примеры

- name: Create an event
  sensu.sensu_go.event:
    auth:
      url: http://localhost:8080
    entity: awesome_entity
    check: awesome_check
    check_attributes:
      duration: 1.945
      executed: 1522100915
      history:
        - executed: 1552505193
          status: 1
      issued: 1552506034
      last_ok: 1552506033
      output: '10'
      state: 'passing'
      status: 'ok'
      total_state_change: 0
    metric_attributes:
      handlers:
        - handler1
        - handler2
      points:
        - name: "sensu-go-sandbox.curl_timings.time_total"
          tags:
            - name: "response_time_in_ms"
              value: 101
          timestamp: 1552506033
          value: 0.005
        - name: "sensu-go-sandbox.curl_timings.time_namelookup"
          tags:
            - name: "namelookup_time_in_ms"
              value: 57
          timestamp: 1552506033
          value: 0.004

Значения возврата

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

Ключ	Описание
object словарь	Объект, представляющий Sensu событие (устарело). Возвращается: успешно Пример: {"check": {"check_hooks": null, "command": "check-cpu.sh -w 75 -c 90", "duration": 1.07055808, "env_vars": null, "executed": 1552594757, "handlers": [], "high_flap_threshold": 0, "history": [{"executed": 1552594757, "status": 0}], "interval": 60, "metadata": {"name": "check-cpu", "namespace": "default"}, "occurrences": 1, "occurrences_watermark": 1, "output": "CPU OK - Usage:3.96", "subscriptions": ["linux"], "timeout": 0, "total_state_change": 0, "ttl": 0}, "entity": {"deregister": false, "deregistration": {}, "entity_class": "agent", "last_seen": 1552594641, "metadata": {"name": "sensu-centos", "namespace": "default"}}, "id": "3a5948f3-6ffd-4ea2-a41e-334f4a72ca2f", "metadata": {"namespace": "default"}, "sequence": 1, "timestamp": 1552594758}

Ключ

Описание

object

словарь

Объект, представляющий Sensu событие (устарело).

Возвращается: успешно

Пример: {"check": {"check_hooks": null, "command": "check-cpu.sh -w 75 -c 90", "duration": 1.07055808, "env_vars": null, "executed": 1552594757, "handlers": [], "high_flap_threshold": 0, "history": [{"executed": 1552594757, "status": 0}], "interval": 60, "metadata": {"name": "check-cpu", "namespace": "default"}, "occurrences": 1, "occurrences_watermark": 1, "output": "CPU OK - Usage:3.96", "subscriptions": ["linux"], "timeout": 0, "total_state_change": 0, "ttl": 0}, "entity": {"deregister": false, "deregistration": {}, "entity_class": "agent", "last_seen": 1552594641, "metadata": {"name": "sensu-centos", "namespace": "default"}}, "id": "3a5948f3-6ffd-4ea2-a41e-334f4a72ca2f", "metadata": {"namespace": "default"}, "sequence": 1, "timestamp": 1552594758}

Авторы

Paul Arthur (@flowerysong)
Aljaz Kosir (@aljazkosir)
Manca Bizjak (@mancabizjak)
Tadej Borovsak (@tadeboro)

Ссылки на коллекции

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