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: of community.aws
Обзор
- Может создавать или удалять метрические предупреждения 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. Если задан параметр 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'. См. http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto для получения дополнительной информации о конфигурации 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:action», осуществляемых во время задачи, выводящих набор в ключ task results. Используйте обратный вызов aws_resource_action для вывода в список всех выполненных во время книги задач. |
| 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 список / элементы=строка | Список действий, выполняемых при статусе предупреждения, обозначенного как Amazon Resource Name(s). | |
| 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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/aws/ec2_metric_alarm_module.html