Skip to content

feat: document circuit breaker config options for targets#37

Open
sametd wants to merge 1 commit intoupstreamfrom
feat/circuit-breaker-config
Open

feat: document circuit breaker config options for targets#37
sametd wants to merge 1 commit intoupstreamfrom
feat/circuit-breaker-config

Conversation

@sametd
Copy link
Copy Markdown
Member

@sametd sametd commented Apr 2, 2026

Summary

  • Document circuit breaker configuration options in the default target definition

Change

Add commented-out circuit_breaker section to values.yaml under the worker_pool target. No template changes needed since targets are passed through via toYaml.

# circuit_breaker:            # Stop sending requests when target is consistently failing
#   failure_threshold: 5      # Consecutive transport failures to trip open (default 5)
#   open_timeout_secs: 30     # Seconds before allowing a probe request (default 30)

Operators uncomment and adjust values to enable per-target circuit breaking. When a target fails failure_threshold times consecutively (connection errors, timeouts, 5xx), the broker stops sending requests for open_timeout_secs, then allows one probe request to test recovery.

Contributor Declaration

By opening this pull request, I affirm the following:

  • All authors agree to the Contributor License Agreement.
  • The code follows the project's coding standards.
  • I have performed self-review and added comments where needed.
  • I have added or updated tests to verify that my changes are effective and functional.
  • I have run all existing tests and confirmed they pass.

Add commented-out circuit_breaker section to the default
worker_pool target showing failure_threshold and
open_timeout_secs with defaults. The config is passed through
to bits via toYaml and requires no template changes.
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Documents per-target circuit breaker configuration options in the Helm chart’s default broker target definition, making it easier for operators to discover and enable circuit breaking.

Changes:

  • Adds a commented-out circuit_breaker block under broker.targets.worker_pool in values.yaml describing available knobs (failure_threshold, open_timeout_secs).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants