From 6c10297b2d89cbf228c08d01c717664ac37373f3 Mon Sep 17 00:00:00 2001 From: Ben Whaley Date: Sat, 12 Apr 2014 00:56:32 +0000 Subject: [PATCH] Stackdriver code deploy and annotation module --- library/notification/stackdriver | 196 +++++++++++++++++++++++++++++++ 1 file changed, 196 insertions(+) create mode 100644 library/notification/stackdriver diff --git a/library/notification/stackdriver b/library/notification/stackdriver new file mode 100644 index 0000000000..331b8c5eb5 --- /dev/null +++ b/library/notification/stackdriver @@ -0,0 +1,196 @@ +#!/usr/bin/python +# -*- coding: utf-8 -*- + +DOCUMENTATION = ''' + +module: stackdriver +short_description: Send code deploy and annotation events to stackdriver +description: + - Send code deploy and annotation events to Stackdriver +version_added: "1.6" +author: Ben Whaley +options: + key: + description: + - API key. + required: true + default: null + event: + description: + - The type of event to send, either annotation or deploy + choices: ['annotation', 'deploy'] + required: false + default: null + revision_id: + description: + - The revision of the code that was deployed. Required for deploy events + required: false + default: null + deployed_by: + description: + - The person or robot responsible for deploying the code + required: false + default: "Ansible" + deployed_to: + description: + - The environment code was deployed to. (ie: development, staging, production) + required: false + default: null + repository: + description: + - The repository (or project) deployed + required: false + default: null + msg: + description: + - The contents of the annotation message, in plain text.  Limited to 256 characters. Required for annotation. + required: false + default: null + annotated_by: + description: + - The person or robot who the annotation should be attributed to. + required: false + default: "Ansible" + level: + description: + - one of INFO/WARN/ERROR, defaults to INFO if not supplied.  May affect display. + choices: ['INFO', 'WARN', 'ERROR'] + required: false + default: 'INFO' + instance_id: + description: + - id of an EC2 instance that this event should be attached to, which will limit the contexts where this event is shown + required: false + default: null + event_epoch: + description: + - "Unix timestamp of where the event should appear in the timeline, defaults to now. Be careful with this." + required: false + default: null +''' + +EXAMPLES = ''' +- stackdriver: key=AAAAAA event=deploy deployed_to=production deployed_by=leroyjenkins repository=MyWebApp revision_id=abcd123 + +- stackdriver: key=AAAAAA event=annotation msg="Greetings from Ansible" annotated_by=leroyjenkins level=WARN instance_id=i-abcd1234 +''' + +# =========================================== +# Stackdriver module specific support methods. +# +try: + import urllib, urllib2, json +except ImportError: + module.fail_json(msg="json, urllib, and urllib2 are required") + + +def send_deploy_event(module, key, revision_id, deployed_by='Ansible', deployed_to=None, repository=None): + """Send a deploy event to Stackdriver""" + deploy_api = "https://event-gateway.stackdriver.com/v1/deployevent" + + params = {} + params['revision_id'] = revision_id + params['deployed_by'] = deployed_by + if deployed_to: + params['deployed_to'] = deployed_to + if repository: + params['repository'] = repository + + data = json.dumps(params) + + req = urllib2.Request(deploy_api, data) + req.add_header('content-type', 'application/json') + req.add_header('x-stackdriver-apikey', key) + return urllib2.urlopen(req) + +def send_annotation_event(module, key, msg, annotated_by='Ansible', level=None, instance_id=None, event_epoch=None): + """Send an annotation event to Stackdriver""" + annotation_api = "https://event-gateway.stackdriver.com/v1/annotationevent" + + params = {} + params['message'] = msg + if annotated_by: + params['annotated_by'] = annotated_by + if level: + params['level'] = level + if instance_id: + params['instance_id'] = instance_id + if event_epoch: + params['event_epoch'] = event_epoch + + data = json.dumps(params) + + req = urllib2.Request(annotation_api, data) + req.add_header('content-type', 'application/json') + req.add_header('x-stackdriver-apikey', key) + return urllib2.urlopen(req) + +# =========================================== +# Module execution. +# + +def main(): + + module = AnsibleModule( + argument_spec=dict( + key=dict(required=True), + event=dict(required=True, choices=['deploy', 'annotation']), + msg=dict(), + revision_id=dict(), + annotated_by=dict(default='Ansible'), + level=dict(default='INFO', choices=['INFO', 'WARN', 'ERROR']), + instance_id=dict(), + event_epoch=dict(), + deployed_by=dict(default='Ansible'), + deployed_to=dict(), + repository=dict(), + ), + supports_check_mode=True + ) + + key = module.params["key"] + event = module.params["event"] + + # Annotation params + msg = module.params["msg"] + annotated_by = module.params["annotated_by"] + level = module.params["level"] + instance_id = module.params["instance_id"] + event_epoch = module.params["event_epoch"] + + # Deploy params + revision_id = module.params["revision_id"] + deployed_by = module.params["deployed_by"] + deployed_to = module.params["deployed_to"] + repository = module.params["repository"] + + ################################################################## + # deploy requires revision_id + # annotation requires msg + # We verify these manually + ################################################################## + + if event == 'deploy': + if not revision_id: + module.fail_json(msg="revision_id required for deploy events") + try: + send_deploy_event(module, key, revision_id, deployed_by, deployed_to, repository) + except Exception, e: + module.fail_json(msg="unable to sent deploy event: %s" % e) + + if event == 'annotation': + if not msg: + module.fail_json(msg="msg required for annotation events") + try: + send_annotation_event(module, key, msg, annotated_by, level, instance_id, event_epoch) + except Exception, e: + module.fail_json(msg="unable to sent annotation event: %s" % e) + + changed = True + module.exit_json(changed=changed, deployed_by=deployed_by) + +# import module snippets +from ansible.module_utils.basic import * +from ansible.module_utils.urls import * + +main()