Модуль amazon.aws.cloudwatch_metric_alarm – Создание/обновление или удаление метрик AWS CloudWatch «alarms»

Примечание

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

Вы, возможно, уже установили эту коллекцию, если используете пакет 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 metric alarms.
Метрики, по которым нужно установить оповещения, должны уже существовать.
До версии 5.0.0 этот модуль назывался community.aws.ec2_metric_alarm. Использование не изменилось.
Этот модуль был первоначально добавлен в community.aws в версии 1.0.0.

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

Требования

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

python >= 3.6
boto3 >= 1.26.0
botocore >= 1.29.0

END_OF_DOCUMENT_MARKER

Параметры

Параметр	Комментарии
access_key aliases: aws_access_key_id, aws_access_key, ec2_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` или `EC2_ACCESS_KEY` также могут использоваться в порядке убывания предпочтения. Параметры aws_access_key и profile являются взаимоисключающими. Псевдоним aws_access_key_id был добавлен в релизе 5.1.0 для согласованности с SDK AWS botocore. Псевдоним ec2_access_key устарел и будет удален в релизе после 2024-12-01. Поддержка переменной среды `EC2_ACCESS_KEY` устарела и будет удалена в релизе после 2024-12-01.
alarm_actions list / elements=string	Список имен действия(й), выполняемых, когда тревога находится в статусе `alarm`, обозначенных как Amazon Resource Name(s). По умолчанию: `[]`
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` регистратор для анализа уникальных (а не общих) `"resource:action"` вызовов API, сделанных во время задачи, выводя набор в ключ resource_actions в результатах задачи. Используйте обратный вызов `aws_resource_action` для вывода в общий список, сделанный во время playbook. Переменная среды `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: ec2_url, aws_endpoint_url, s3_url string	URL для подключения вместо стандартных конечных точек AWS. Хотя это может использоваться для подключения к другим совместимым с AWS сервисам, коллекции amazon.aws и community.aws тестируются только с AWS. Переменные среды `AWS_URL` или `EC2_URL` также могут использоваться в порядке убывания предпочтения. Псевдонимы ec2_url и s3_url устарели и будут удалены в релизе после 2024-12-01. Поддержка переменной среды `EC2_URL` устарела и будет удалена в релизе после 2024-12-01.
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 added in amazon.aws 5.5.0	Массив структур MetricDataQuery, которые позволяют создавать оповещение на основе результата выражения математики метрик. Default: `[]`
account_id string	Идентификатор учетной записи, где расположены метрики, если это оповещение для разных учетных записей.
expression string	Это поле может содержать либо запрос Metrics Insights, либо выражение математики метрик, которое будет выполнено над возвращенными данными.
id string / required	Краткое имя, используемое для привязки этого объекта к результатам в ответе.
label string	Читаемый человеком ярлык для этой метрики или выражения.
metric_stat dictionary	Метрика, которая должна быть возвращена, вместе со статистикой, периодом и единицами измерения.
metric dictionary	Метрика для возврата, включая имя метрики, пространство имен и размеры.
dimensions list / elements=dictionary	Пара имя/значение, которая является частью идентификатора метрики.
name string / required	Имя измерения.
value string / required	Значение измерения.
metric_name string / required	Имя метрики.
namespace string	Пространство имен метрики.
period integer / required	Гранулярность, в секундах, возвращаемых точек данных.
stat string / required	Статистика для возврата. Она может включать любую статистику CloudWatch или расширенную статистику.
unit string	Единица измерения, используемая при хранении метрики.
period integer	Гранулярность, в секундах, возвращаемых точек данных.
return_data boolean	Этот параметр указывает, следует ли возвращать метки времени и необработанные значения данных этой метрики. Choices: `false` `true`
name string / required	Уникальное имя для оповещения.
namespace string	Имя соответствующего пространства имен (`AWS/EC2`, `System/Linux`, и т.д.), которое определяет категорию, в которой оно будет отображаться в CloudWatch.
ok_actions list / elements=string	Список имен действия(действий), которые необходимо выполнить, когда оповещение находится в статусе `ok`, обозначенном как имя(имена) ресурса Amazon. Default: `[]`
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 и security_token.

region aliases: aws_region, ec2_region string	Регион AWS для использования. Для глобальных служб, таких как IAM, Route53 и CloudFront, параметр region игнорируется. Также могут использоваться переменные окружения `AWS_REGION` или `EC2_REGION`. См. документацию Amazon AWS для получения дополнительной информации http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. Псевдоним `ec2_region` устарел и будет удален в релизе после 2024-12-01 Поддержка переменной окружения `EC2_REGION` устарела и будет удалена в релизе после 2024-12-01.
secret_key aliases: aws_secret_access_key, aws_secret_key, ec2_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` или `EC2_SECRET_KEY` в порядке убывания предпочтения. Параметры secret_key и profile являются взаимоисключающими. Псевдоним aws_secret_access_key был добавлен в релизе 5.1.0 для согласованности с AWS botocore SDK. Псевдоним ec2_secret_key устарел и будет удален в релизе после 2024-12-01. Поддержка переменной окружения `EC2_SECRET_KEY` устарела и будет удалена в релизе после 2024-12-01.
session_token aliases: aws_session_token, security_token, aws_security_token, access_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`, `AWS_SECURITY_TOKEN` или `EC2_SECURITY_TOKEN` в порядке убывания предпочтения. Параметры security_token и profile являются взаимоисключающими. Псевдонимы aws_session_token и session_token были добавлены в релизе 3.2.0, а параметр был переименован из security_token в session_token в релизе 6.0.0. Псевдонимы security_token, aws_security_token и access_token устарели и будут удалены в релизе после 2024-12-01. Поддержка переменных окружения `EC2_SECRET_KEY` и `AWS_SECURITY_TOKEN` устарела и будет удалена в релизе после 2024-12-01.
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, а не из контекста узла.
SDK AWS (boto3), который использует Ansible, также может считывать значения по умолчанию для учетных данных и других параметров, таких как регион, из своих конфигурационных файлов в контексте узла 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 boolean	Указывает, должны ли выполняться действия при любых изменениях состояния сигнализации. Возвращается: всегда
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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/amazon/aws/cloudwatch_metric_alarm_module.html