davsclaus commented on code in PR #26603:
URL: https://github.com/apache/camel/pull/26603#discussion_r4048741524
##########
core/camel-api/src/main/java/org/apache/camel/spi/CircuitBreakerConstants.java:
##########
@@ -27,13 +27,17 @@ public interface CircuitBreakerConstants {
@Metadata(label = "circuitBreaker",
description = "Whether the exchange was processed by the
onFallback by the circuit breaker", javaType = "boolean")
String RESPONSE_FROM_FALLBACK = "CamelCircuitBreakerResponseFromFallback";
- @Metadata(label = "circuitBreaker", description = "Whether the exchange
was short circuited by the breaker",
+ @Metadata(label = "circuitBreaker",
+ description = "Whether the call did not complete normally and
the circuit breaker short circuited the exchange, to the onFallback if there is
one."
+ + " This is true for a failed call, a timeout and
a rejected call alike; use CamelCircuitBreakerResponseRejected to know whether
the call was attempted.",
javaType = "boolean")
String RESPONSE_SHORT_CIRCUITED =
"CamelCircuitBreakerResponseShortCircuited";
@Metadata(label = "circuitBreaker", description = "Whether the exchange
timed out during processing by the circuit breaker",
javaType = "boolean")
String RESPONSE_TIMED_OUT = "CamelCircuitBreakerResponseTimedOut";
- @Metadata(label = "circuitBreaker", description = "Whether the circuit
breaker rejected processing the exchange",
+ @Metadata(label = "circuitBreaker",
+ description = "Whether the circuit breaker rejected the call
without attempting it, because the breaker is open or the bulkhead is full."
+ + " Also set inside the onFallback, where it tells
a dead service apart from a single failed call.",
javaType = "boolean")
String RESPONSE_REJECTED = "CamelCircuitBreakerResponseRejected";
@Metadata(label = "circuitBreaker", description = "Whether the circuit
breaker ignored an exception during processing",
Review Comment:
Good point. The change lives in #26602, so I added it there as a section in
the 4.23 upgrade guide (`camel-4x-upgrade-guide-4_23.adoc`, "Circuit Breaker
EIP"): the property is now always `true` or `false` inside the `onFallback`,
was absent before, and a `null` test must change. I kept the version note out
of the constant's description on purpose: that text is generated into the
catalog and the EIP docs, where a "prior to 4.X" sentence would go stale, while
the upgrade guide is the place readers look for it. This branch is rebased on
the updated #26602.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
