Lua Circuit Breaker

https://dream11.github.io/lua-circuit-breaker/
Admin
Lua Circuit Breaker provides circuit-breaker functionality for Lua applications to wrap IO functions...
Tokens:844
Snippets:8
Trust Score:9.7
Update:5 months ago
Show doc for...
Tokens:
Raw
### Install lua-circuit-breaker via LuaRocks

Source: https://dream11.github.io/lua-circuit-breaker

Install the library using LuaRocks for easy integration into your Lua projects.

```bash
luarocks install lua-circuit-breaker

```

--------------------------------

### Install lua-circuit-breaker from Source

Source: https://dream11.github.io/lua-circuit-breaker

Clone the repository and build the library from source using LuaRocks.

```bash
luarocks make

```

--------------------------------

### Basic Circuit Breaker Usage in Lua

Source: https://dream11.github.io/lua-circuit-breaker

Demonstrates how to initialize the circuit breaker factory, get a circuit breaker instance with custom settings, check its state before an IO call, execute the call, and update the circuit breaker's state based on the result. Ensure the `makeIOCall` function is defined elsewhere.

```lua
--Import Circuit breaker factory.
local circuit_breaker_lib = require "lua-circuit-breaker.factory"

--Create a new instance of the circuit breaker factory. Always set version = 0. This is used for flushing the circuit breakers when the configuration is changed.
local circuit_breakers = circuit_breaker_lib:new()

-- Get a circuit breaker instance from factory. Returns a new instance only if not already created.
local settings = {
    version = 1,
    window_time = 10,
    min_calls_in_window= 20,
    failure_percent_threshold= 51,
    wait_duration_in_open_state= 15,
    wait_duration_in_half_open_state= 120,
    half_open_max_calls_in_window= 10,
    half_open_min_calls_in_window= 5,
    notify = function(name, state)
        print(string.format("Breaker [ %s ] state changed to [ %s ]", name, state))
    end,
}
local cb, err = circuit_breakers:get_circuit_breaker(
    "io_call_x", -- Name of circuit breaker. This should be unique.
    "io_calls", -- Used to group certain CB objects into one.
    settings,
)

-- Check state of cb. This function returns an error if the state is open or half_open_max_calls_in_window is breached.
local _, err_cb = cb:_before()
if err_cb then
    return false, "Circuit breaker open error"
end
local generation = cb._generation

-- Call IO method for which circuit breaking is required.
local res, err_http = makeIOCall()

-- Update the state of the cb based on successful / failure response.
local ok = res and res.status and res.status < 500
cb:_after(generation, ok) -- generation is used to update the counter in the correct time bucket.

```
Tokens:
Raw