new module: cloudwatch_metric_alarm_info #988

mandar242 · 2022-08-30T19:41:35Z

SUMMARY

Depends-On: #1066

Should be merged only after #1028 is merged.

Adding a new module for retrieving cloudwatch metric alarms info.

Currently supports following boto API(s)
describe_alarms()

ISSUE TYPE

New Module Pull Request

COMPONENT NAME

cloudwatch_metric_alarm_info

ADDITIONAL INFORMATION

Will be useful in moving these tasks from aws cli commands to amazon.aws module.
https://github.com/ansible-collections/community.aws/blob/main/tests/integration/targets/cloudwatch_metric_alarm/tasks/main.yml#L63-L70
ansible-collections/community.aws#1440

The integration tests for this info module will be added to above tests, after the cloudwatch_metric_alarm module is migrated from community.aws to amazon.aws.

Sample playbook

---
- name: Create a metric alarm & get info
  hosts: localhost
  gather_facts: false
  tasks:
    - name: create alarm
      community.aws.cloudwatch_metric_alarm:
        state: present
        region: us-east-2
        name: "cpu-low-test-metric-alarm-1234"
        metric: "CPUUtilization"
        namespace: "AWS/EC2"
        statistic: Average
        comparison: "LessThanOrEqualToThreshold"
        threshold: 50.0
        period: 180
        evaluation_periods: 3
        unit: "Percent"
        description: "This will alarm when a instance's CPU usage average is lower than 50%"
        dimensions: {'InstanceId':'i-00a8b34xxxxxxxxxx'}

    - name: describe the metric alarm based on metric name and namespace
      amazon.aws.cloudwatch_metric_alarm_info:
        alarm_names:
          - cpu-low-test-metric-alarm-1234
      register: alarm_info

    - debug:
        var: alarm_info

ansibullbot · 2022-08-30T19:46:03Z

cc @jillr @s-hertel @tremble
click here for bot help

jillr · 2022-09-01T18:53:16Z

@mandar242 Can you please open a PR (tagged as DNM) in community.aws that tries using this module in the cloudwatch_metric_alarm tests? You'll need to put a Depends-On in the PR description to use this PR in the test pipeline.

plugins/modules/cloudwatch_metric_alarm_info.py

mandar242 · 2022-09-09T16:42:00Z

@mandar242 Can you please open a PR (tagged as DNM) in community.aws that tries using this module in the cloudwatch_metric_alarm tests? You'll need to put a Depends-On in the PR description to use this PR in the test pipeline.

@jillr opened a PR as suggested, seem to work fine :)
ansible-collections/community.aws#1440

softwarefactory-project-zuul · 2022-09-26T21:13:25Z

Build failed.

alinabuzachis · 2022-09-27T08:32:47Z

recheck

alinabuzachis · 2022-09-27T09:59:31Z

recheck

softwarefactory-project-zuul · 2022-09-27T10:48:37Z

Build failed.

alinabuzachis · 2022-09-27T10:50:46Z

@mandar242

