Skip to content
Kong Logo | Kong Docs Logo
search
  • We're Hiring!
  • Docs
    • Kong Gateway
    • Kong Konnect
    • Kong Mesh
    • Plugin Hub
    • decK
    • Kubernetes Ingress Controller
    • Insomnia
    • Kuma

    • Docs contribution guidelines
  • Plugin Hub
  • Support
  • Community
  • Kong Academy
Get a Demo Start Free Trial
  • Kong Gateway
  • Kong Konnect
  • Kong Mesh
  • Plugin Hub
  • decK
  • Kubernetes Ingress Controller
  • Insomnia
  • Kuma

  • Docs contribution guidelines
  • 2.1.x (latest)
  • 2.0.x
  • 1.9.x
  • 1.8.x
  • 1.7.x
  • 1.6.x
  • 1.5.x
  • 1.4.x
  • 1.3.x
  • 1.2.x
  • 1.1.x
  • 1.0.x
    • Introduction to Kong Mesh
    • What is Service Mesh?
    • How Kong Mesh works
    • Deployments
    • Version support policy
    • Stability
    • Release notes
    • Installation Options
    • Kubernetes
    • Helm
    • OpenShift
    • Docker
    • Amazon ECS
    • Amazon Linux
    • Red Hat
    • CentOS
    • Debian
    • Ubuntu
    • macOS
    • Windows
    • Explore Kong Mesh with the Kubernetes demo app
    • Explore Kong Mesh with the Universal demo app
    • Standalone deployment
    • Deploy a standalone control plane
    • Multi-zone deployment
    • Deploy a multi-zone global control plane
    • License
    • Overview
    • Data plane proxy
    • Data plane on Kubernetes
    • Data plane on Universal
    • Gateway
    • Zone Ingress
    • Zone Egress
    • CLI
    • GUI
    • Observability
    • Inspect API
    • Kubernetes Gateway API
    • Networking
    • Service Discovery
    • DNS
    • Kong Mesh CNI
    • Transparent Proxying
    • IPv6 support
    • Non-mesh traffic
    • Secure access across Kong Mesh components
    • Secrets
    • Kong Mesh API Access Control
    • API server authentication
    • Data plane proxy authentication
    • Zone proxy authentication
    • Data plane proxy membership
    • Dataplane Health
    • Fine-tuning
    • Control Plane Configuration
    • Upgrades
    • Requirements
    • Introduction
    • General notes about Kong Mesh policies
    • Applying Policies
    • How Kong Mesh chooses the right policy to apply
    • Understanding TargetRef policies
    • Protocol support in Kong Mesh
    • Mesh
    • Mutual TLS
    • Traffic Permissions
    • Traffic Route
    • Traffic Metrics
    • Traffic Trace
    • Traffic Log
    • Locality-aware Load Balancing
    • Fault Injection
    • Health Check
    • Circuit Breaker
    • Proxy Template
    • External Service
    • Retry
    • Timeout
    • Rate Limit
    • Virtual Outbound
    • MeshGateway
    • MeshGatewayRoute
    • Service Health Probes
    • MeshAccessLog (Beta)
    • MeshCircuitBreaker (Beta)
    • MeshFaultInjection (Beta)
    • MeshHealthCheck (Beta)
    • MeshHTTPRoute (Beta)
    • MeshProxyPatch (Beta)
    • MeshRateLimit (Beta)
    • MeshRetry (Beta)
    • MeshTimeout (Beta)
    • MeshTrace (Beta)
    • MeshTrafficPermission (Beta)
    • Overview
    • HashiCorp Vault CA
    • Amazon ACM Private CA
    • cert-manager Private CA
    • OPA policy support
    • MeshOPA (beta)
    • Multi-zone authentication
    • FIPS support
    • Certificate Authority rotation
    • Role-Based Access Control
    • UBI Images
    • Windows Support
    • Auditing
    • HTTP API
    • Annotations and labels in Kubernetes mode
    • Kong Mesh data collection
      • Mesh
      • CircuitBreaker
      • ExternalService
      • FaultInjection
      • HealthCheck
      • MeshGateway
      • MeshGatewayRoute
      • ProxyTemplate
      • RateLimit
      • Retry
      • Timeout
      • TrafficLog
      • TrafficPermission
      • TrafficRoute
      • TrafficTrace
      • VirtualOutbound
      • Dataplane
      • ZoneEgress
      • ZoneIngress
      • kuma-cp
      • kuma-dp
      • kumactl
    • Kuma-cp configuration reference
    • Open source License
    • Contribute to Mesh

