grafana-sms-alert

Unnamed repository; edit this file 'description' to name the repository.
Log | Files | Refs | README

README.md (932B)

      1 # Grafana SMS alert
      2 
      3 Send Grafana alerts via SMS to a mobile phone, using a GSM modem that
      4 understands AT commands, such as the Huawei E3131 broadband USB dongle.
      5 Fancy SaaS alerting services are great, but what if you want to know
      6 that the internet is down?
      7 
      8 This runs as a service on `localhost:8201` - once you've started it,
      9 create a "Webhook" type contact point in your Grafana instance,
     10 with the url `http://localhost:8201`.
     11 
     12 See Grafana [alerting contact points](https://grafana.com/docs/grafana/latest/alerting/contact-points/) documentation for background.
     13 
     14 
     15 ## Building and use (Nix)
     16 
     17 ### Try it quickly
     18 
     19     $ nix-build build.nix
     20 	$ cp config.json.example config.json # and edit it
     21 	$ ./result/bin/grafana-sms-alert config.json
     22 
     23     $ curl -v --data @sample-alert.json http://localhost:8201
     24 
     25 ### Install it meaningfully
     26 
     27 The derivation in `default.nix` works with `callPackage`, so see
     28 `module-example.nix` for a sketch.