2022-09-27 10:47:20.816227 \| controller \| TASK [cloudwatch_metric_alarm : get info on alarms] ****************************
--
2260 | 2022-09-27 10:47:20.816233 \| controller \| task path: /home/zuul/.ansible/collections/ansible_collections/amazon/aws/tests/integration/targets/cloudwatch_metric_alarm/tasks/main.yml:15
2261 | 2022-09-27 10:47:21.736500 \| controller \| Using module file /home/zuul/.ansible/collections/ansible_collections/amazon/aws/plugins/modules/cloudwatch_metric_alarm_info.py
2262 | 2022-09-27 10:47:21.736529 \| controller \| Pipelining is enabled.
2263 | 2022-09-27 10:47:21.736533 \| controller \| <testhost> ESTABLISH LOCAL CONNECTION FOR USER: zuul
2264 | 2022-09-27 10:47:21.736537 \| controller \| <testhost> EXEC /bin/sh -c 'ANSIBLE_DEBUG_BOTOCORE_LOGS=True /home/zuul/venv/bin/python && sleep 0'
2265 | 2022-09-27 10:47:21.736545 \| controller \| The full traceback is:
2266 | 2022-09-27 10:47:21.736548 \| controller \| Traceback (most recent call last):
2267 | 2022-09-27 10:47:21.736552 \| controller \|   File "<stdin>", line 121, in <module>
2268 | 2022-09-27 10:47:21.736556 \| controller \|   File "<stdin>", line 113, in _ansiballz_main
2269 | 2022-09-27 10:47:21.736559 \| controller \|   File "<stdin>", line 61, in invoke_module
2270 | 2022-09-27 10:47:21.736563 \| controller \|   File "/usr/lib64/python3.9/runpy.py", line 225, in run_module
2271 | 2022-09-27 10:47:21.736566 \| controller \|     return _run_module_code(code, init_globals, run_name, mod_spec)
2272 | 2022-09-27 10:47:21.736570 \| controller \|   File "/usr/lib64/python3.9/runpy.py", line 97, in _run_module_code
2273 | 2022-09-27 10:47:21.736573 \| controller \|     _run_code(code, mod_globals, init_globals,
2274 | 2022-09-27 10:47:21.736579 \| controller \|   File "/usr/lib64/python3.9/runpy.py", line 87, in _run_code
2275 | 2022-09-27 10:47:21.736583 \| controller \|     exec(code, run_globals)
2276 | 2022-09-27 10:47:21.736587 \| controller \|   File "/tmp/ansible_amazon.aws.cloudwatch_metric_alarm_info_payload_v0f9h2rj/ansible_amazon.aws.cloudwatch_metric_alarm_info_payload.zip/ansible_collections/amazon/aws/plugins/modules/cloudwatch_metric_alarm_info.py", line 318, in <module>
2277 | 2022-09-27 10:47:21.736591 \| controller \|   File "/tmp/ansible_amazon.aws.cloudwatch_metric_alarm_info_payload_v0f9h2rj/ansible_amazon.aws.cloudwatch_metric_alarm_info_payload.zip/ansible_collections/amazon/aws/plugins/modules/cloudwatch_metric_alarm_info.py", line 314, in main
2278 | 2022-09-27 10:47:21.736595 \| controller \|   File "/tmp/ansible_amazon.aws.cloudwatch_metric_alarm_info_payload_v0f9h2rj/ansible_amazon.aws.cloudwatch_metric_alarm_info_payload.zip/ansible_collections/amazon/aws/plugins/modules/cloudwatch_metric_alarm_info.py", line 252, in describe_metric_alarms_info
2279 | 2022-09-27 10:47:21.736598 \| controller \| KeyError: 'MetricAlarm'
2280 | 2022-09-27 10:47:21.736602 \| controller \| fatal: [testhost]: FAILED! => {
2281 | 2022-09-27 10:47:21.736605 \| controller \|     "changed": false,
2282 | 2022-09-27 10:47:21.736609 \| controller \|     "module_stderr": "Traceback (most recent call last):\n  File \"<stdin>\", line 121, in <module>\n  File \"<stdin>\", line 113, in _ansiballz_main\n  File \"<stdin>\", line 61, in invoke_module\n  File \"/usr/lib64/python3.9/runpy.py\", line 225, in run_module\n    return _run_module_code(code, init_globals, run_name, mod_spec)\n  File \"/usr/lib64/python3.9/runpy.py\", line 97, in _run_module_code\n    _run_code(code, mod_globals, init_globals,\n  File \"/usr/lib64/python3.9/runpy.py\", line 87, in _run_code\n    exec(code, run_globals)\n  File \"/tmp/ansible_amazon.aws.cloudwatch_metric_alarm_info_payload_v0f9h2rj/ansible_amazon.aws.cloudwatch_metric_alarm_info_payload.zip/ansible_collections/amazon/aws/plugins/modules/cloudwatch_metric_alarm_info.py\", line 318, in <module>\n  File \"/tmp/ansible_amazon.aws.cloudwatch_metric_alarm_info_payload_v0f9h2rj/ansible_amazon.aws.cloudwatch_metric_alarm_info_payload.zip/ansible_collections/amazon/aws/plugins/modules/cloudwatch_metric_alarm_info.py\", line 314, in main\n  File \"/tmp/ansible_amazon.aws.cloudwatch_metric_alarm_info_payload_v0f9h2rj/ansible_amazon.aws.cloudwatch_metric_alarm_info_payload.zip/ansible_collections/amazon/aws/plugins/modules/cloudwatch_metric_alarm_info.py\", line 252, in describe_metric_alarms_info\nKeyError: 'MetricAlarm'\n",
2283 | 2022-09-27 10:47:21.736617 \| controller \|     "module_stdout": "",
2284 | 2022-09-27 10:47:21.736622 \| controller \|     "msg": "MODULE FAILURE\nSee stdout/stderr for the exact error",
2285 | 2022-09-27 10:47:21.736626 \| controller \|     "rc": 1
2286 | 2022-09-27 10:47:21.736639 \| controller \| }

softwarefactory-project-zuul · 2022-09-27T17:03:50Z

Build succeeded.

softwarefactory-project-zuul · 2022-09-27T18:03:07Z

Build succeeded.

softwarefactory-project-zuul · 2022-09-27T19:29:46Z

Build succeeded (gate pipeline).

This comment was marked as outdated.

Sign in to view

ansibullbot added WIP Work in progress module module needs_triage new_module New module new_plugin New plugin plugins plugin (any type) labels Aug 30, 2022

This comment was marked as outdated.

Sign in to view

mandar242 changed the title ~~[WIP]: new module: cloudwatch_metric_alarm_info~~ new module: cloudwatch_metric_alarm_info Aug 31, 2022

ansibullbot added community_review and removed WIP Work in progress labels Aug 31, 2022

This comment was marked as outdated.

Sign in to view

ansibullbot removed the needs_triage label Sep 1, 2022

alinabuzachis reviewed Sep 6, 2022

View reviewed changes

This comment was marked as outdated.

Sign in to view

mandar242 requested review from alinabuzachis and tremble September 7, 2022 23:52

This comment was marked as outdated.

Sign in to view

mandar242 mentioned this pull request Sep 8, 2022

[DNM] test replace aws cli calls with cloudwatch_metric_alarm_info tasks ansible-collections/community.aws#1440

Closed

ansibullbot added needs_rebase https://docs.ansible.com/ansible/devel/dev_guide/developing_rebasing.html needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR and removed community_review labels Sep 12, 2022

mandar242 force-pushed the cloudwatch_metric_alarm_info branch from 8899172 to b33f2ac Compare September 12, 2022 23:34

mandar242 added 9 commits September 26, 2022 13:52

Return empty list instead of a msg on non-existent alarm

f7fb47a

Add support for other params for describe_alarms()

cb868d3

Add DOCUMENTATION for remaining parameters

1a19cf8

Add more examples

1958067

Add RETURN block data for remaining response params

e29e87d

Minor fix: handle return value keyword based on alarm type

9f74bae

Modified based on feedback

8b23200

replace aws cli commands with info module

2c57693

Fix alarm type case

a812e02

mandar242 force-pushed the cloudwatch_metric_alarm_info branch from 9ae89ae to a812e02 Compare September 26, 2022 20:57

jillr approved these changes Sep 26, 2022

View reviewed changes

This comment was marked as outdated.

Sign in to view

alinabuzachis approved these changes Sep 27, 2022

View reviewed changes

minor bugfix in return info

977ca37

mandar242 added 2 commits September 27, 2022 10:46

Added changelogs fragment

6865196

Added changelogs fragment

a39e10a

goneri approved these changes Sep 27, 2022

View reviewed changes

mandar242 added the mergeit Merge the PR (SoftwareFactory) label Sep 27, 2022

softwarefactory-project-zuul bot merged commit d78a0e9 into ansible-collections:main Sep 27, 2022

renovate bot mentioned this pull request Oct 4, 2022

Update dependency amazon.aws to v5 - autoclosed platan/metrics-shields-io-config#109

Closed

1 task

renovate bot mentioned this pull request Oct 27, 2022

Update dependency amazon.aws to v5 - autoclosed jkroepke/homelab#27

Closed

1 task

mandar242 deleted the cloudwatch_metric_alarm_info branch March 17, 2023 22:18

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

new module: cloudwatch_metric_alarm_info #988

new module: cloudwatch_metric_alarm_info #988

mandar242 commented Aug 30, 2022 •

edited

Loading

This comment was marked as outdated.

ansibullbot commented Aug 30, 2022

This comment was marked as outdated.

This comment was marked as outdated.

jillr commented Sep 1, 2022

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

mandar242 commented Sep 9, 2022

softwarefactory-project-zuul bot commented Sep 26, 2022

alinabuzachis commented Sep 27, 2022

This comment was marked as outdated.

alinabuzachis commented Sep 27, 2022

softwarefactory-project-zuul bot commented Sep 27, 2022

alinabuzachis commented Sep 27, 2022

softwarefactory-project-zuul bot commented Sep 27, 2022

softwarefactory-project-zuul bot commented Sep 27, 2022

softwarefactory-project-zuul bot commented Sep 27, 2022

new module: cloudwatch_metric_alarm_info #988

new module: cloudwatch_metric_alarm_info #988

Conversation

mandar242 commented Aug 30, 2022 • edited Loading

SUMMARY

ISSUE TYPE

COMPONENT NAME

ADDITIONAL INFORMATION

This comment was marked as outdated.

ansibullbot commented Aug 30, 2022

This comment was marked as outdated.

This comment was marked as outdated.

jillr commented Sep 1, 2022

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

mandar242 commented Sep 9, 2022

softwarefactory-project-zuul bot commented Sep 26, 2022

alinabuzachis commented Sep 27, 2022

This comment was marked as outdated.

alinabuzachis commented Sep 27, 2022

softwarefactory-project-zuul bot commented Sep 27, 2022

alinabuzachis commented Sep 27, 2022

softwarefactory-project-zuul bot commented Sep 27, 2022

softwarefactory-project-zuul bot commented Sep 27, 2022

softwarefactory-project-zuul bot commented Sep 27, 2022

mandar242 commented Aug 30, 2022 •

edited

Loading