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 | да | ID проверки, на которую следует настроить оповещения. Может быть получен путем регистрации значения задачи rax_mon_check. | ||
| credentials | нет | Файл для поиска учетных данных 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 | нет |
| Если да, создает эту тревогу, но оставляет ее в неактивном состоянии. По умолчанию нет. | |
| entity_id | да | 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 | да | ID плана оповещений, который срабатывает при возникновении этой тревоги. Может быть получен путем регистрации значения задачи rax_mon_notification_plan. | ||
| region | нет | DFW | Регион для создания экземпляра. | |
| state | нет | present |
| Обеспечение существования или отсутствия тревоги с данным label. |
| tenant_id (добавлен в 1.5)
| нет | Идентификатор клиента, используемый для аутентификации. | ||
| tenant_name (добавлен в 1.5)
| нет | Имя клиента, используемое для аутентификации. | ||
| username | нет | Имя пользователя Rackspace, переопределяет credentials. | ||
| verify_ssl (добавлен в 1.5)
| нет | Требуется ли проверка SSL для конечных точек API. |
Примеры
- 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
Примечания
Примечание
- Следующие переменные среды могут быть использованы:
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, ...)
Статус
Этот модуль помечен как бета-версия, что означает, что его интерфейс не гарантируется обратной совместимостью.
Для помощи в разработке модулей, если у вас есть желание, прочитайте Справочная информация по сообществу и участие в разработке, Тестирование 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/rax_mon_alarm_module.html