community.aws.ec2_metric_alarm – Создание/обновление или удаление уведомлений AWS Cloudwatch по метрикам
Примечание
Этот плагин входит в состав коллекции community.aws (версия 1.3.0).
Для его установки используйте: ansible-galaxy collection install community.aws.
Для использования в книге задач укажите: community.aws.ec2_metric_alarm.
В версии 1.0.0: коллекции community.aws
Описание
- Может создавать или удалять уведомления 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. Если задан параметр profile, этот параметр игнорируется. Передача параметров aws_access_key и profile одновременно устарела и будет сделана взаимоисключающей после 2022-06-01. Псевдонимы: ec2_access_key, access_key | |
| aws_ca_bundle путь | Расположение файла с набором сертификатов CA для проверки SSL-сертификатов. Используется только для модулей, основанных на boto3. Примечание: Набор сертификатов CA считывается со стороны модуля и, возможно, требует явного копирования с контроллера, если он не запущен локально. | |
| aws_config словарь | Словарь для изменения конфигурации botocore. Параметры можно найти по адресу https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. Для модулей boto используется только ключ 'user_agent'. Более подробную информацию о конфигурации boto можно найти по адресу http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto. | |
| aws_secret_key строка | Секретный ключ AWS. Если не задан, используется значение переменной окружения AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY. Если задан параметр profile, этот параметр игнорируется. Передача параметров aws_secret_key и profile одновременно устарела и будет сделана взаимоисключающей после 2022-06-01. Псевдонимы: ec2_secret_key, secret_key | |
| comparison строка |
| Определяет, как сравнивается значение порога. Символьные операторы сравнения устарели и будут удалены после 2022-06-22. |
| debug_botocore_endpoint_logs логический |
| Использовать логгер botocore.endpoint для анализа уникальных (а не общих) API-вызовов "ресурс:действие" во время задачи, выводя набор в ключ resource_actions результатов задачи. Используйте обратный вызов aws_resource_action, чтобы вывести общий список, созданный во время книги задач. Переменная среды ANSIBLE_DEBUG_BOTOCORE_LOGS также может быть использована. |
| description строка | Более подробное описание уведомления. | |
| dimensions словарь | Словарь, описывающий метрику, к которой применяется уведомление. Дополнительную информацию см. в документации AWS: | |
| ec2_url строка | URL для подключения к облаку EC2 или Eucalyptus (по умолчанию модуль будет использовать конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если регион не используется. Если не задано, используется значение переменной окружения EC2_URL, если таковая есть. Псевдонимы: aws_endpoint_url, endpoint_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. Использование profile переопределит aws_access_key, aws_secret_key и security_token. Поддержка одновременной передачи этих параметров с параметром profile устарела. aws_access_key, aws_secret_key и security_token будут сделаны взаимоисключающими с profile после 2022-06-01. Псевдонимы: aws_profile | |
| 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. Если задан параметр profile, этот параметр игнорируется. Передача параметров security_token и profile одновременно устарела и будет сделана взаимоисключающей после 2022-06-01. Псевдонимы: aws_security_token, access_token | |
| state строка |
| Зарегистрировать или аннулировать уведомление. |
| statistic строка |
| Операция, применяемая к метрике. Работает в сочетании с period и evaluation_periods для определения значения сравнения. |
| threshold число с плавающей точкой | Устанавливает минимальное/максимальное значение для срабатывания уведомления. | |
| treat_missing_data строка |
| Определяет, как уведомление обрабатывает пропущенные данные. |
| unit строка |
| Единица измерения порога. |
| validate_certs логический |
| При значении "нет" SSL-сертификаты не будут проверены для boto-версий >= 2.6.0. |
Примечания
Примечание
- Если параметры не заданы в модуле, можно использовать следующие переменные среды в порядке убывания приоритета
AWS_URLилиEC2_URL,AWS_PROFILEилиAWS_DEFAULT_PROFILE,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,AWS_CA_BUNDLE - Ansible использует конфигурационный файл boto (обычно ~/.boto), если учетные данные не предоставлены. См. https://boto.readthedocs.io/en/latest/boto_config_tut.html
-
AWS_REGIONилиEC2_REGIONобычно используются для указания региона AWS, если это необходимо, но это также можно настроить в конфигурационном файле boto
Примеры
- name: create alarm
community.aws.ec2_metric_alarm:
state: present
region: ap-southeast-2
name: "cpu-low"
metric: "CPUUtilization"
namespace: "AWS/EC2"
statistic: Average
comparison: "LessThanOrEqualToThreshold"
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
community.aws.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"]
Авторы
- Zacharie Eakin (@Zeekin)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/aws/ec2_metric_alarm_module.html