sensu_handler - Управление конфигурацией обработчика Sensu
Новое в версии 2.4.
Обзор
- Управляет конфигурацией обработчика Sensu
- Для получения дополнительной информации см. документацию Sensu: https://sensuapp.org/docs/latest/reference/handlers.html
Параметры
| параметр | обязательно | по умолчанию | значения | комментарии |
|---|---|---|---|---|
| command | нет | Команда обработчика, которая должна быть выполнена. Данные события передаются в процесс через STDIN. ПРИМЕЧАНИЕ: атрибут command требуется только для обработчиков типа Pipe (т.е. обработчиков, сконфигурированных с "type": "pipe"). | ||
| filter | нет | Фильтр событий Sensu (имя), используемый при фильтрации событий для обработчика. | ||
| filters | нет | Массив фильтров событий Sensu (имена), используемых при фильтрации событий для обработчика. Каждый элемент массива должен быть строкой. | ||
| handle_flapping | нет | Обрабатывать ли события в состоянии flapping. | ||
| handle_silenced | нет | Обрабатывать ли события, соответствующие одному или нескольким записям о молчании. | ||
| handlers | да | Массив обработчиков событий Sensu (имена), используемых для событий, использующих заданный обработчик. Каждый элемент массива должен быть строкой. ПРИМЕЧАНИЕ: атрибут handlers требуется только для наборов обработчиков (т.е. обработчиков, сконфигурированных с "type": "set"). | ||
| mutator | нет | Используемый мутатор событий Sensu (имя) для изменения данных события для обработчика. | ||
| name | да | Уникальное имя обработчика. Имя не может содержать специальные символы или пробелы. | ||
| pipe | нет | Область определения конвейера, используемая для настройки конвейера транспортировки Sensu. ПРИМЕЧАНИЕ: атрибут pipe требуется только для обработчиков транспорта (т.е. обработчиков, сконфигурированных с "type": "transport"). | ||
| severities | нет |
| Массив степеней серьезности результатов проверок, обрабатываемых обработчиком. ПРИМЕЧАНИЕ: разрешение событий обходит эту фильтрацию. | |
| socket | нет | Область определения сокета, используемая для настройки сокета обработчика TCP/UDP. ПРИМЕЧАНИЕ: атрибут socket требуется только для обработчиков TCP/UDP (т.е. обработчиков, сконфигурированных с "type": "tcp" или "type": "udp"). | ||
| state | нет | present |
| Должен ли обработчик присутствовать или нет |
| timeout | нет | 10 | Тайм-аут выполнения обработчика в секундах (жесткая остановка). Используется только для типов обработчиков pipe и tcp. | |
| type | да |
| Тип обработчика |
Примеры
# Configure a handler that sends event data as STDIN (pipe)
- name: Configure IRC Sensu handler
sensu_handler:
name: "irc_handler"
type: "pipe"
command: "/usr/local/bin/notify-irc.sh"
severities:
- "ok"
- "critical"
- "warning"
- "unknown"
timeout: 15
notify:
- Restart sensu-client
- Restart sensu-server
# Delete a handler
- name: Delete IRC Sensu handler
sensu_handler:
name: "irc_handler"
state: "absent"
# Example of a TCP handler
- name: Configure TCP Sensu handler
sensu_handler:
name: "tcp_handler"
type: "tcp"
timeout: 30
socket:
host: "10.0.1.99"
port: 4444
register: handler
notify:
- Restart sensu-client
- Restart sensu-server
- name: Secure Sensu handler configuration file
file:
path: "{{ handler['file'] }}"
owner: "sensu"
group: "sensu"
mode: "0600"
Возвращаемые значения
Общие возвращаемые значения документированы здесь Возвращаемые значения, следующие поля уникальны для этого модуля:
| имя | описание | возвращено | тип | пример |
|---|---|---|---|---|
| config | Эффективная конфигурация обработчика, когда состояние present | успех | словарь | {'type': 'pipe', 'command': '/usr/local/bin/notify-irc.sh', 'name': 'irc'} |
| file | Путь к файлу конфигурации обработчика | успех | строка | /etc/sensu/conf.d/handlers/irc.json |
| name | Имя обработчика | успех | строка | irc |
Примечания
Примечание
- Поддерживается режим проверки
Статус
Этот модуль помечен как предварительный, что означает, что его интерфейс не гарантируется обратно совместимым.
Для получения помощи в разработке модулей, если вы так решите, ознакомьтесь с Информацией о сообществе и участии в разработке, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/sensu_handler_module.html