resilience4clj.circuit-breaker — tessellator/resilience4clj-circuitbreaker 0.5.0

Functions to create and execute circuit breakers.

add-configuration! clj

(add-configuration! name config)

(add-configuration! registry name config)

Adds config to the registry under the name.

Uses default-registry if registry is not provided.

all-circuit-breakers clj

(all-circuit-breakers)

(all-circuit-breakers registry)

Gets all the circuit breakers in registry.

Uses default-registry if registry is not provided.

circuit-breaker clj

(circuit-breaker name)

(circuit-breaker name config)

Creates a circuit breaker with name and config.

circuit-breaker! clj

(circuit-breaker! name)

(circuit-breaker! registry name)

(circuit-breaker! registry name config)

Creates or fetches a circuit breaker with name and config and stores it in registry.

The config value can be either a config map or the name of a config map stored in the registry. If the circuit breaker already exists in the registry, the config value is ignored.

Uses default-registry if registry is not provided.

close! clj

(close! circuit-breaker)

Transitions circuit-breaker to the :closed state.

default-registry clj

The default registry for storing circuit breakers and configurations.

disable! clj

(disable! circuit-breaker)

Transitions circuit-breaker to the :disabled state.

In the :disabled state, the circuit breaker will not automatically transition to other states, collect metrics, or send events. All calls will be allowed to pass.

You must manually transition out of the :disabled state.

emit-events! clj

(emit-events! circuit-breaker
              out-chan
              &
              {:keys [only exclude] :or {exclude []}})

Offers events circuit-breaker to out-chan.

The event types are identified by event-types.

This function also accepts :only and :exclude keyword params that are sequences of the event types that should be included or excluded, respectively.

emit-registry-events! clj

(emit-registry-events! out-chan)

(emit-registry-events! registry
                       out-chan
                       &
                       {:keys [only exclude] :or {exclude []}})

Offers registry events to out-chan.

The event types are identified by registry-event-types.

This function also accepts :only and :exclude keyword params that are sequences of the event types that should be included or excluded, respectively.

Uses default-registry if registry is not provided.

event-types clj

execute clj

(execute circuit-breaker f & args)

Apply args to f within a context protected by circuit-breaker.

find clj

(find name)

(find registry name)

Finds the circuit breaker identified by name in registry.

Uses default-registry if registry is not provided.

force-open! clj

(force-open! circuit-breaker)

Transitions circuit-breaker to the :forced-open state.

In the :forced-open state, the circuit breaker will not automatically transition to other states, collect metrics, or send events. No call will be allowed to pass.

You must manually transition out of the :forced-open state.

half-open! clj

(half-open! circuit-breaker)

Transitions circuit-breaker to the :half-open state.

metrics-only! clj

(metrics-only! circuit-breaker)

Transitions circuit-breaker to the :metrics-only state.

In the :metrics-only state, the circuit breaker will not transition to other states, but it will continue to capture metrics and publish events.

You must manually transition out of the `:metrics-only`` state.

name clj

(name circuit-breaker)

Gets the name of circuit-breaker.

open! clj

(open! circuit-breaker)

Transitions circuit-breaker to the :open state.

permitting-calls? clj

(permitting-calls? circuit-breaker)

Indicates whether circuit-breaker is allowing calls to be executed.

registry clj

(registry)

(registry configs-map)

Creates a registry with default values or using a map of name/config-map pairs.

registry-event-types clj

The event types that can be raised by a registry.

remove! clj

(remove! name)

(remove! registry name)

Removes the circuit breaker idenfitied by name from registry.

Uses default-registry if registry is not provided.

replace! clj

(replace! name circuit-breaker)

(replace! registry name circuit-breaker)

Replaces the circuit breaker identified by name in registry with the specified circuit-breaker.

Uses default-registry if registry is not provided.

reset! clj

(reset! circuit-breaker)

Resets circuit-breaker to its original state.

Resets all metrics collected and effectively empties the contents of its ring buffers.

state clj

(state circuit-breaker)

Gets the current state of circuit-breaker.

with-circuit-breaker clj macro

(with-circuit-breaker circuit-breaker & body)

Executes body within a context protected by circuit-breaker.

circuit-breaker is either a circuit breaker or the name of one in the default registry. If you provide a name and a circuit breaker of that name does not already exist in the default registry, one will be created with the :default config.