Blyx

Plover

Workflow framework · 0.1.0

Gate alerts on error-budget burn in both a short and a long window.

Gate an alert on short and long error windows

The short window burns four times its error budget and the long window burns twice. Both reach the selected threshold.

Run the native CLI

Extract the workflow collection for your platform. Run .\bin\plover.exe --help in PowerShell or ./bin/plover --help on Linux and macOS. Running the command with no arguments prints the worked example.

Build from source

With Blyx 0.2.1, Rust and a host linker installed, run these commands to edit and rebuild the example.

git clone --depth 1 --branch v0.1.0 https://github.com/Rahulchaube1/blyx-plover.git
cd blyx-plover
blyxc native-run project.blyx -- 2 10 10 100 0.05 2

Why this framework exists

A brief burst or stale long-window average can trigger a noisy alert on its own. Require both windows to cross the selected burn threshold. Google SRE Workbook, alerting on SLOs

Install Plover in your editor

Extension RahulChaube.blyx-plover · 0.1.0

The extension includes a runnable Blyx example, function completions and the framework source. For the modular project, extract the starter, open its folder and run blyxc native-run main.blyx with the native toolchain installed.

Create an empty .blyx file, type blyx-plover-demo and accept the completion. Choose Blyx: Run File to run the example.

For an offline installation, choose Extensions: Install from VSIX for Blyx Language first, then for Plover.

Download the companion Blyx Language VSIX

Libraries in this framework

Install with Conda

Create an environment containing Plover 0.1.0, its Blyx source and a runnable example. Run the second command with Blyx 0.2.1, Rust and a host linker installed.

conda create -y --prefix ./blyx-env --override-channels -c https://rahulchaube1.github.io/blyx-packages blyx-plover=0.1.0=0
blyxc native-run ./blyx-env/share/blyx/plover/main.blyx

To use this package in your application, copy share/blyx/plover/vendor/plover from the environment into your project's vendor directory.

Install the full collection with Homebrew or Scoop

Import into a Blyx project

Install Blyx 0.2.1, Rust 1.85 or newer and a host linker. From the directory containing your entry file, clone this tagged release.

git clone --depth 1 --branch v0.1.0 https://github.com/Rahulchaube1/blyx-plover.git vendor/plover

You can also download Plover as a ZIP. Extract its contents into vendor/plover.

Save this as main.blyx beside vendor and run blyxc native-run main.blyx.

use vendor::plover::plover;

fn main() {
    let fast_bad = 2.0;
    let fast_total = 10.0;
    let slow_bad = 10.0;
    let slow_total = 100.0;
    let allowed = 0.05;
    let trigger = 2.0;
    let result = plover_alert(fast_bad, fast_total, slow_bad, slow_total, allowed, trigger);
    if len(result) == 0 { println!("invalid"); return; }
    let mut i = 0;
    while i < len(result) {
        println!(at(result, i));
        i += 1;
    }
}

Expected output

1
4
2
5

API and input requirements

Returns [alert, short burn, long burn, long-window excess failures]. The short window must be a subset of the long window, including its good events. Invalid arguments and nonfinite results return an empty vector.

APIUse
plover_alert(fast_bad, fast_total, slow_bad, slow_total, allowed, trigger)Returns [alert, short burn, long burn, long-window excess failures]. The short window must be a subset of the long window, including its good events.

Develop and contribute

Open the tagged source to read the implementation and examples. Include the smallest reproducible Blyx program, compiler version and expected result when reporting an issue.