sensu.sensu_go.event – Управление событиями Sensu
Примечание
Этот плагин входит в состав коллекции sensu.sensu_go (версия 1.8.0).
Для его установки используйте: ansible-galaxy collection install sensu.sensu_go.
Для использования в книге задач укажите: sensu.sensu_go.event.
Новое в версии 1.0.0: из sensu.sensu_go
Описание
- Отправка синтетического события в Sensu.
- Дополнительную информацию см. в документации Sensu по адресу https://docs.sensu.io/sensu-go/latest/reference/events/.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 2.7
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| 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 |
| Флаг, управляющий проверкой сертификатов. Если вы используете самоподписанные сертификаты, вы можете установить этот параметр на false. Используйте этот параметр ТОЛЬКО в сценариях разработки! Если вы используете самоподписанные сертификаты в рабочей среде, см. параметр auth.ca_path. Этот параметр также можно задать через переменную среды SENSU_VERIFY. | |
| 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 строка |
| Состояние проверки. | |
| status строка |
| Код возврата, выданный проверкой. | |
| total_state_change целое число | Процент общего изменения состояния для истории проверки. | ||
| entity строка / обязательно | Имя сущности, связанной с этим событием. Оно должно существовать до создания события. | ||
| metric_attributes словарь | Атрибуты метрики. Подробнее см. на странице https://docs.sensu.io/sensu-go/latest/reference/events/#metric-attributes. | ||
| handlers список / элементы=строка | Массив обработчиков Sensu для использования для событий, созданных проверкой. Каждый элемент массива должен быть строкой. | ||
| points список / элементы=словарь | Точки данных метрики, включая имя, метку времени, значение и метки. | ||
| namespace строка | Значение по умолчанию: "default" | Пространство имен RBAC для работы. Если не задано, используется значение переменной среды SENSU_NAMESPACE. | |
| timestamp целое число | Время Unix, в которое произошло событие. | ||
Примечания
Примечание
- События метрики минуют хранилище и отправляются в поток событий и соответствующие обработчики событий. Подробнее об этом см. на странице https://docs.sensu.io/sensu-go/latest/reference/events/#metric-only-events.
См. также
См. также
- sensu.sensu_go.event_info
-
Официальная документация по модулю sensu.sensu_go.event_info.
Примеры
- 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 словарь | success | Объект, представляющий событие Sensu (устарело). Пример: {'check': {'check_hooks': None, 'command': 'check-cpu.sh -w 75 -c 90', 'duration': 1.07055808, 'env_vars': None, '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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/sensu/sensu_go/event_module.html
