The vigilance package

[Tags: mit]

Vigilance is a dead man's switch (See <https://en.wikipedia.org/wiki/Dead_man%27s_switch>) (or vigilance switch). You define named @watches that you expect to happen and how long to wait inbetween before it's time to worry. You then instrument your periodical tasks, whatever they are, to report to vigilance via a simple HTTP POST or with the included client. You can then configure notifications that will fire when a watch fails to check in. View the README on the homepage for more details. Install notes: On client installs where you may not want to install the server component, configure like:

> cabal configure -fno-server

On client installs where you may not want to install the client component, configure like:

> cabal configure -fno-client


[Skip to ReadMe]

Properties

Versions0.1.0.0, 0.1.0.1
Change logNone available
Dependenciesacid-state, aeson (>=0.6 && <1.0), async (==2.*), attoparsec, base (>=4.5 && <4.7), blaze-builder, bytestring, classy-prelude (>=0.5.8 && <1.0), configurator (>=0.2 && <1.0), containers, data-store (>=0.3.0.7 && <1.0), directory, either (==3.4.1), entropy (>=0.2.2.2), errors (>=1.4.2 && <2.0), fast-logger (>=0.3.2 && <1.0), http-streams (>=0.6.1.1 && <=1.0), http-types, interpolatedstring-perl6 (>=0.9.0 && <1.0), io-streams, lens (>=3.9 && <4.0), mime-mail (>=0.4.2 && <1.0), monad-logger, monad-loops (>=0.4.2 && <1.0), mtl, optparse-applicative (>=0.5.2.1 && <1.0), safecopy, stm (>=2.4.2 && <3.0), template-haskell, text, time, transformers, unix (>=2.6.0.1 && <3.0), unordered-containers, vector, wai, wai-extra, warp, yesod, yesod-core, yesod-platform (>=1.2.3 && <2.0) [details]
LicenseMIT
Copyright(c) 2013 Michael Xavier
AuthorMichael Xavier
Maintainermichael@michaelxavier.net
CategoryUtils
Home pagehttp://github.com/michaelxavier/vigilance
Bug trackerhttp://github.com/michaelxavier/vigilance/issues
Executablesvigilance, vigilance-server
UploadedTue Sep 17 06:08:49 UTC 2013 by MichaelXavier
Downloads349 total (14 in last 30 days)
Votes
0 []
StatusDocs uploaded by user
Build status unknown [no reports yet]

Flags

NameDescriptionDefaultType
no-serverOmit the server component. Installs on client machines can and should pass this.DisabledAutomatic
no-clientOmit the client component. Install on the server may pass this if desired.DisabledAutomatic

Use -f <flag> to enable a flag, or -f -<flag> to disable that flag. More info

Downloads

Maintainers' corner

For package maintainers and hackage trustees

Readme for vigilance-0.1.0.1

Vigilance

Build Status

Vigilance is a dead man's switch (or vigilance switch). You define named watches that you expect to happen and how long to wait inbetween before it's time to worry. You then instrument your periodical tasks, whatever they are, to report to vigilance via a simple HTTP POST or with the included client. You can then configure notifications that will fire when a watch fails to check in.

Concepts

A watch is a named task that you expect to happen periodically. Watches have an interval at which they are expected to check in at the latest, i.e. every 5 minutes. Watches can be in several states:

Watches are configured in the server's config file and managed via the rest API or the vigilance client. The configuration file can be reloaded to account for changes/additions/removals of watches.

Watches can be configured with multiple notifications to fire when the watch fails to check in. Right now the supported notification options are:

vigilance-server

vigilance-server is the server component of vigilance. It is responsible for tracking what watches there are, their state, notifications, etc.

Usage

Simply run vigilance-server path/to/config.cfg. If you don't specify a config, it will look in ~/.vigilance/server.conf

Configuration

The configuration file is in configurator format. Here's an example config

Example Config

vigilance {
  port = 9999
  from_email = "vigilance@example.com"
  max_retries = 5
  log {
    verbose = on
    path = "log/vigilance.log"
  }
  watches {
    foo {
      interval = [2, "seconds"]
      notifications = [
        ["http", "http://localhost:4567/notify"],
        ["email", "ohno@example.com"]
      ]
    }

    bar {
      interval = [3, "minutes"]
    }
  }
}

Note that all of these options have reasonable defaults, so you don't need to specify them unless you need something other than the default.

Note that like the standard capabilities configurator has to expand env variables and load external config files apply:

vigilance {
  acid_path  = "$(HOME)/alternative-vigilance-path"

  watches {
    import "only_watches.conf"
  }
}

Limited Config Reload Support

Sending a HUP signal to the process (kill -HUP pid_of_vigilance) will reload the config. Reloading while running can currently update the following settings:

  1. Log verbosity.
  2. List of watches
  3. Log location

Config Fields

| Field | Default | Description | Reloadable | | ------------------------------ | --------------------------- | --------------------------------------------------------- | ---------- | | port | 3000 | Server port | No | | from_email | None | Email to send from. If missing, no email notifications | No | | max_retries | 3 | Max retries for notifications | No | | log.acid_path | ~/.vigilance/state/AppState | | No | | log.verbose | no | Verbose logging | Yes | | log.path | ~/.vigilance/vigilance.log | | Yes | | watches.name.interval | None. Required for a watch | Pair of number and seconds/minutes/hours/days/weeks/years | Yes | | watches.name.notifications | Empty | List of pairs ["http", "url"] or ["email", "a@example.com"] | Yes |

REST API

Vigilance exposes a REST API for managing watches.

| Path | Method | Description | | ----------------------- | ------ | -------------------------------------------------------------------------------------------- | | /watches | GET | Get the list of watches in JSON. | | /watches/name | GET | Get info for a watch by name | | /watches/name | DELETE | Delete a watch. Make sure to remove it from the config or it will return on config (re)load. | | /watches/name/pause | POST | Take a watch out of operation. | | /watches/name/unpause | POST | Put a watch back in operation. | | /watches/name/checkin | POST | Check in a watch. Unpauses if it is paused. | | /watches/name/test | POST | Synchronously fire a watch's notifications. Returns a list of failures in JSON. |

Vigilance Client

Vigilance Client is available under the vigilance binary. It allows you to interact with a vigilance server over HTTP in a concise way. The idea behind this is that it should make it very easy to insert check-ins in crontabs and shell scripts. You can imagine a crontab entry like: @daily run_backups.sh && vigilance checkin backups.

Configuration

Vigilance by default looks for a .vigilance file in your home directory, which looks like:

vigilance
{
  host = "localhost"
  port = 3000
}

Usage

Run vigilance --help for help:

vigilance - tool for managing vigilance watches locally or remotely.

Usage: vigilance COMMAND [-c|--config FILE]

Available options:
  -h,--help                Show this help text
  -c,--config FILE         Config file. Defaults to ~/.vigilance

Available commands:
  list                     List watches
  pause                    Pause watch
  unpause                  Unpause watch
  checkin                  Check in watch
  info                     Get info about a watch
  test                     Test the notifications for a watch

All commands except list take a name argument for the watch like: vigilance pause foo.

Status

Gearing up for release. Nothing in the TODO necessitates holding up the release.

License

Vigilance is released under the MIT license. See the LICENSE file for more info.