ec2_metric_alarm – Создание/обновление или удаление метрических срабатываний AWS Cloudwatch
Новая версия 1.6.
Описание
- Может создавать или удалять метрические срабатывания AWS.
- Метрики, на которые вы хотите настроить срабатывание, должны уже существовать.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.6
- boto
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| alarm_actions - | Список действий, выполняемых, когда состояние срабатывания — 'alarm' | |
| 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 - |
| Определяет, как сравнивается пороговое значение |
| description - | Подробное описание срабатывания | |
| dimensions - | Определяет, к чему применяется срабатывание | |
| ec2_url - | URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если она есть. | |
| evaluation_periods - | Количество раз, когда метрика оценивается перед окончательным расчётом | |
| insufficient_data_actions - | Список имен действий, выполняемых, когда состояние срабатывания — 'insufficient_data' | |
| metric - | Имя контролируемой метрики (например, CPUUtilization) Метрика должна уже существовать | |
| name - / обязательно | Уникальное имя для срабатывания | |
| namespace - | Имя соответствующего пространства имён ('AWS/EC2', 'System/Linux' и т.д.), которое определяет категорию, под которой оно будет отображаться в Cloudwatch | |
| ok_actions - | Список имен действий, выполняемых, когда состояние срабатывания — 'ok' | |
| period - | Время (в секундах) между оценками метрики | |
| profile - добавлено в 1.6 | Использует профиль 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 - добавлено в 1.6 | Токен безопасности AWS STS. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. Псевдонимы: access_token | |
| state - / обязательно |
| Регистрация или отмена регистрации срабатывания |
| statistic - |
| Операция, применяемая к метрике Работает совместно с period и evaluation_periods для определения значения сравнения |
| threshold - | Устанавливает минимальную/максимальную границу для срабатывания сигнализации | |
| unit - |
| Единица измерения порога |
| validate_certs boolean добавлено в 1.5 |
| При значении "нет", сертификаты 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"]
Статус
- Этот модуль гарантированно не будет иметь обратной несовместимости в будущих изменениях. [stableinterface]
- Этот модуль поддерживается партнёром Ansible. [certified]
Авторы
- 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.7/modules/ec2_metric_alarm_module.html