Alerters

You can setup lovebeat to send mails or issue outgoing webhooks (HTTP POST) to your web service whenever an alarm changes state. This is done on an alarm by modifying the configuration file.

Send Mail

The first step is to specify the SMTP server address and the e-mail address that will be used when sending the e-mails. It doesn’t currently support SMTP authentication, so you might want to run a local SMTP server to proxy the sent e-mails.

If you have an account at Mailgun, you can specify your domain and API key to let Lovebeat send mails using Mailgun’s API. By doing this, the SMTP settings will not be used.

The configuration file should look as following for SMTP:

[mail]
server = "localhost:25"
from = "lovebeat@example.com"

If you’re using Mailgun for sending your mails, your configuration will look as follows:

[mailgun]
domain = "example.com"
from = "lovebeat@example.com"
api_key = "key-5ap419x2asxge9a6xaqq0ztagv-a4axj"

Example of specifying an alarm that sends mails:

[[alarms]]
name = "example"
pattern = "test.*"
alerts = ["mail-alert"]

[alerts.mail-alert]
mail = "administrator@example.com"

Outgoing Webhooks

When an alarm changes state, a POST will be sent to the URL(s) specified in the configuration. The JSON data that is sent follows:

POST /your/url/endpoint HTTP/1.1
Content-Type: application/json
Accept: application/json
User-Agent: Lovebeat
X-Lovebeat: 1

{
  "name": "alarm.name.here",
  "from_state": "ok",
  "to_state": "error",
  "incident_number": 4
}

Example of the configuration file:

[[alarms]]
name = "example"
pattern = "test.*"
alerts = ["to-requestbin"]

[alerts.to-requestbin]
webhook = "http://requestb.in/19lw85o1"

Slack

Lovebeat can post messages to a slack channel whenever an alarm changes state. First of all, setup an incoming webhook to get a Webhook URL that you will enter in the lovebeat configuration file.

A working example would look like:

[[alarms]]
name = "example"
pattern = "test.*"
alerts = ["message-to-ops"]

[alerts.message-to-ops]
slack_channel = "#ops"

[slack]
webhook_url = "https://hooks.slack.com/services/T12345678/B12345678/abrakadabra"

Script

Lovebeat can run arbitrary scripts (or other executable files) whenever an alarm changes state. The details of the alert will be posted as environment variables:

• LOVEBEAT_ALARM=<name of the alarm>
• LOVEBEAT_STATE=<the current state>
• LOVEBEAT_PREVIOUS_STATE=<the previous state>
• LOVEBEAT_INCIDENT=<incident number>

The script will also inherit any environment variables that Lovebeat was started with.

The script’s stdout and stderr will be printed, and the script will be invoked with no arguments. If a script doesn’t finish within 10 seconds, it will be terminated. Remember to make your script executable using chmod a+x script.sh.

Example of the configuration file:

[[alarms]]
name = "example"
pattern = "test.*"
alerts = ["test-alert"]

[alerts.test-alert]
script = "/path/to/script.sh"

The script (/path/to/script.sh) could look like:

#!/bin/bash

echo "Hello World"
env

The output would then be (among other environment variables):

2016/01/26 18:10:56 INFO ALARM 'example', 11: state ok -> error
2016/01/26 18:10:56 INFO Running alert script /path/to/script.sh
Hello World
LOVEBEAT_ALARM=example
LOVEBEAT_STATE=ERROR
LOVEBEAT_PREVIOUS_STATE=OK
LOVEBEAT_INCIDENT=11