Spec-Zone.ru › Ansible 2.11

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

Примечание

Этот плагин является частью коллекции community.general (версия 2.0.1).

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

Чтобы использовать его в плейбуке, укажите: community.general.sensu_handler.

  • Описание
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Описание

  • Управляет конфигурацией обработчика 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 требуется только для обработчиков Transport (т.е. обработчиков, сконфигурированных с "type": "transport").
severities
список / элементы=строка
Массив степеней тяжести результатов проверки, которые будет обрабатывать обработчик.
ПРИМЕЧАНИЕ: разрешение события игнорирует эту фильтрацию.
Пример: [ 'warning', 'critical', 'unknown' ].
socket
словарь
Область определения сокета, используемая для настройки сокета обработчика TCP/UDP.
ПРИМЕЧАНИЕ: атрибут socket требуется только для обработчиков TCP/UDP (т.е. обработчиков, сконфигурированных с "type": "tcp" или "type": "udp").
state
строка
    Варианты:
  • present ←
  • absent
Должен ли обработчик присутствовать или нет
timeout
целое число
По умолчанию:
10
Таймаут времени выполнения обработчика в секундах (жесткая остановка).
Используется только для типов обработчиков pipe и tcp.
type
строка
    Варианты:
  • pipe
  • tcp
  • udp
  • transport
  • set
Тип обработчика

Примечания

Примечание

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

Примеры

# 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
словарь
успех
Эффективная конфигурация обработчика, когда состояние present

Пример:
{'command': '/usr/local/bin/notify-irc.sh', 'name': 'irc', 'type': 'pipe'}
file
строка
успех
Путь к файлу конфигурации обработчика

Пример:
/etc/sensu/conf.d/handlers/irc.json
name
строка
успех
Имя обработчика

Пример:
irc


Авторы

  • David Moreau Simard (@dmsimard)

© 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/community/general/sensu_handler_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API