Description

alertpush is a bridge between Prometheus Alertmanager and Simplepush allowing you to receive notifications from Prometheus on your smartphone.

Supported features

• Event ID
• Encrypted messages

Building

$ make

Building a Docker image

$ docker build .

Configuration

1. Get the official Simplepush app at https://simplepush.io/
2. While in the app, get your primary 6-char key or configure additional keys
3. Create a minimal config at /etc/alertpush/config.yml:

alertmanager:
  url: http://127.0.0.1:28080/alert

simplepush:
  auth:
    apikey: xXyYzZ

For encrypted messages:

alertmanager:
  url: http://127.0.0.1:28080/alert

simplepush:
  auth:
    apikey: xXyYzZ
    encrypted: true
    pass: easytobreak
    salt: Zf149o3e

4. Alternatively, alertpush can be configured using environment variables or using CLI options/flags

Notes:

• alertpush also supports config files in JSON format, and defaults to loading from /etc/alertpush/config.yml unless overridden by command-line flags (-f or --config), but if it fails to open this config file it will then attempt the fallbacks of config.yml, config.yaml, and config.json (in that order) in the current directory.

Warning: make sure to swap 127.0.0.1 with 0.0.0.0 if you're planning to run alertpush in a container, so it's accessible from other than the same localhost.

Environment variables

The following environment variables that set/override configuration parameters are recognized by alertpush:

CLI options

The following command-line options/flags can be used to set/override alertpush configuration parameters:

The full set of command-line options, their syntax, and their descriptions can be displayed by running alertpush -h.

Notes:

• You can force alertpush to use command-line config values (or, when not given, any built-in default values) by setting the config file override (-f or --config) to /dev/null.

Warning: not all functionality listed via -h is currently implemented.

Minimal Prometheus configuration

…
alerting:
  alertmanagers:
    - static_configs:
        - targets:
           - 'localhost:9093'

rule_files:
  - 'alerts.yml'
…

alerts.yml:

groups:
  - name: Instance Group
    rules:
      - alert: InstanceDown
        for: 1m
        expr: up == 0
        labels:
          severity: critical
        annotations:
          summary: "Instance {{ $labels.instance }} is down"
          description: "{{ $labels.instance }} has been down for the past 1 minute."

Minimal Alertmanager configuration

global:
  resolve_timeout: 1m

route:
  group_by: ['alertname']
  group_wait: 30s
  group_interval: 10s
  repeat_interval: 1h
  receiver: alertpush

receivers:
  - name: alertpush
    webhook_configs:
      - url: 'http://127.0.0.1:28080/alert'
        send_resolved: true

Running alertpush

Run alertpush with:

./alertpush

Running in a Docker container

1. Create a directory containing the config file config.yml:

$ mkdir alertpush && cd alertpush

2. Run docker run while mounting that directory as a volume:

$ docker run -v $(pwd):/etc/alertpush -it vaygr/alertpush:latest