Модуль amazon.aws.cloudwatch_metric_alarm — создание, обновление или удаление метрических оповещений AWS CloudWatch

Примечание

Этот модуль входит в коллекцию amazon.aws (версия 11.3.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install amazon.aws. Для использования этого модуля нужны дополнительные требования; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: amazon.aws.cloudwatch_metric_alarm.

Добавлено в amazon.aws 5.0.0

Краткое описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

Создаёт или удаляет метрические оповещения AWS CloudWatch.
Метрики, для которых необходимо настроить оповещения, уже должны существовать.
До выпуска версии 5.0.0 этот модуль назывался community.aws.ec2_metric_alarm. Способ использования не изменился.
Впервые этот модуль был добавлен в community.aws в версии 1.0.0.

Псевдонимы: ec2_metric_alarm

Требования

Следующие требования должны быть выполнены на хосте, который выполняет этот модуль.

python >= 3.6
boto3 >= 1.35.0
botocore >= 1.35.0

Параметры

Параметр	Комментарии
access_key aliases: aws_access_key_id, aws_access_key string	Идентификатор ключа доступа AWS. Дополнительные сведения о токенах доступа см. в документации AWS https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменные среды `AWS_ACCESS_KEY_ID` или `AWS_ACCESS_KEY` в порядке убывания приоритета. Параметры aws_access_key и profile являются взаимоисключающими. Псевдоним aws_access_key_id добавлен в выпуске 5.1.0 для соответствия AWS SDK botocore.
alarm_actions list / elements=string	Список имен действий, выполняемых, когда сигнализация находится в состоянии `alarm`; имена указаны в формате Amazon Resource Name. По умолчанию: `[]`
aws_ca_bundle path	Путь к пакету CA для проверки SSL-сертификатов. Также можно использовать переменную среды `AWS_CA_BUNDLE`.
aws_config dictionary	Словарь для изменения конфигурации botocore. Параметры описаны в документации AWS https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.
comparison string	Определяет способ сравнения с пороговым значением Варианты: `"GreaterThanOrEqualToThreshold"` `"GreaterThanThreshold"` `"LessThanThreshold"` `"LessThanOrEqualToThreshold"`
datapoints_to_alarm integer добавлено в amazon.aws 8.2.0	Количество точек данных, которые должны превысить пороговое значение, чтобы сработала сигнализация.
debug_botocore_endpoint_logs boolean	Использовать регистратор `botocore.endpoint` для разбора уникальных (а не общих) вызовов API `"resource:action"`, выполненных во время задачи, и выводить их набор в ключ resource_actions результатов задачи. Используйте callback `aws_resource_action` для вывода общего списка вызовов, выполненных в ходе плейбука. Также можно использовать переменную среды `ANSIBLE_DEBUG_BOTOCORE_LOGS`. Варианты: `false` ← (по умолчанию) `true`
description string	Подробное описание сигнализации.
dimensions dictionary	Словарь с описанием метрики, к которой применяется сигнализация. Дополнительные сведения см. в документации AWS: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Dimension
endpoint_url aliases: aws_endpoint_url string	URL для подключения вместо конечных точек AWS по умолчанию. Хотя этот параметр можно использовать для подключения к другим службам, совместимым с AWS, коллекции amazon.aws и community.aws тестируются только с AWS. Также можно использовать переменную среды `AWS_URL`.
evaluate_low_sample_count_percentile string добавлено в amazon.aws 8.2.0	Используется только для сигнализаций, основанных на процентилях. Если указать `ignore`, состояние сигнализации не изменится в периоды, когда точек данных слишком мало для статистической значимости. Если указать `evaluate` или не указывать этот параметр, состояние сигнализации оценивается и может измениться независимо от количества доступных точек данных. Варианты: `"ignore"` `"evaluate"`
evaluation_periods integer	Количество периодов, в течение которых оценивается метрика перед окончательным вычислением.
extended_statistic string добавлено в amazon.aws 5.5.0	Статистика процентиля для метрики, указанной в имени метрики.
insufficient_data_actions list / elements=string	Список имен действий, выполняемых, когда сигнализация находится в состоянии `insufficient_data`. По умолчанию: `[]`
metric_name aliases: metric string	Имя отслеживаемой метрики (например, `CPUUtilization`). Метрика уже должна существовать.
metrics list / elements=dictionary добавлено в amazon.aws 5.5.0	Массив структур MetricDataQuery, позволяющих создать сигнализацию на основе результата выражения математической операции над метриками. По умолчанию: `[]`
account_id string	Идентификатор учетной записи, в которой находятся метрики, если сигнализация охватывает несколько учетных записей.
expression string	Это поле может содержать запрос Metrics Insights или выражение математической операции над метриками, которое будет применено к возвращенным данным.
id string / обязательный	Краткое имя, связывающее этот объект с результатами в ответе.
label string	Удобная для чтения метка этой метрики или выражения.
metric_stat dictionary	Метрика, которую нужно вернуть, вместе со статистикой, периодом и единицами измерения.
metric dictionary	Метрика для возврата, включая ее имя, пространство имен и измерения.
dimensions list / elements=dictionary	Пара «имя/значение», являющаяся частью идентификатора метрики.
name string / обязательный	Имя измерения.
value string / обязательный	Значение измерения.
metric_name string / обязательный	Имя метрики.
namespace string	Пространство имен метрики.
period integer / обязательный	Точность возвращаемых точек данных в секундах.
stat string / обязательный	Возвращаемая статистика. Это может быть любая статистика CloudWatch или расширенная статистика.
unit string	Единица измерения, используемая при сохранении метрики.
period integer	Точность возвращаемых точек данных в секундах.
return_data boolean	Этот параметр указывает, следует ли возвращать временные метки и исходные значения данных этой метрики. Варианты: `false` `true`
name string / обязательный	Уникальное имя сигнализации.
namespace string	Имя соответствующего пространства имен (`AWS/EC2`, `System/Linux` и т. д.), определяющее категорию, в которой оно будет отображаться в CloudWatch.
ok_actions list / elements=string	Список имен действий, выполняемых, когда сигнализация находится в состоянии `ok`; имена указаны в формате Amazon Resource Name. По умолчанию: `[]`
period integer	Интервал времени (в секундах) между вычислениями метрики.
profile aliases: aws_profile string	Именованный профиль AWS для аутентификации. Дополнительные сведения об именованных профилях см. в документации AWS https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. Также можно использовать переменную среды `AWS_PROFILE`. Параметр profile является взаимоисключающим с параметрами aws_access_key, aws_secret_key и session_token.
region aliases: aws_region string	Используемый регион AWS. Для глобальных служб, таких как IAM, Route53 и CloudFront, параметр region игнорируется. Также можно использовать переменную среды `AWS_REGION`. Дополнительные сведения см. в документации Amazon AWS http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.
secret_key aliases: aws_secret_access_key, aws_secret_key string	Секретный ключ доступа AWS. Дополнительные сведения о токенах доступа см. в документации AWS https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменные среды `AWS_SECRET_ACCESS_KEY` или `AWS_SECRET_KEY` в порядке убывания приоритета. Параметры secret_key и profile являются взаимоисключающими. Псевдоним aws_secret_access_key добавлен в выпуске 5.1.0 для соответствия AWS SDK botocore.
session_token aliases: aws_session_token string	Токен сеанса AWS STS для использования с временными учетными данными. Дополнительные сведения о токенах доступа см. в документации AWS https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменную среды `AWS_SESSION_TOKEN`. Параметры session_token и profile являются взаимоисключающими.
state string	Зарегистрировать или отменить регистрацию сигнализации. Варианты: `"present"` ← (по умолчанию) `"absent"`
statistic string	Операция, применяемая к метрике. В сочетании с `period` и `evaluation_periods` определяет значение для сравнения. Варианты: `"SampleCount"` `"Average"` `"Sum"` `"Minimum"` `"Maximum"`
threshold float	Задает минимальный/максимальный предел для срабатывания сигнализации.
treat_missing_data string	Задает способ обработки сигнализацией отсутствующих точек данных. Варианты: `"breaching"` `"notBreaching"` `"ignore"` `"missing"` ← (по умолчанию)
unit string	Единица измерения порогового значения. Варианты: `"Seconds"` `"Microseconds"` `"Milliseconds"` `"Bytes"` `"Kilobytes"` `"Megabytes"` `"Gigabytes"` `"Terabytes"` `"Bits"` `"Kilobits"` `"Megabits"` `"Gigabits"` `"Terabits"` `"Percent"` `"Count"` `"Bytes/Second"` `"Kilobytes/Second"` `"Megabytes/Second"` `"Gigabytes/Second"` `"Terabytes/Second"` `"Bits/Second"` `"Kilobits/Second"` `"Megabits/Second"` `"Gigabits/Second"` `"Terabits/Second"` `"Count/Second"` `"None"`
validate_certs boolean	Если установлено значение `false`, SSL-сертификаты не будут проверяться при взаимодействии с API AWS. Настоятельно не рекомендуется задавать validate_certs=false; вместо этого рассмотрите возможность использования aws_ca_bundle. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Внимание: Для модулей переменные среды и файлы конфигурации считываются из контекста «хоста» Ansible, а не из контекста «контроллера». Поэтому может потребоваться явно скопировать файлы на «хост». Для плагинов поиска и подключения переменные среды и файлы конфигурации считываются из контекста «контроллера» Ansible, а не из контекста «хоста».
Используемый Ansible пакет AWS SDK (boto3) также может считывать значения учетных данных и других параметров по умолчанию, например региона, из файлов конфигурации в контексте «хоста» Ansible (обычно ~/.aws/credentials). Дополнительные сведения см. на странице https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html.

Примеры

- name: create alarm
  amazon.aws.cloudwatch_metric_alarm:
    state: present
    region: ap-southeast-2
    name: "cpu-low"
    metric_name: "CPUUtilization"
    namespace: "AWS/EC2"
    statistic: Average
    comparison: "LessThanOrEqualToThreshold"
    threshold: 5.0
    period: 300
    evaluate_low_sample_count_percentile: "ignore"
    evaluation_periods: 3
    unit: "Percent"
    description: "This will alarm when a instance's CPU usage average is lower than 5% for 15 minutes"
    dimensions: {'InstanceId': 'i-XXX'}
    alarm_actions: ["action1", "action2"]

- name: create alarm with metrics
  amazon.aws.cloudwatch_metric_alarm:
    state: present
    region: ap-southeast-2
    name: "cpu-low"
    metrics:
      - id: 'CPU'
        metric_stat:
          metric:
            dimensions:
              name: "InstanceId"
              value: "i-xx"
            metric_name: "CPUUtilization"
            namespace: "AWS/EC2"
          period: "300"
          stat: "Average"
          unit: "Percent"
        return_data: false
    alarm_actions: ["action1", "action2"]

- name: Create an alarm to recover a failed instance
  amazon.aws.cloudwatch_metric_alarm:
    state: present
    region: us-west-1
    name: "recover-instance"
    metric: "StatusCheckFailed_System"
    namespace: "AWS/EC2"
    statistic: "Minimum"
    comparison: "GreaterThanOrEqualToThreshold"
    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"]

Возвращаемые значения

Общие возвращаемые значения описаны здесь, ниже перечислены поля, уникальные для этого модуля:

Ключ	Описание
actions_enabled логическое значение	Указывает, следует ли выполнять действия при любых изменениях состояния оповещения. Возвращается: всегда
alarm_actions список / элементы=строка	Действия, выполняемые при переходе этого оповещения из любого другого состояния в состояние ALARM. Возвращается: всегда
alarm_arn строка	Имя ресурса Amazon (ARN) оповещения. Возвращается: всегда
comparison строка	Арифметическая операция, используемая при сравнении указанной статистики с пороговым значением. Возвращается: всегда
description строка	Описание оповещения. Возвращается: всегда
dimensions список / элементы=словарь	Параметры метрики. Возвращается: всегда
name строка	Имя параметра. Возвращается: всегда
value строка	Значение параметра. Возвращается: всегда
evaluate_low_sample_count_percentile строка	Используется только для оповещений на основе процентилей. Если задано значение ignore, состояние оповещения не меняется в периоды, когда точек данных слишком мало для статистически значимого результата. Если задано значение evaluate или этот параметр не используется, состояние оповещения всегда оценивается и может измениться. Возвращается: всегда
evaluation_periods целое число	Количество периодов, за которые данные сравниваются с указанным пороговым значением. Возвращается: всегда
extended_statistic строка	Статистика процентиля для метрики, связанной с оповещением. Возвращается: всегда
insufficient_data_actions список / элементы=строка	Действия, выполняемые при переходе этого оповещения из любого другого состояния в состояние INSUFFICIENT_DATA. Возвращается: всегда
last_updated строка	Метка времени последнего обновления конфигурации оповещения. Возвращается: всегда
metric строка	Имя отслеживаемой метрики (например, `CPUUtilization`). Возвращается: всегда
metric_name строка	Имя отслеживаемой метрики (например, `CPUUtilization`). Возвращается: всегда
metrics список / элементы=словарь	Массив структур MetricDataQuery, используемый в оповещении на основе выражения математической обработки метрик. Возвращается: всегда
name строка	Уникальное имя оповещения. Возвращается: всегда
namespace строка	Имя соответствующего пространства имён (`AWS/EC2`, `System/Linux` и т. д.). Определяет категорию, в которой оно будет отображаться в CloudWatch. Возвращается: всегда
ok_actions список / элементы=строка	Действия, выполняемые при переходе этого оповещения из любого другого состояния в состояние OK. Возвращается: всегда
period целое число	Длительность в секундах, используемая при каждой оценке метрики, указанной в MetricName. Допустимые значения: 10, 30 и любое кратное 60. Возвращается: всегда
state_reason строка	Текстовое объяснение состояния оповещения. Возвращается: всегда
state_value строка	Значение состояния оповещения. Возвращается: всегда
statistic строка	Статистика для метрики, связанной с оповещением, за исключением процентиля. Возвращается: всегда
threshold число с плавающей точкой	Значение для сравнения с указанной статистикой. Возвращается: всегда
treat_missing_data строка	Определяет, как оповещение должно обрабатывать отсутствующие точки данных. Возвращается: всегда
unit строка	Единица измерения, используемая при сохранении метрики Возвращается: всегда

Авторы

Zacharie Eakin (@Zeekin)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/amazon/aws/cloudwatch_metric_alarm_module.html