Add PARKED, INTERRUPTED and DELAYED to the Metric types #258 (#259)

* Add PARKED, INTERRUPTED and DELAYED to the Metric types #258

* Add PARKED, INTERRUPTED and DELAYED to the Metric types #258

README.adoc

@@ -497,6 +497,7 @@ This section is meant to help you migrate your application to new version of thi
 ==== Spring Boot Starter Bucket4j 0.12
 
 * Removed deprecated expression property
+* three new metric counter are added per default (PARKED, INTERRUPTED and DELAYED)
 
 ==== Spring Boot Starter Bucket4j 0.9
 

bucket4j-spring-boot-starter-context/src/main/java/com/giffing/bucket4j/spring/boot/starter/context/metrics/MetricBucketListener.java

@@ -3,14 +3,16 @@
 import java.util.List;
 
 import io.github.bucket4j.BucketListener;
+import lombok.Getter;
 
 /**
  * Marker Interface
  *
  */
 public class MetricBucketListener implements BucketListener {
 
-    private final String name;
+    @Getter
+	private final String name;
 	private final List<MetricTagResult> tags;
 	private final List<MetricHandler> metricHandlers;
 	private final List<MetricType> allowedTypes;
@@ -36,26 +38,26 @@ public void onRejected(long tokens) {
     	}
     }
 
-	public String getName() {
-		return name;
-	}
-
 	@Override
 	public void onParked(long nanos) {
-		// TODO check if we should provide this information
-
+		if(allowedTypes.contains(MetricType.PARKED_COUNTER)) {
+			metricHandlers.forEach(metricHandler -> metricHandler.handle(MetricType.PARKED_COUNTER, name, 1, tags));
+		}
 	}
 
 	@Override
 	public void onInterrupted(InterruptedException e) {
-		// TODO check if we should provide this information
+		if(allowedTypes.contains(MetricType.INTERRUPTED_COUNTER)) {
+			metricHandlers.forEach(metricHandler -> metricHandler.handle(MetricType.INTERRUPTED_COUNTER, name, 1, tags));
+		}
 
 	}
 
 	@Override
 	public void onDelayed(long nanos) {
-		// TODO check if we should provide this information
-
+		if(allowedTypes.contains(MetricType.DELAYED_COUNTER)) {
+			metricHandlers.forEach(metricHandler -> metricHandler.handle(MetricType.DELAYED_COUNTER, name, 1, tags));
+		}
 	}
 
 }

bucket4j-spring-boot-starter-context/src/main/java/com/giffing/bucket4j/spring/boot/starter/context/metrics/MetricHandler.java

@@ -4,6 +4,6 @@
 
 public interface MetricHandler {
 
-    void handle(MetricType type, String name, long tokens, List<MetricTagResult> tags);
+    void handle(MetricType type, String name, long counterIncrement, List<MetricTagResult> tags);
 
 }

bucket4j-spring-boot-starter-context/src/main/java/com/giffing/bucket4j/spring/boot/starter/context/metrics/MetricType.java

@@ -2,6 +2,29 @@
 
 public enum MetricType {
 
+	/**
+	 * Count token consumption.
+	 */
 	CONSUMED_COUNTER,
-	REJECTED_COUNTER
+
+	/**
+	 * Count whenever consumption request for tokens is rejected.
+	 */
+	REJECTED_COUNTER,
+
+	/**
+	 * Count parked threads which wait of tokens refill in result of interaction with Bucket4js BlockingBucket.
+	 */
+	PARKED_COUNTER,
+
+	/**
+	 *  Count interrupted threads during the wait of tokens refill in result of interaction with Bucket4js BlockingBucket
+	 */
+	INTERRUPTED_COUNTER,
+
+	/**
+	 * Count delayed tasks was submit to java.util.concurrent.ScheduledExecutorService
+	 * because of wait for tokens refill in result of interaction with SchedulingBucket
+	 */
+	DELAYED_COUNTER
 }

bucket4j-spring-boot-starter/src/main/java/com/giffing/bucket4j/spring/boot/starter/config/metrics/actuator/Bucket4jMetricHandler.java

@@ -16,8 +16,10 @@
 @Primary
 public class Bucket4jMetricHandler implements MetricHandler {
 
+	public static final String METRIC_COUNTER_PREFIX = "bucket4j_summary_";
+
 	@Override
-	public void handle(MetricType type, String name, long tokens, List<MetricTagResult> tags) {
+	public void handle(MetricType type, String name, long counterIncrement, List<MetricTagResult> tags) {
 
 		List<String> extendedTags = new ArrayList<>();
 		extendedTags.add("name");
@@ -33,13 +35,28 @@ public void handle(MetricType type, String name, long tokens, List<MetricTagResu
 		switch (type) {
 		case CONSUMED_COUNTER:
 			Metrics
-				.counter("bucket4j_summary_consumed", extendedTagsArray)
-				.increment(tokens);
+				.counter(METRIC_COUNTER_PREFIX + "consumed", extendedTagsArray)
+				.increment(counterIncrement);
 			break;
 		case REJECTED_COUNTER:
 			Metrics
-				.counter("bucket4j_summary_rejected", extendedTagsArray)
-				.increment(tokens);
+				.counter(METRIC_COUNTER_PREFIX + "rejected", extendedTagsArray)
+				.increment(counterIncrement);
+			break;
+		case PARKED_COUNTER:
+			Metrics
+					.counter(METRIC_COUNTER_PREFIX + "parked", extendedTagsArray)
+					.increment(counterIncrement);
+			break;
+		case INTERRUPTED_COUNTER:
+		Metrics
+				.counter(METRIC_COUNTER_PREFIX + "interrupted", extendedTagsArray)
+				.increment(counterIncrement);
+		break;
+		case DELAYED_COUNTER:
+			Metrics
+					.counter(METRIC_COUNTER_PREFIX + "delayed", extendedTagsArray)
+					.increment(counterIncrement);
 			break;
 		default:
 			throw new IllegalStateException("Unsupported metric type: " + type);