Skip to content

Latest commit

 

History

History
32 lines (22 loc) · 1.31 KB

README.md

File metadata and controls

32 lines (22 loc) · 1.31 KB

Vigil

Crates.io - Vigil Build Status License: MIT License: Apache-2.0

Software watchdog library for Rust services.

Documentation

https://docs.rs/vigil/

Usage

Install from crates.io by adding vigil to your Cargo.toml:

[dependencies]
vigil = "0.1"

Now you can create a Vigil instance which the watched code must notify every so often. If the watched code misses too many notification ticks, the pre-programmed callbacks will be fired to allow you to handle the situation (gather diagnostics, raise an alarm, cancel the stalled task, or even kill the whole process).

let vigil = Vigil::create(10_000,
                          Some(|| warn!("Watched code missed a watchdog check"),
                          Some(|| error!("Watched code missed multiple watchdog checks!"),
                          Some(|| { error!("Deadlock detected, exiting"); std::process::exit(101));

loop {
  do_work();
  vigil.notify();
}