github-edit-pageEdit this page

report-issueReport an issue

enterprise-switcher-iconSwitch to OSS

Kong Mesh
2.1.x (latest)
  • Home
  • Kong Mesh
  • Generated
  • Resources
  • CircuitBreaker

CircuitBreaker

  • sources (required, repeated)

    List of selectors to match dataplanes that are sources of traffic.

    • match (optional)

      Tags to match, can be used for both source and destinations

  • destinations (required, repeated)

    List of selectors to match services that are destinations of traffic.

    • match (optional)

      Tags to match, can be used for both source and destinations

  • conf (required)

    • interval (optional)

      Time interval between ejection analysis sweeps

    • baseEjectionTime (optional)

      The base time that a host is ejected for. The real time is equal to the base time multiplied by the number of times the host has been ejected

    • maxEjectionPercent (optional)

      The maximum percent of an upstream cluster that can be ejected due to outlier detection, has to be in [0 - 100] range

    • splitExternalAndLocalErrors (optional)

      Enables Split Mode in which local and external errors are distinguished

    • detectors (optional)

      • totalErrors (optional)

        Errors with status code 5xx and locally originated errors, in Split Mode - just errors with status code 5xx

        • consecutive (optional)
      • gatewayErrors (optional)

        Subset of ‘total’ related to gateway errors (502, 503 or 504 status code)

        • consecutive (optional)
      • localErrors (optional)

        Takes into account only in Split Mode, number of locally originated errors

        • consecutive (optional)
      • standardDeviation (optional)

        • requestVolume (optional)

          Ignore hosts with less number of requests than ‘requestVolume’

        • minimumHosts (optional)

          Won’t count success rate for cluster if number of hosts with required ‘requestVolume’ is less than ‘minimumHosts’

        • factor (optional)

          Resulting threshold = mean - (stdev * factor)

      • failure (optional)

        • requestVolume (optional)

          Ignore hosts with less number of requests than ‘requestVolume’

        • minimumHosts (optional)

          Won’t count success rate for cluster if number of hosts with required ‘requestVolume’ is less than ‘minimumHosts’

        • threshold (optional)

          Eject host if failure percentage of a given host is greater than or equal to this value, has to be in [0 - 100] range

    • thresholds (optional)

      • maxConnections (optional)

        The maximum number of connections that Envoy will make to the upstream cluster. If not specified, the default is 1024.

      • maxPendingRequests (optional)

        The maximum number of pending requests that Envoy will allow to the upstream cluster. If not specified, the default is 1024.

      • maxRetries (optional)

        The maximum number of parallel retries that Envoy will allow to the upstream cluster. If not specified, the default is 3.

      • maxRequests (optional)

        The maximum number of parallel requests that Envoy will make to the upstream cluster. If not specified, the default is 1024.

Thank you for your feedback.
Was this page useful?
  • Kong
    THE CLOUD CONNECTIVITY COMPANY

    Kong powers reliable digital connections across APIs, hybrid and multi-cloud environments.

    • Company
    • Customers
    • Events
    • Investors
    • Careers Hiring!
    • Partners
    • Press
    • Contact
  • Products
    • Kong Konnect
    • Kong Gateway
    • Kong Mesh
    • Get Started
    • Pricing
  • Resources
    • eBooks
    • Webinars
    • Briefs
    • Blog
    • API Gateway
    • Microservices
  • Open Source
    • Install Kong Gateway
    • Kong Community
    • Kubernetes Ingress
    • Kuma
    • Insomnia
  • Solutions
    • Decentralize
    • Secure & Govern
    • Create a Dev Platform
    • API Gateway
    • Kubernetes
    • Service Mesh
Star
  • Terms•Privacy
© Kong Inc. 2023