Added support for alert plugins

Author: jonathanballs

.gitignore

@@ -15,3 +15,4 @@ celerybeat-schedule
 *.orig
 .vagrant
 conf/*.env
+dist/

.travis.yml

@@ -18,6 +18,7 @@ install:
  - sudo pip install virtualenv
  - sudo virtualenv venv
  - sudo ./venv/bin/pip install --upgrade setuptools
+ - CABOT_PLUGINS_ENABLED=cabot_alert_hipchat,cabot_alert_twilio,cabot_alert_email
  - sudo ./venv/bin/pip install --timeout=30 --exists-action=w -e . --no-use-wheel
 
 # setup databases

cabot/cabot_config.py

@@ -1,22 +1,17 @@
-
 import os
 
-CABOT_FROM_EMAIL = os.environ.get('CABOT_FROM_EMAIL')
 GRAPHITE_API = os.environ.get('GRAPHITE_API')
 GRAPHITE_USER = os.environ.get('GRAPHITE_USER')
 GRAPHITE_PASS = os.environ.get('GRAPHITE_PASS')
 GRAPHITE_FROM = os.getenv('GRAPHITE_FROM', '-10minute')
 JENKINS_API = os.environ.get('JENKINS_API')
 JENKINS_USER = os.environ.get('JENKINS_USER')
 JENKINS_PASS = os.environ.get('JENKINS_PASS')
-HIPCHAT_ALERT_ROOM = os.environ.get('HIPCHAT_ALERT_ROOM')
-HIPCHAT_API_KEY = os.environ.get('HIPCHAT_API_KEY')
-HIPCHAT_URL = os.environ.get('HIPCHAT_URL')
-TWILIO_ACCOUNT_SID = os.environ.get('TWILIO_ACCOUNT_SID')
-TWILIO_AUTH_TOKEN = os.environ.get('TWILIO_AUTH_TOKEN')
-TWILIO_OUTGOING_NUMBER = os.environ.get('TWILIO_OUTGOING_NUMBER')
 CALENDAR_ICAL_URL = os.environ.get('CALENDAR_ICAL_URL')
 WWW_HTTP_HOST = os.environ.get('WWW_HTTP_HOST')
 WWW_SCHEME = os.environ.get('WWW_SCHEME', "https")
 ALERT_INTERVAL = os.environ.get('ALERT_INTERVAL', 10)
 NOTIFICATION_INTERVAL = os.environ.get('NOTIFICATION_INTERVAL', 120)
+
+# Default plugins are used if the user has not specified.
+CABOT_PLUGINS_ENABLED = os.environ.get('CABOT_PLUGINS_ENABLED', 'cabot_alert_hipchat,cabot_alert_twilio,cabot_alert_email')

cabot/cabotapp/admin.py

@@ -1,5 +1,6 @@
 from django.contrib import admin
 from .models import UserProfile, Service, Shift, ServiceStatusSnapshot, StatusCheck, StatusCheckResult, Instance
+from .alert  import AlertPluginUserData, AlertPlugin
 
 admin.site.register(UserProfile)
 admin.site.register(Shift)
@@ -8,3 +9,5 @@
 admin.site.register(StatusCheck)
 admin.site.register(StatusCheckResult)
 admin.site.register(Instance)
+admin.site.register(AlertPlugin)
+admin.site.register(AlertPluginUserData)

cabot/cabotapp/alert.py

@@ -4,165 +4,51 @@
 from django.core.mail import send_mail
 from django.core.urlresolvers import reverse
 from django.template import Context, Template
+from django.db import models
+from django.db.models import get_models
 
 from twilio.rest import TwilioRestClient
 from twilio import twiml
+
 import requests
 import logging
+import re
+
+from polymorphic import PolymorphicModel
 
 logger = logging.getLogger(__name__)
 
-email_template = """Service {{ service.name }} {{ scheme }}://{{ host }}{% url 'service' pk=service.id %} {% if service.overall_status != service.PASSING_STATUS %}alerting with status: {{ service.overall_status }}{% else %}is back to normal{% endif %}.
-{% if service.overall_status != service.PASSING_STATUS %}
-CHECKS FAILING:{% for check in service.all_failing_checks %}
-  FAILING - {{ check.name }} - Type: {{ check.check_category }} - Importance: {{ check.get_importance_display }}{% endfor %}
-{% if service.all_passing_checks %}
-Passing checks:{% for check in service.all_passing_checks %}
-  PASSING - {{ check.name }} - Type: {{ check.check_category }} - Importance: {{ check.get_importance_display }}{% endfor %}
-{% endif %}
-{% endif %}
-"""
+class AlertPlugin(PolymorphicModel):
+    title = models.CharField(max_length=30, unique=True, editable=False)
+    enabled = models.BooleanField(default=True)
 
-hipchat_template = "Service {{ service.name }} {% if service.overall_status == service.PASSING_STATUS %}is back to normal{% else %}reporting {{ service.overall_status }} status{% endif %}: {{ scheme }}://{{ host }}{% url 'service' pk=service.id %}. {% if service.overall_status != service.PASSING_STATUS %}Checks failing:{% for check in service.all_failing_checks %}{% if check.check_category == 'Jenkins check' %}{% if check.last_result.error %} {{ check.name }} ({{ check.last_result.error|safe }}) {{jenkins_api}}job/{{ check.name }}/{{ check.last_result.job_number }}/console{% else %} {{ check.name }} {{jenkins_api}}/job/{{ check.name }}/{{check.last_result.job_number}}/console {% endif %}{% else %} {{ check.name }} {% if check.last_result.error %} ({{ check.last_result.error|safe }}){% endif %}{% endif %}{% endfor %}{% endif %}{% if alert %}{% for alias in users %} @{{ alias }}{% endfor %}{% endif %}"
+    author = None
 
-sms_template = "Service {{ service.name }} {% if service.overall_status == service.PASSING_STATUS %}is back to normal{% else %}reporting {{ service.overall_status }} status{% endif %}: {{ scheme }}://{{ host }}{% url 'service' pk=service.id %}"
+    def __unicode__(self):
+        return u'%s' % (self.title)
 
-telephone_template = "This is an urgent message from Arachnys monitoring. Service \"{{ service.name }}\" is erroring. Please check Cabot urgently."
+    def send_alert(service, users, duty_officers):
+        """
+        Implement a send_alert function here that shall be called.
+        """
+        return True
 
+class AlertPluginUserData(PolymorphicModel):
+    title = models.CharField(max_length=30, editable=False)
+    user = models.ForeignKey('UserProfile', editable=False)
+
+    class Meta:
+        unique_together = ('title', 'user',)
+        
+    def __unicode__(self):
+        return u'%s' % (self.title)
 
 def send_alert(service, duty_officers=None):
     users = service.users_to_notify.filter(is_active=True)
-    if service.email_alert:
-        send_email_alert(service, users, duty_officers)
-    if service.hipchat_alert:
-        send_hipchat_alert(service, users, duty_officers)
-    if service.sms_alert:
-        send_sms_alert(service, users, duty_officers)
-    if service.telephone_alert:
-        send_telephone_alert(service, users, duty_officers)
-
-
-def send_email_alert(service, users, duty_officers):
-    emails = [u.email for u in users if u.email]
-    if not emails:
-        return
-    c = Context({
-        'service': service,
-        'host': settings.WWW_HTTP_HOST,
-        'scheme': settings.WWW_SCHEME
-    })
-    if service.overall_status != service.PASSING_STATUS:
-        if service.overall_status == service.CRITICAL_STATUS:
-            emails += [u.email for u in duty_officers]
-        subject = '%s status for service: %s' % (
-            service.overall_status, service.name)
-    else:
-        subject = 'Service back to normal: %s' % (service.name,)
-    t = Template(email_template)
-    send_mail(
-        subject=subject,
-        message=t.render(c),
-        from_email='Cabot <%s>' % settings.CABOT_FROM_EMAIL,
-        recipient_list=emails,
-    )
-
-
-def send_hipchat_alert(service, users, duty_officers):
-    alert = True
-    hipchat_aliases = [u.profile.hipchat_alias for u in users if hasattr(
-        u, 'profile') and u.profile.hipchat_alias]
-    if service.overall_status == service.WARNING_STATUS:
-        alert = False  # Don't alert at all for WARNING
-    if service.overall_status == service.ERROR_STATUS:
-        if service.old_overall_status in (service.ERROR_STATUS, service.ERROR_STATUS):
-            alert = False  # Don't alert repeatedly for ERROR
-    if service.overall_status == service.PASSING_STATUS:
-        color = 'green'
-        if service.old_overall_status == service.WARNING_STATUS:
-            alert = False  # Don't alert for recovery from WARNING status
-    else:
-        color = 'red'
-        if service.overall_status == service.CRITICAL_STATUS:
-            hipchat_aliases += [u.profile.hipchat_alias for u in duty_officers if hasattr(
-                u, 'profile') and u.profile.hipchat_alias]
-    c = Context({
-        'service': service,
-        'users': hipchat_aliases,
-        'host': settings.WWW_HTTP_HOST,
-        'scheme': settings.WWW_SCHEME,
-        'alert': alert,
-        'jenkins_api': settings.JENKINS_API,
-    })
-    message = Template(hipchat_template).render(c)
-    _send_hipchat_alert(message, color=color, sender='Cabot/%s' % service.name)
-
-
-def _send_hipchat_alert(message, color='green', sender='Cabot'):
-    room = settings.HIPCHAT_ALERT_ROOM
-    api_key = settings.HIPCHAT_API_KEY
-    url = settings.HIPCHAT_URL
-    resp = requests.post(url + '?auth_token=' + api_key, data={
-        'room_id': room,
-        'from': sender[:15],
-        'message': message,
-        'notify': 1,
-        'color': color,
-        'message_format': 'text',
-    })
-
-
-def send_sms_alert(service, users, duty_officers):
-    client = TwilioRestClient(
-        settings.TWILIO_ACCOUNT_SID, settings.TWILIO_AUTH_TOKEN)
-    mobiles = [u.profile.prefixed_mobile_number for u in users if hasattr(
-        u, 'profile') and u.profile.mobile_number]
-    if service.is_critical:
-        mobiles += [u.profile.prefixed_mobile_number for u in duty_officers if hasattr(
-            u, 'profile') and u.profile.mobile_number]
-    c = Context({
-        'service': service,
-        'host': settings.WWW_HTTP_HOST,
-        'scheme': settings.WWW_SCHEME,
-    })
-    message = Template(sms_template).render(c)
-    mobiles = list(set(mobiles))
-    for mobile in mobiles:
-        try:
-            client.sms.messages.create(
-                to=mobile,
-                from_=settings.TWILIO_OUTGOING_NUMBER,
-                body=message,
-            )
-        except Exception, e:
-            logger.exception('Error sending twilio sms: %s' % e)
-
-
-def send_telephone_alert(service, users, duty_officers):
-    # No need to call to say things are resolved
-    if service.overall_status != service.CRITICAL_STATUS:
-        return
-    client = TwilioRestClient(
-        settings.TWILIO_ACCOUNT_SID, settings.TWILIO_AUTH_TOKEN)
-    mobiles = [u.profile.prefixed_mobile_number for u in duty_officers if hasattr(
-        u, 'profile') and u.profile.mobile_number]
-    url = 'http://%s%s' % (settings.WWW_HTTP_HOST,
-                           reverse('twiml-callback', kwargs={'service_id': service.id}))
-    for mobile in mobiles:
-        try:
-            client.calls.create(
-                to=mobile,
-                from_=settings.TWILIO_OUTGOING_NUMBER,
-                url=url,
-                method='GET',
-            )
-        except Exception, e:
-            logger.exception('Error making twilio phone call: %s' % e)
-
+    for alert in service.alerts.all():
+        alert.send_alert(service, users, duty_officers)
 
-def telephone_alert_twiml_callback(service):
-    c = Context({'service': service})
-    t = Template(telephone_template).render(c)
-    r = twiml.Response()
-    r.say(t, voice='woman')
-    r.hangup()
-    return r
+def update_alert_plugins():
+    for plugin_subclass in AlertPlugin.__subclasses__():
+        plugin = plugin_subclass.objects.get_or_create(title=plugin_subclass.name)
+    return AlertPlugin.objects.all()