Contact Us 1-800-596-4880
  1. Homepage
  2. Omni Gateway (1.14)
  3. Configuring Omni Gateway
  4. Configuring Managed Omni Gateway

  5. Configure Circuit Breaker

Configure Circuit Breaker for Managed Omni Gateway

Circuit breaker protection stops Omni Gateway from overwhelming an upstream service. When the number of connections, requests, or retries to an upstream exceeds a configured threshold, the circuit breaker rejects requests with a 503 - Service Unavailable error until traffic returns to within the threshold.

Omni Gateway offers these circuit breaker thresholds:

  • Maximum Connections
    The maximum number of connections per API to an upstream service.

  • Maximum Pending Requests
    The maximum number of queued requests that can wait for a connection.

  • Maximum Requests
    The maximum number of outstanding requests to an upstream service.

  • Maximum Retries
    The maximum number of outstanding retries.

  • Maximum Connection Pools
    The maximum number of connection pools concurrently initiated to an upstream service.

When requests or connections exceed a threshold, Omni Gateway returns a 503 - Service Unavailable error.

All thresholds are optional. For Managed Omni Gateways and Connected Mode, each API instance has its own independent limit per upstream, so each can use the full threshold value. In Local Mode, different API instances share limits for the same upstream. For all modes, each gateway replica can use the full threshold value and limits aren’t distributed across replicas.

Configure circuit breaker thresholds for Managed Omni Gateway via:

  • Runtime Manager runtime configurations: Applies to all API instances in the gateway after the gateway is deployed.

  • Policy: Applies to one API instance or upstream and provides granular control.

Configuration Precedence

When you configure a setting in more than one place, Omni Gateway uses the first value that is set, in this order of precedence:

  1. Policy: A policy applied to the API instance.

  2. Runtime Manager runtime configuration: Used if no policy value is set.

  3. Built-in default: Used if neither of the other values is set. A policy value overrides the gateway-level value for the API instance it’s applied to. API instances without the policy use the gateway-level value.

Configure Circuit Breaker in Runtime Manager

  1. In Anypoint Platform, select Runtime Manager.

  2. Select Omni Gateways.

  3. Select your Omni Gateway.

  4. Open Runtime Configurations.

  5. Open Circuit Breaker.

  6. Set values for Maximum Connections, Maximum Pending Requests, Maximum Requests, Maximum Retries, and Maximum Connection Pools.

  7. Apply the changes.

Configure Circuit Breaker via Policies

Apply the Circuit Breaker policy to your API instance or upstream service: