alerta-contrib/integrations/consul/README.md

1.3 KiB

Consul

Trigger alerts based on consul. health checks, triggered by consul-alerts

Requirements:

consul
consul-alerts
python-consul
alerta

Installation

$ pip install python-consul
$ pip install alerta
copy script to somewhere accessible by consul-alerts, make sure its executable

Configuration

define these keys in consul KV store:

    consul-alerts/config/notifiers/custom/alerta:<path>/consul-alerta.py
    alerta/apikey:'api-key' // alerta key for api access
    alerta/apiurl:'api-url' // alerta api url
    alerta/timeout:900 // alarm timeout in alerta (default 86400)
    alerta/max_retries:3 // max api call attemps
    alerta/sleep:2 // sleep between attemps
    alerta/origin:consul // alert origin
    alerta/defaultenv:Production // default alert environment
    alerta/env/{hostname}:Testing // exceptions for env of specific nodes
    alerta/alerttype:ConsulAlerts // alert type
    consul-alerts/config/notif-profiles/default: { "Interval": 10 } // will keep active alerts "open" in alerta, before timeout removes them