mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
Make pagerduty_alert module more inline with ansible modules - use state parameter instead of event_type - add support for check mode
This commit is contained in:
Amanpreet Singh
Matt Clay
parent
47235987b2
commit
3459f966d8
1 changed files with 77 additions and 21 deletions
|
|
@ -28,30 +28,38 @@ author:
|
|||
requirements:
|
||||
- PagerDuty API access
|
||||
options:
|
||||
name:
|
||||
description:
|
||||
- PagerDuty unique subdomain.
|
||||
required: true
|
||||
service_key:
|
||||
description:
|
||||
- The GUID of one of your "Generic API" services.
|
||||
- This is the "service key" listed on a Generic API's service detail page.
|
||||
required: true
|
||||
event_type:
|
||||
state:
|
||||
description:
|
||||
- Type of event to be sent.
|
||||
required: true
|
||||
choices:
|
||||
- 'trigger'
|
||||
- 'acknowledge'
|
||||
- 'resolve'
|
||||
- 'triggered'
|
||||
- 'acknowledged'
|
||||
- 'resolved'
|
||||
api_key:
|
||||
description:
|
||||
- The pagerduty API key (readonly access), generated on the pagerduty site.
|
||||
required: true
|
||||
desc:
|
||||
description:
|
||||
- For C(trigger) I(event_type) - Required. Short description of the problem that led to this trigger. This field (or a truncated version) will be used when generating phone calls, SMS messages and alert emails. It will also appear on the incidents tables in the PagerDuty UI. The maximum length is 1024 characters.
|
||||
- For C(acknowledge) or C(resolve) I(event_type) - Text that will appear in the incident's log associated with this event.
|
||||
- For C(triggered) I(state) - Required. Short description of the problem that led to this trigger. This field (or a truncated version) will be used when generating phone calls, SMS messages and alert emails. It will also appear on the incidents tables in the PagerDuty UI. The maximum length is 1024 characters.
|
||||
- For C(acknowledged) or C(resolved) I(state) - Text that will appear in the incident's log associated with this event.
|
||||
required: false
|
||||
default: Created via Ansible
|
||||
incident_key:
|
||||
description:
|
||||
- Identifies the incident to which this I(event_type) should be applied.
|
||||
- For C(trigger) I(event_type) - If there's no open (i.e. unresolved) incident with this key, a new one will be created. If there's already an open incident with a matching key, this event will be appended to that incident's log. The event key provides an easy way to "de-dup" problem reports.
|
||||
- For C(acknowledge) or C(resolve) I(event_type) - This should be the incident_key you received back when the incident was first opened by a trigger event. Acknowledge events referencing resolved or nonexistent incidents will be discarded.
|
||||
- Identifies the incident to which this I(state) should be applied.
|
||||
- For C(triggered) I(state) - If there's no open (i.e. unresolved) incident with this key, a new one will be created. If there's already an open incident with a matching key, this event will be appended to that incident's log. The event key provides an easy way to "de-dup" problem reports.
|
||||
- For C(acknowledged) or C(resolved) I(state) - This should be the incident_key you received back when the incident was first opened by a trigger event. Acknowledge events referencing resolved or nonexistent incidents will be discarded.
|
||||
required: false
|
||||
client:
|
||||
description:
|
||||
|
|
@ -66,14 +74,17 @@ options:
|
|||
EXAMPLES = '''
|
||||
# Trigger an incident with just the basic options
|
||||
- pagerduty_alert:
|
||||
name: companyabc
|
||||
service_key=xxx
|
||||
event_type=trigger
|
||||
api_key:yourapikey
|
||||
state=triggered
|
||||
desc="problem that led to this trigger"
|
||||
|
||||
# Trigger an incident with more options
|
||||
- pagerduty_alert:
|
||||
service_key=xxx
|
||||
event_type=trigger
|
||||
api_key=yourapikey
|
||||
state=triggered
|
||||
desc="problem that led to this trigger"
|
||||
incident_key=somekey
|
||||
client="Sample Monitoring Service"
|
||||
|
|
@ -82,19 +93,47 @@ EXAMPLES = '''
|
|||
# Acknowledge an incident based on incident_key
|
||||
- pagerduty_alert:
|
||||
service_key=xxx
|
||||
event_type=acknowledge
|
||||
api_key=yourapikey
|
||||
state=acknowledged
|
||||
incident_key=somekey
|
||||
desc="some text for incident's log"
|
||||
|
||||
# Resolve an incident based on incident_key
|
||||
- pagerduty_alert:
|
||||
service_key=xxx
|
||||
event_type=resolve
|
||||
api_key=yourapikey
|
||||
state=resolved
|
||||
incident_key=somekey
|
||||
desc="some text for incident's log"
|
||||
'''
|
||||
|
||||
|
||||
def check(module, name, state, service_key, api_key, incident_key=None):
|
||||
url = "https://%s.pagerduty.com/api/v1/incidents" % name
|
||||
headers = {
|
||||
"Content-type": "application/json",
|
||||
"Authorization": "Token token=%s" % api_key
|
||||
}
|
||||
|
||||
data = {
|
||||
"service_key": service_key,
|
||||
"incident_key": incident_key,
|
||||
"sort_by": "incident_number:desc"
|
||||
}
|
||||
|
||||
response, info = fetch_url(module, url, method='get',
|
||||
headers=headers, data=json.dumps(data))
|
||||
|
||||
if info['status'] != 200:
|
||||
module.fail_json(msg="failed to check current incident status."
|
||||
"Reason: %s" % info['msg'])
|
||||
json_out = json.loads(response.read())["incidents"][0]
|
||||
|
||||
if state != json_out["status"]:
|
||||
return json_out, True
|
||||
return json_out, False
|
||||
|
||||
|
||||
def send_event(module, service_key, event_type, desc,
|
||||
incident_key=None, client=None, client_url=None):
|
||||
url = "https://events.pagerduty.com/generic/2010-04-15/create_event.json"
|
||||
|
|
@ -117,37 +156,54 @@ def send_event(module, service_key, event_type, desc,
|
|||
module.fail_json(msg="failed to %s. Reason: %s" %
|
||||
(event_type, info['msg']))
|
||||
json_out = json.loads(response.read())
|
||||
return json_out, True
|
||||
return json_out
|
||||
|
||||
|
||||
def main():
|
||||
module = AnsibleModule(
|
||||
argument_spec=dict(
|
||||
name=dict(required=True),
|
||||
service_key=dict(required=True),
|
||||
event_type=dict(required=True,
|
||||
choices=['trigger', 'acknowledge', 'resolve']),
|
||||
api_key=dict(required=True),
|
||||
state=dict(required=True,
|
||||
choices=['triggered', 'acknowledged', 'resolved']),
|
||||
client=dict(required=False, default=None),
|
||||
client_url=dict(required=False, default=None),
|
||||
desc=dict(required=False, default='Created via Ansible'),
|
||||
incident_key=dict(required=False, default=None)
|
||||
)
|
||||
),
|
||||
supports_check_mode=True
|
||||
)
|
||||
|
||||
name = module.params['name']
|
||||
service_key = module.params['service_key']
|
||||
event_type = module.params['event_type']
|
||||
api_key = module.params['api_key']
|
||||
state = module.params['state']
|
||||
client = module.params['client']
|
||||
client_url = module.params['client_url']
|
||||
desc = module.params['desc']
|
||||
incident_key = module.params['incident_key']
|
||||
|
||||
state_event_dict = {
|
||||
'triggered': 'trigger',
|
||||
'acknowledged': 'acknowledge',
|
||||
'resolved': 'resolve'
|
||||
}
|
||||
|
||||
event_type = state_event_dict[state]
|
||||
|
||||
if event_type != 'trigger' and incident_key is None:
|
||||
module.fail_json(msg="incident_key is required for "
|
||||
"acknowledge or resolve events")
|
||||
|
||||
out, changed = send_event(module, service_key, event_type, desc,
|
||||
incident_key, client, client_url)
|
||||
out, changed = check(module, name, state,
|
||||
service_key, api_key, incident_key)
|
||||
|
||||
module.exit_json(msg="success", result=out, changed=changed)
|
||||
if not module.check_mode and changed is True:
|
||||
out = send_event(module, service_key, event_type, desc,
|
||||
incident_key, client, client_url)
|
||||
|
||||
module.exit_json(result=out, changed=changed)
|
||||
|
||||
# import module snippets
|
||||
from ansible.module_utils.basic import *
|
||||
|
|
|
|||
Loading…
Reference in a new issue