ec2_metric_alarm – Создание/обновление или удаление «метрических тревог» AWS Cloudwatch
Описание
- Может создавать или удалять метрические тревоги AWS.
- Метрики, на которые вы хотите настроить тревоги, должны уже существовать.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.6
- boto
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| alarm_actions - | Список действий, выполняемых, когда тревога находится в состоянии «тревога», обозначенных как Amazon Resource Name(s) | |
| aws_access_key строка | Ключ доступа AWS. Если не задан, используется значение переменной среды AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY. псевдонимы: ec2_access_key, access_key | |
| aws_secret_key строка | Секретный ключ AWS. Если не задан, используется значение переменной среды AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY. псевдонимы: ec2_secret_key, secret_key | |
| comparison - |
| Определяет, как сравнивается пороговое значение |
| debug_botocore_endpoint_logs логическое добавлен в 2.8 |
| Использование логгера botocore.endpoint для анализа уникальных (а не общих) API-вызовов «resource:action», сделанных во время задачи, выводящихся в ключ resource_actions результатов задачи. Используйте обратный вызов aws_resource_action для вывода общего списка, сделанного во время выполнения плейбука. Также может использоваться переменная среды ANSIBLE_DEBUG_BOTOCORE_LOGS. |
| description - | Более подробное описание тревоги | |
| dimensions - | Описание того, к чему применяется тревога | |
| ec2_url строка | URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль будет использовать конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если регион не используется. Если не указан, используется значение переменной среды EC2_URL. | |
| evaluation_periods - | Количество раз, когда метрика оценивается перед окончательным расчетом | |
| insufficient_data_actions - | Список имен действий, которые необходимо выполнить, когда тревога находится в состоянии «недостаточно данных» | |
| metric - | Имя контролируемой метрики (например, CPUUtilization) Метрика должна уже существовать | |
| name - / обязательно | Уникальное имя для тревоги | |
| namespace - | Имя соответствующего пространства имен ('AWS/EC2', 'System/Linux' и т.д.), которое определяет категорию, под которой оно будет отображаться в cloudwatch | |
| ok_actions - | Список имен действий, которые нужно выполнить, когда тревога находится в состоянии «в порядке», обозначенных как Amazon Resource Name(s) | |
| period - | Время (в секундах) между оценками метрики | |
| profile строка | Использует профиль boto. Работает только с boto >= 2.24.0. | |
| region строка | AWS-регион для использования. Если не указан, используется значение переменной среды AWS_REGION или EC2_REGION, если есть. См. http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region
псевдонимы: aws_region, ec2_region | |
| security_token строка | Токен безопасности AWS STS. Если не задан, используется значение переменной среды AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. псевдонимы: access_token | |
| state - / обязательно |
| регистрация или отмена регистрации тревоги |
| statistic - |
| Операция, применяемая к метрике Работает в совокупности с period и evaluation_periods для определения значения сравнения |
| threshold - | Устанавливает минимальное/максимальное ограничение для срабатывания тревоги | |
| unit - |
| Единица измерения порога |
| validate_certs логическое |
| При значении "нет" сертификаты SSL не будут проверены для версий boto >= 2.6.0. |
Примечания
Примечание
- Если параметры не заданы в модуле, могут использоваться следующие переменные среды в порядке убывания приоритета
AWS_URLилиEC2_URL,AWS_ACCESS_KEY_IDилиAWS_ACCESS_KEYилиEC2_ACCESS_KEY,AWS_SECRET_ACCESS_KEYилиAWS_SECRET_KEYилиEC2_SECRET_KEY,AWS_SECURITY_TOKENилиEC2_SECURITY_TOKEN,AWS_REGIONилиEC2_REGION - Ansible использует конфигурационный файл boto (обычно ~/.boto), если учетные данные не предоставлены. См. https://boto.readthedocs.io/en/latest/boto_config_tut.html
-
AWS_REGIONилиEC2_REGIONобычно используются для указания AWS-региона, когда это необходимо, но это также можно настроить в конфигурационном файле boto
Примеры
- name: create alarm
ec2_metric_alarm:
state: present
region: ap-southeast-2
name: "cpu-low"
metric: "CPUUtilization"
namespace: "AWS/EC2"
statistic: Average
comparison: "<="
threshold: 5.0
period: 300
evaluation_periods: 3
unit: "Percent"
description: "This will alarm when a bamboo slave's cpu usage average is lower than 5% for 15 minutes "
dimensions: {'InstanceId':'i-XXX'}
alarm_actions: ["action1","action2"]
- name: Create an alarm to recover a failed instance
ec2_metric_alarm:
state: present
region: us-west-1
name: "recover-instance"
metric: "StatusCheckFailed_System"
namespace: "AWS/EC2"
statistic: "Minimum"
comparison: ">="
threshold: 1.0
period: 60
evaluation_periods: 2
unit: "Seconds"
description: "This will recover an instance when it fails"
dimensions: {"InstanceId":'i-XXX'}
alarm_actions: ["arn:aws:automate:us-west-1:ec2:recover"]
Статус
- Гарантируется, что этот модуль не будет иметь несовместимых изменений в обратном направлении в будущем. [stableinterface]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- Zacharie Eakin (@Zeekin)
Подсказка
Если вы обнаружите какие-либо проблемы в этой документации, вы можете изменить этот документ для его улучшения.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/ec2_metric_alarm_module.html