ec2_metric_alarm – Создание/обновление или удаление AWS Cloudwatch «метрик тревог»
Обзор
- Может создавать или удалять метрики тревог AWS.
- Метрики, по которым вы хотите настроить тревогу, должны уже существовать.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 2.6
- boto
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| alarm_actions - | Список имен действий, выполняемых при состоянии тревоги ('alarm'), указанных как Amazon Resource Name(ы) | |
| 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, чтобы вывести в список всех API-вызовов, выполненных во время выполнения плейбука. Также может использоваться переменная среды ANSIBLE_DEBUG_BOTOCORE_LOGS. |
| 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', указанных как Amazon Resource Name(ы) | |
| 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 security token. Если не задан, используется значение переменной среды 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: "Count"
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.9/modules/ec2_metric_alarm_module.html