Skip to content

ironflow circuit-breaker

Manage circuit breakers that protect push endpoints from cascading failures. Circuit breaker state is persisted in the database and is cluster-consistent (consulted at dispatch reservation time).

Terminal window
ironflow circuit-breaker <subcommand> [flags]

Aliases: cb

List all circuit breakers with their function IDs, endpoints, states, and failure counts.

Terminal window
ironflow circuit-breaker list [flags]

Flags:

FlagShortTypeDefaultDescription
--server-sstringServer URL (default: IRONFLOW_SERVER_URL or http://localhost:9123)
--jsonboolfalseOutput as JSON

Examples:

Terminal window
# List all circuit breakers
ironflow circuit-breaker list
# JSON output
ironflow circuit-breaker list --json
# Custom server
ironflow circuit-breaker list -s http://localhost:9000

Output columns:

ColumnDescription
FUNCTION_IDThe function that owns this circuit breaker
ENDPOINTThe push endpoint URL being protected
STATECurrent state: closed, open, or half-open
FAILSNumber of consecutive failures
LAST_FAILURETimestamp of the most recent failure

Reset a circuit breaker back to closed state, allowing requests to flow to the endpoint again. Accepts either an endpoint URL or a function ID. If the argument contains :// it is treated as an endpoint URL; otherwise it is treated as a function ID.

Terminal window
ironflow circuit-breaker reset <endpoint-url | function-id> [flags]

Arguments:

ArgumentRequiredDescription
endpoint-urlYes*The endpoint URL of the breaker to reset
function-idYes*The function ID of the breaker to reset

*Provide either an endpoint URL or a function ID.

Flags:

FlagShortTypeDefaultDescription
--server-sstringServer URL (default: IRONFLOW_SERVER_URL or http://localhost:9123)

Examples:

Terminal window
# Reset a circuit breaker by endpoint URL
ironflow circuit-breaker reset https://my-app.example.com/api/handler
# Reset a circuit breaker by function ID
ironflow circuit-breaker reset my-function-id