Модуль community.general.sensu_handler – Управление конфигурацией обработчика Sensu

Примечание

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

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

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

Для использования в playbook, укажите: community.general.sensu_handler.

Краткое описание
Параметры
Атрибуты
Примечания
Примеры
Возвращаемые значения

Краткое описание

Управляет конфигурацией обработчика Sensu
Для получения дополнительной информации обратитесь к документации Sensu: https://sensuapp.org/docs/latest/reference/handlers.html

Параметры

Параметр	Комментарии
command string	Команда обработчика, которая будет выполнена. Данные события передаются процессу через STDIN. ПРИМЕЧАНИЕ: атрибут command необходим только для обработчиков Pipe (т.е. обработчики, настроенные с “type”: “pipe”).
filter string	Фильтр событий Sensu (имя), который будет использоваться при фильтрации событий для обработчика.
filters list / elements=string	Массив фильтров событий Sensu (имена), которые будут использоваться при фильтрации событий для обработчика. Каждый элемент массива должен быть строкой.
handle_flapping boolean	Следует ли обрабатывать события в состоянии flapping. Варианты: `false` ← (по умолчанию) `true`
handle_silenced boolean	Следует ли обрабатывать события, соответствующие одной или нескольким записям о заглушении. Варианты: `false` ← (по умолчанию) `true`
handlers list / elements=string	Массив обработчиков событий Sensu (имена), которые будут использоваться для событий, использующих набор обработчиков. ПРИМЕЧАНИЕ: атрибут handlers необходим только для наборов обработчиков (т.е. обработчики, настроенные с “type”: “set”).
mutator string	Мутатор событий Sensu (имя), который будет использоваться для изменения данных события для обработчика.
name string / required	Уникальное имя для обработчика. Имя не может содержать специальных символов или пробелов.
pipe dictionary	Область определения pipe, используемая для настройки транспортного канала pipe Sensu. ПРИМЕЧАНИЕ: атрибут pipe необходим только для обработчиков Transport (т.е. обработчики, настроенные с “type”: “transport”).
severities list / elements=string	Массив степеней серьезности результатов проверки, которые будет обрабатывать обработчик. ПРИМЕЧАНИЕ: разрешение события обходит эту фильтрацию. Пример: [ ‘warning’, ‘critical’, ‘unknown’ ].
socket dictionary	Область определения сокета, используемая для настройки сокета обработчика TCP/UDP. ПРИМЕЧАНИЕ: атрибут socket необходим только для обработчиков TCP/UDP (т.е. обработчики, настроенные с “type”: “tcp” или “type”: “udp”).
state string	Должен ли обработчик присутствовать или нет Варианты: `"present"` ← (по умолчанию) `"absent"`
timeout integer	Тайм-аут выполнения обработчика в секундах (жесткая остановка). Используется только типами обработчиков pipe и tcp. По умолчанию: `10`
type string	Тип обработчика Варианты: `"pipe"` `"tcp"` `"udp"` `"transport"` `"set"`

Атрибуты

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

Примечания

Примечание

Поддерживается режим проверки

Примеры

# Configure a handler that sends event data as STDIN (pipe)
- name: Configure IRC Sensu handler
  community.general.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
  community.general.sensu_handler:
    name: "irc_handler"
    state: "absent"

# Example of a TCP handler
- name: Configure TCP Sensu handler
  community.general.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
  ansible.builtin.file:
    path: "{{ handler['file'] }}"
    owner: "sensu"
    group: "sensu"
    mode: "0600"

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

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

Ключ	Описание
config dictionary	Эффективная конфигурация обработчика, когда состояние присутствует Возвращено: success Пример: `{"command": "/usr/local/bin/notify-irc.sh", "name": "irc", "type": "pipe"}`
file string	Путь к файлу конфигурации обработчика Возвращено: success Пример: `"/etc/sensu/conf.d/handlers/irc.json"`
name string	Имя обработчика Возвращено: success Пример: `"irc"`

Авторы

David Moreau Simard (@dmsimard)

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

© 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_handler_module.html