Skip to content

Run lueur as a Chaos Toolkit Action

This guide will walk you through running lueur as a Chaos Toolkit action in your Chaos Engineering experiments.

Prerequisites

Run with the Chaos Toolkit Lueur Extension

  • Install the chaostoolkit-lueur extension

    Note

    Chaos Toolkit extensions are Python libraries that must be found by the chaos process when it runs. Usually, this requires you install these extensions as part of your Python environment. There are many ways to get a Python environment, so we'll assume you are running one.

    Install the chaostoolkit-lueur extension:

    pip install chaostoolkit-lueur

    uv tool install chaostoolkit-lueur

  • Add an action to run the proxy

    You can now add the following to one of your experiment:

    {
    "type": "action",
    "name": "run lueur proxy with a normal distribution latency",
    "provider": {
        "type": "python",
        "module": "chaoslueur.actions",
        "func": "run_proxy",
        "arguments": {
            "proxy_args": "--with-latency --latency-mean 300 --latency-stddev 50 --upstream '*'"
        }
    },
    "background": true
}

    ---
type: action
name: run lueur proxy with a normal distribution latency
provider:
    type: python
    module: chaoslueur.actions
    func: run_proxy
    arguments:
        proxy_args: "--with-latency --latency-mean 300 --latency-stddev 50 --upstream '*'"
background: true

    You mostly likely want to run the proxy as a background task of the experiment.

    The proxy_args argument takes the full list of supported values from the cli run command

  • Add an action to stop the proxy

    You can now add the following action once your experiment is done with the proxy.

    {
    "type": "action",
    "name": "stop latency proxy injector",
    "provider": {
        "type": "python",
        "module": "chaoslueur.actions",
        "func": "stop_proxy"
    }
}

    ---
type: action
name: stop latency proxy injector
provider:
    type: python
    module: chaoslueur.actions
    func: stop_proxy

    Tip

    You can do without this action if you set the duration argument when you start the proxy. In which case, the proxy will terminate on its own after the duration is up.

Next Steps

  • Explore how you can use the Reliably Platform to orchestrate and schedule your experiment on a variety of targets.