You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by da...@apache.org on 2021/10/29 11:17:01 UTC
[camel] 03/16: CAMEL-15133: Adding fine-grained consumer health
check to route checks
This is an automated email from the ASF dual-hosted git repository.
davsclaus pushed a commit to branch custom-health
in repository https://gitbox.apache.org/repos/asf/camel.git
commit 8334702e2ae77c293b8820041850559c166868ca
Author: Claus Ibsen <cl...@gmail.com>
AuthorDate: Thu Oct 28 09:44:18 2021 +0200
CAMEL-15133: Adding fine-grained consumer health check to route checks
---
.../org/apache/camel/health/HealthCheckAware.java | 2 -
.../camel/support/ScheduledPollConsumer.java | 52 +++++++++++++++---
.../support/ScheduledPollConsumerHealthCheck.java | 63 ++++++++++++++++++++++
3 files changed, 109 insertions(+), 8 deletions(-)
diff --git a/core/camel-api/src/main/java/org/apache/camel/health/HealthCheckAware.java b/core/camel-api/src/main/java/org/apache/camel/health/HealthCheckAware.java
index 8a7f025..321c614 100644
--- a/core/camel-api/src/main/java/org/apache/camel/health/HealthCheckAware.java
+++ b/core/camel-api/src/main/java/org/apache/camel/health/HealthCheckAware.java
@@ -16,8 +16,6 @@
*/
package org.apache.camel.health;
-import org.apache.camel.health.HealthCheck;
-
public interface HealthCheckAware {
HealthCheck getHealthCheck();
diff --git a/core/camel-support/src/main/java/org/apache/camel/support/ScheduledPollConsumer.java b/core/camel-support/src/main/java/org/apache/camel/support/ScheduledPollConsumer.java
index 6106c21..cfaff14 100644
--- a/core/camel-support/src/main/java/org/apache/camel/support/ScheduledPollConsumer.java
+++ b/core/camel-support/src/main/java/org/apache/camel/support/ScheduledPollConsumer.java
@@ -16,12 +16,6 @@
*/
package org.apache.camel.support;
-import java.util.LinkedHashMap;
-import java.util.Map;
-import java.util.concurrent.ScheduledExecutorService;
-import java.util.concurrent.TimeUnit;
-import java.util.concurrent.atomic.AtomicLong;
-
import org.apache.camel.Endpoint;
import org.apache.camel.Exchange;
import org.apache.camel.FailedToCreateConsumerException;
@@ -29,6 +23,7 @@ import org.apache.camel.LoggingLevel;
import org.apache.camel.PollingConsumerPollingStrategy;
import org.apache.camel.Processor;
import org.apache.camel.Suspendable;
+import org.apache.camel.health.HealthCheck;
import org.apache.camel.health.HealthCheckAware;
import org.apache.camel.spi.PollingConsumerPollStrategy;
import org.apache.camel.spi.ScheduledPollConsumerScheduler;
@@ -38,6 +33,12 @@ import org.apache.camel.util.PropertiesHelper;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
+import java.util.LinkedHashMap;
+import java.util.Map;
+import java.util.concurrent.ScheduledExecutorService;
+import java.util.concurrent.TimeUnit;
+import java.util.concurrent.atomic.AtomicLong;
+
/**
* A useful base class for any consumer which is polling based
*/
@@ -46,6 +47,7 @@ public abstract class ScheduledPollConsumer extends DefaultConsumer
private static final Logger LOG = LoggerFactory.getLogger(ScheduledPollConsumer.class);
+ private HealthCheck healthCheck;
private ScheduledPollConsumerScheduler scheduler;
private ScheduledExecutorService scheduledExecutorService;
@@ -71,6 +73,7 @@ public abstract class ScheduledPollConsumer extends DefaultConsumer
private volatile int backoffCounter;
private volatile long idleCounter;
private volatile long errorCounter;
+ private volatile Throwable lastError;
private final AtomicLong counter = new AtomicLong();
public ScheduledPollConsumer(Endpoint endpoint, Processor processor) {
@@ -250,9 +253,11 @@ public abstract class ScheduledPollConsumer extends DefaultConsumer
if (cause != null) {
idleCounter = 0;
errorCounter++;
+ lastError = cause;
} else {
idleCounter = polledMessages == 0 ? ++idleCounter : 0;
errorCounter = 0;
+ lastError = null;
}
LOG.trace("doRun() done with idleCounter={}, errorCounter={}", idleCounter, errorCounter);
@@ -420,10 +425,37 @@ public abstract class ScheduledPollConsumer extends DefaultConsumer
this.scheduledExecutorService = scheduledExecutorService;
}
+ @Override
+ public void setHealthCheck(HealthCheck healthCheck) {
+ this.healthCheck = healthCheck;
+ }
+
+ @Override
+ public HealthCheck getHealthCheck() {
+ return healthCheck;
+ }
+
// Implementation methods
// -------------------------------------------------------------------------
/**
+ * Gets the error counter. If the counter is > 0 that means the consumer
+ * failed polling for the last N number of times. When the consumer
+ * is successfully again, then the error counter resets to zero.
+ */
+ protected long getErrorCounter() {
+ return errorCounter;
+ }
+
+ /**
+ * Gets the last caused error (exception) for the last poll that failed.
+ * When the consumer is successfully again, then the error resets to null.
+ */
+ protected Throwable getLastError() {
+ return lastError;
+ }
+
+ /**
* The polling method which is invoked periodically to poll this consumer
*
* @return number of messages polled, will be <tt>0</tt> if no message was polled at all.
@@ -432,6 +464,14 @@ public abstract class ScheduledPollConsumer extends DefaultConsumer
protected abstract int poll() throws Exception;
@Override
+ protected void doBuild() throws Exception {
+ if (healthCheck == null) {
+ String id = "consumer:" + getRouteId();
+ healthCheck = new ScheduledPollConsumerHealthCheck(this, id);
+ }
+ }
+
+ @Override
protected void doInit() throws Exception {
super.doInit();
diff --git a/core/camel-support/src/main/java/org/apache/camel/support/ScheduledPollConsumerHealthCheck.java b/core/camel-support/src/main/java/org/apache/camel/support/ScheduledPollConsumerHealthCheck.java
new file mode 100644
index 0000000..aa46bdd
--- /dev/null
+++ b/core/camel-support/src/main/java/org/apache/camel/support/ScheduledPollConsumerHealthCheck.java
@@ -0,0 +1,63 @@
+package org.apache.camel.support;
+
+import org.apache.camel.health.HealthCheck;
+import org.apache.camel.health.HealthCheckConfiguration;
+import org.apache.camel.health.HealthCheckResultBuilder;
+import org.apache.camel.util.URISupport;
+
+import java.util.Map;
+
+public class ScheduledPollConsumerHealthCheck implements HealthCheck {
+
+ public static final String FAILURE_COUNT = "failure.count";
+ public static final String ROUTE = "route.id";
+
+ private final HealthCheckConfiguration configuration = new HealthCheckConfiguration();
+ private final ScheduledPollConsumer consumer;
+ private final String id;
+
+ public ScheduledPollConsumerHealthCheck(ScheduledPollConsumer consumer, String id) {
+ this.consumer = consumer;
+ this.id = id;
+ }
+
+ @Override
+ public HealthCheckConfiguration getConfiguration() {
+ return configuration;
+ }
+
+ @Override
+ public Result call(Map<String, Object> options) {
+ final HealthCheckResultBuilder builder = HealthCheckResultBuilder.on(this);
+ builder.detail(ROUTE, consumer.getRouteId());
+
+ long ec = consumer.getErrorCounter();
+ Throwable cause = consumer.getLastError();
+
+ boolean healthy = ec == 0 || ec < configuration.getFailureThreshold();
+ if (healthy) {
+ builder.up();
+ } else {
+ builder.down();
+ builder.detail(FAILURE_COUNT, ec);
+ String uri = consumer.getEndpoint().getEndpointBaseUri();
+ uri = URISupport.sanitizeUri(uri);
+ String rid = consumer.getRouteId();
+ String msg = "Consumer failed polling %s times route: %s (%s)";
+ builder.message(String.format(msg, ec, rid, uri));
+ builder.error(cause);
+ }
+
+ return builder.build();
+ }
+
+ @Override
+ public String getGroup() {
+ return "camel";
+ }
+
+ @Override
+ public String getId() {
+ return id;
+ }
+}