rax_mon_alarm - Создание или удаление тревоги Rackspace Cloud Monitoring.
Новая в версии 2.0.
Обзор
- Создает или удаляет тревогу Rackspace Cloud Monitoring, которая связывает существующую rax_mon_entity, rax_mon_check и rax_mon_notification_plan с критериями, определяющими условия, которые будут запускать те или иные уровни уведомлений. Поток модуля мониторинга Rackspace | rax_mon_entity -> rax_mon_check -> rax_mon_notification -> rax_mon_notification_plan -> rax_mon_alarm
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.6
- pyrax
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_key | Ключ API Rackspace, переопределяет credentials. псевдонимы: password | |
| auth_endpoint (добавлено в 1.5) | Значение по умолчанию: https://identity.api.rackspacecloud.com/v2.0/ | URI службы аутентификации. |
| check_id обязательно | Идентификатор проверки, на которую необходимо настроить оповещение. Можно получить, зарегистрировав значение задачи rax_mon_check. | |
| credentials | Значение по умолчанию: None | Файл для поиска учетных данных Rackspace. Игнорируется, если предоставлены api_key и username. псевдонимы: creds_file |
| criteria | DSL тревог, описывающий условия оповещения и их выходные состояния. Длина должна быть от 1 до 16384 символов. См. http://docs.rackspace.com/cm/api/v1.0/cm-devguide/content/alerts-language.html для справки по языку оповещения. | |
| disabled |
| Если yes, то создать тревогу в неактивном состоянии. По умолчанию no. |
| entity_id обязательно | Идентификатор объекта, к которому прикреплена эта тревога. Можно получить, зарегистрировав значение задачи rax_mon_entity. | |
| env (добавлено в 1.5) | Окружение, как настроено в ~/.pyrax.cfg, см. https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#pyrax-configuration. | |
| identity_type (добавлено в 1.5) | Значение по умолчанию: rackspace | Механизм аутентификации, например, rackspace или keystone. |
| label обязательно | Понятное имя для этой тревоги, используется для достижения идемпотентности. Должно быть строкой длиной от 1 до 255 символов. | |
| metadata | Произвольные пары ключ-значение для сопровождения тревоги. Должен быть словарем строк-ключей и значений длиной от 1 до 255 символов. | |
| notification_plan_id обязательно | Идентификатор плана уведомлений, который запускается, если срабатывает эта тревога. Можно получить, зарегистрировав значение задачи rax_mon_notification_plan. | |
| region | Значение по умолчанию: DFW | Регион для создания экземпляра. |
| state |
| Обеспечить, чтобы тревога с данным label существовала или не существовала. |
| tenant_id (добавлено в 1.5) | Идентификатор клиента, используемый для аутентификации. | |
| tenant_name (добавлено в 1.5) | Имя клиента, используемое для аутентификации. | |
| username | Имя пользователя Rackspace, переопределяет credentials. | |
| verify_ssl (добавлено в 1.5) | Требуется ли валидация SSL для API-точек входа. |
Примечания
Примечание
- Можно использовать следующие переменные среды:
RAX_USERNAME,RAX_API_KEY,RAX_CREDS_FILE,RAX_CREDENTIALS,RAX_REGION. -
RAX_CREDENTIALSиRAX_CREDS_FILEуказывают на файл учетных данных, подходящий для pyrax. См. https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#authenticating -
RAX_USERNAMEиRAX_API_KEYисключают использование файла учетных данных. -
RAX_REGIONопределяет регион Rackspace Public Cloud (DFW, ORD, LON, ...)
Примеры
- name: Alarm example
gather_facts: False
hosts: local
connection: local
tasks:
- name: Ensure that a specific alarm exists.
rax_mon_alarm:
credentials: ~/.rax_pub
state: present
label: uhoh
entity_id: "{{ the_entity['entity']['id'] }}"
check_id: "{{ the_check['check']['id'] }}"
notification_plan_id: "{{ defcon1['notification_plan']['id'] }}"
criteria: >
if (rate(metric['average']) > 10) {
return new AlarmStatus(WARNING);
}
return new AlarmStatus(OK);
register: the_alarm
Статус
Этот модуль помечен как предварительный, что означает, что его интерфейс не гарантирует обратную совместимость.
Автор
- Ash Wilson
Подсказка
Если вы заметите какие-либо проблемы в этом документе, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.5/modules/rax_mon_alarm_module.html