Struct ApiBreakerPlugin 

pub struct ApiBreakerPlugin {
    role: Role,
    id: String,
    unhealthy_statuses: Vec<u16>,
    unhealthy_failures: u32,
    healthy_statuses: Vec<u16>,
    healthy_successes: u32,
    break_base_sec: u64,
    max_breaker_sec: u64,
    break_response_code: u16,
    break_response_body: Option<String>,
    resources: Arc<PluginResources>,
}

One node of an api-breaker check/observe pair.

Holds a handle to the process-wide crate::traffic::BreakerRegistry; the shared breaker is resolved by the configured id.

Fields

role: Role

id: String

Shared breaker identity — links the check and observe nodes.

unhealthy_statuses: Vec<u16>

Statuses that count as unhealthy (open the breaker).

unhealthy_failures: u32

Consecutive unhealthy responses before the breaker opens.

healthy_statuses: Vec<u16>

Statuses that count as healthy (close the breaker).

healthy_successes: u32

Consecutive healthy responses before the breaker fully closes.

break_base_sec: u64

Base cooldown seconds; doubles each successive trip (APISIX 2^n).

max_breaker_sec: u64

Upper bound on the cooldown.

break_response_code: u16

Status returned while the breaker is open.

break_response_body: Option<String>

Optional body returned while the breaker is open.

resources: Arc<PluginResources>

Implementations

impl ApiBreakerPlugin

pub fn from_config( config: &HashMap<String, Value>, resources: &Arc<PluginResources>, ) -> Result<Self, String>

Builds one node of the pair from node config.

Accepted keys:

• phase / role (string, required): check (before upstream) or observe (after upstream).
• id (string, required): shared breaker identity; the check and observe nodes of one pair must use the same id.
• unhealthy.http_statuses (array, default [500]): statuses counted as failures. unhealthy.failures (integer, default 3): consecutive failures before the breaker opens.
• healthy.http_statuses (array, default [200]): statuses counted as successes. healthy.successes (integer, default 3): consecutive successes before the breaker fully closes.
• break_response_code (integer, default 502): status returned while the breaker is open.
• break_response_body (string, optional): body returned while open.
• break_base_sec (integer, default 2): base cooldown; the open window grows as break_base_sec * 2^trip (APISIX’s 2^n backoff).
• max_breaker_sec (integer, default 300, min 3): cooldown ceiling.

# before upstream
type: api-breaker
config:
  phase: check
  id: orders-api
  break_response_code: 502
  unhealthy: { http_statuses: [500, 503], failures: 3 }
  healthy: { http_statuses: [200], successes: 3 }
---
# after upstream
type: api-breaker
config:
  phase: observe
  id: orders-api
  unhealthy: { http_statuses: [500, 503], failures: 3 }
  healthy: { http_statuses: [200], successes: 3 }

Trait Implementations

impl Plugin for ApiBreakerPlugin

fn plugin_type(&self) -> &str

Unique identifier for the plugin type (e.g., “proxy-rewrite”, “upstream”).

fn execute<'life0, 'life1, 'async_trait>( &'life0 self, ctx: Context, _named_inputs: &'life1 HashMap<String, Value>, ) -> Pin<Box<dyn Future<Output = Result<PluginOutput, PluginExecutionError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Executes the plugin logic against the request/response context.