Micrometer - rework interceptors

- interceptors obtain the metadata from the interceptor bindings instead of InvocationContext.getMethod() and reflection; this makes it possible to reflect "synthetic" annotations added by extensions via annotation transformers - Timed is registered as an additional interceptor binding; MicrometerTimed is no longer necessary - repeatable Timed annotations are now supported - Counted cannot be registered as an additional interceptor binding because it's only applicable to methods - also enhanced the ArcInvocationContext to easily find interceptor binding annotations of a given type
stuartwdouglas · Jul 30, 2021 · cd49175 · cd49175
1 parent b6723f5
commit cd49175
Show file tree

Hide file tree

Showing 15 changed files with 285 additions and 165 deletions.
diff --git a/...ometer/deployment/src/main/java/io/quarkus/micrometer/deployment/MicrometerProcessor.java b/...ometer/deployment/src/main/java/io/quarkus/micrometer/deployment/MicrometerProcessor.java
@@ -8,6 +8,8 @@
 
 import org.jboss.jandex.AnnotationInstance;
 import org.jboss.jandex.AnnotationTarget;
+import org.jboss.jandex.AnnotationTarget.Kind;
+import org.jboss.jandex.AnnotationValue;
 import org.jboss.jandex.ClassInfo;
 import org.jboss.jandex.DotName;
 import org.jboss.jandex.FieldInfo;
@@ -23,9 +25,12 @@
 import io.quarkus.arc.deployment.AdditionalBeanBuildItem;
 import io.quarkus.arc.deployment.AnnotationsTransformerBuildItem;
 import io.quarkus.arc.deployment.BeanContainerBuildItem;
+import io.quarkus.arc.deployment.InterceptorBindingRegistrarBuildItem;
 import io.quarkus.arc.deployment.UnremovableBeanBuildItem;
+import io.quarkus.arc.processor.Annotations;
 import io.quarkus.arc.processor.AnnotationsTransformer;
 import io.quarkus.arc.processor.DotNames;
+import io.quarkus.arc.processor.InterceptorBindingRegistrar;
 import io.quarkus.deployment.Feature;
 import io.quarkus.deployment.annotations.BuildProducer;
 import io.quarkus.deployment.annotations.BuildStep;
@@ -45,7 +50,6 @@
 import io.quarkus.micrometer.runtime.MicrometerCounted;
 import io.quarkus.micrometer.runtime.MicrometerCountedInterceptor;
 import io.quarkus.micrometer.runtime.MicrometerRecorder;
-import io.quarkus.micrometer.runtime.MicrometerTimed;
 import io.quarkus.micrometer.runtime.MicrometerTimedInterceptor;
 import io.quarkus.micrometer.runtime.config.MicrometerConfig;
 import io.quarkus.runtime.RuntimeValue;
@@ -62,7 +66,6 @@ public class MicrometerProcessor {
     private static final DotName COUNTED_BINDING = DotName.createSimple(MicrometerCounted.class.getName());
     private static final DotName COUNTED_INTERCEPTOR = DotName.createSimple(MicrometerCountedInterceptor.class.getName());
     private static final DotName TIMED_ANNOTATION = DotName.createSimple(Timed.class.getName());
-    private static final DotName TIMED_BINDING = DotName.createSimple(MicrometerTimed.class.getName());
     private static final DotName TIMED_INTERCEPTOR = DotName.createSimple(MicrometerTimedInterceptor.class.getName());
 
     public static class MicrometerEnabled implements BooleanSupplier {
@@ -97,7 +100,8 @@ MetricsCapabilityBuildItem metricsCapabilityPrometheusBuildItem(
     UnremovableBeanBuildItem registerAdditionalBeans(CombinedIndexBuildItem indexBuildItem,
             BuildProducer<MicrometerRegistryProviderBuildItem> providerClasses,
             BuildProducer<ReflectiveClassBuildItem> reflectiveClasses,
-            BuildProducer<AdditionalBeanBuildItem> additionalBeans) {
+            BuildProducer<AdditionalBeanBuildItem> additionalBeans,
+            BuildProducer<InterceptorBindingRegistrarBuildItem> interceptorBindings) {
 
         // Create and keep some basic Providers
         additionalBeans.produce(AdditionalBeanBuildItem.builder()
@@ -111,13 +115,20 @@ UnremovableBeanBuildItem registerAdditionalBeans(CombinedIndexBuildItem indexBui
                 .addBeanClass(MeterFilterConstraint.class)
                 .addBeanClass(MeterFilterConstraints.class)
                 .addBeanClass(TIMED_ANNOTATION.toString())
-                .addBeanClass(TIMED_BINDING.toString())
                 .addBeanClass(TIMED_INTERCEPTOR.toString())
                 .addBeanClass(COUNTED_ANNOTATION.toString())
                 .addBeanClass(COUNTED_BINDING.toString())
                 .addBeanClass(COUNTED_INTERCEPTOR.toString())
                 .build());
 
+        // @Timed is registered as an additional interceptor binding
+        interceptorBindings.produce(new InterceptorBindingRegistrarBuildItem(new InterceptorBindingRegistrar() {
+            @Override
+            public List<InterceptorBinding> getAdditionalBindings() {
+                return List.of(InterceptorBinding.of(Timed.class, m -> true));
+            }
+        }));
+
         IndexView index = indexBuildItem.getIndex();
 
         // Find classes that define MeterRegistries, MeterBinders, and MeterFilters
@@ -182,9 +193,27 @@ void collectNames(Collection<ClassInfo> classes, Collection<String> names) {
     }
 
     @BuildStep(onlyIf = MicrometerEnabled.class)
-    void processAnnotatedMetrics(BuildProducer<AnnotationsTransformerBuildItem> annotationsTransformers) {
-        annotationsTransformers.produce(createAnnotationTransformer(COUNTED_ANNOTATION, COUNTED_BINDING));
-        annotationsTransformers.produce(createAnnotationTransformer(TIMED_ANNOTATION, TIMED_BINDING));
+    AnnotationsTransformerBuildItem processAnnotatedMetrics(
+            BuildProducer<AnnotationsTransformerBuildItem> annotationsTransformers) {
+        return new AnnotationsTransformerBuildItem(new AnnotationsTransformer() {
+
+            @Override
+            public boolean appliesTo(Kind kind) {
+                // @Counted is only applicable to a method 
+                return kind == Kind.METHOD;
+            }
+
+            @Override
+            public void transform(TransformationContext ctx) {
+                final Collection<AnnotationInstance> annotations = ctx.getAnnotations();
+                AnnotationInstance counted = Annotations.find(annotations, COUNTED_ANNOTATION);
+                if (counted == null) {
+                    return;
+                }
+                // Copy all the values so that the interceptor can use the binding annotation instead of java.lang.reflect.Method
+                ctx.transform().add(COUNTED_BINDING, counted.values().toArray(new AnnotationValue[] {})).done();
+            }
+        });
     }
 
     @BuildStep(onlyIf = MicrometerEnabled.class)
@@ -238,15 +267,6 @@ void configureRegistry(MicrometerRecorder recorder,
         }
     }
 
-    public static AnnotationInstance findAnnotation(Collection<AnnotationInstance> annotations, DotName annotationClass) {
-        for (AnnotationInstance a : annotations) {
-            if (annotationClass.equals(a.name())) {
-                return a;
-            }
-        }
-        return null;
-    }
-
     ReflectiveClassBuildItem createReflectiveBuildItem(DotName sourceAnnotation, IndexView index) {
         Set<String> classes = new HashSet<>();
 
@@ -268,17 +288,4 @@ ReflectiveClassBuildItem createReflectiveBuildItem(DotName sourceAnnotation, Ind
         return ReflectiveClassBuildItem.builder(classes.toArray(new String[0])).build();
     }
 
-    AnnotationsTransformerBuildItem createAnnotationTransformer(DotName sourceAnnotation, DotName bindingAnnotation) {
-        return new AnnotationsTransformerBuildItem(new AnnotationsTransformer() {
-            @Override
-            public void transform(TransformationContext ctx) {
-                final Collection<AnnotationInstance> annotations = ctx.getAnnotations();
-                AnnotationInstance annotation = MicrometerProcessor.findAnnotation(annotations, sourceAnnotation);
-                if (annotation == null) {
-                    return;
-                }
-                ctx.transform().add(bindingAnnotation).done();
-            }
-        });
-    }
 }
diff --git a/...nt/src/main/java/io/quarkus/micrometer/deployment/binder/mpmetrics/AnnotationHandler.java b/...nt/src/main/java/io/quarkus/micrometer/deployment/binder/mpmetrics/AnnotationHandler.java
@@ -6,9 +6,9 @@
 import org.jboss.logging.Logger;
 
 import io.quarkus.arc.deployment.AnnotationsTransformerBuildItem;
+import io.quarkus.arc.processor.Annotations;
 import io.quarkus.arc.processor.AnnotationsTransformer;
 import io.quarkus.arc.processor.DotNames;
-import io.quarkus.micrometer.deployment.MicrometerProcessor;
 
 /**
  * Create beans to handle MP Metrics API annotations.
@@ -28,7 +28,7 @@ static AnnotationsTransformerBuildItem transformAnnotations(final IndexView inde
             @Override
             public void transform(TransformationContext ctx) {
                 final Collection<AnnotationInstance> annotations = ctx.getAnnotations();
-                AnnotationInstance annotation = MicrometerProcessor.findAnnotation(annotations, sourceAnnotation);
+                AnnotationInstance annotation = Annotations.find(annotations, sourceAnnotation);
                 if (annotation == null) {
                     return;
                 }
@@ -78,9 +78,8 @@ static boolean removeCountedWhenTimed(DotName sourceAnnotation, AnnotationTarget
             MethodInfo methodInfo) {
         if (MetricDotNames.COUNTED_ANNOTATION.equals(sourceAnnotation)) {
             if (methodInfo == null) {
-                if (MicrometerProcessor.findAnnotation(classInfo.classAnnotations(), MetricDotNames.TIMED_ANNOTATION) == null &&
-                        MicrometerProcessor.findAnnotation(classInfo.classAnnotations(),
-                                MetricDotNames.SIMPLY_TIMED_ANNOTATION) == null) {
+                if (!Annotations.contains(classInfo.classAnnotations(), MetricDotNames.TIMED_ANNOTATION) &&
+                        !Annotations.contains(classInfo.classAnnotations(), MetricDotNames.SIMPLY_TIMED_ANNOTATION)) {
                     return false;
                 }
                 log.warnf("Bean %s is both counted and timed. The @Counted annotation " +

diff --git a/...eployment/src/test/java/io/quarkus/micrometer/runtime/MicrometerTimedInterceptorTest.java b/...eployment/src/test/java/io/quarkus/micrometer/runtime/MicrometerTimedInterceptorTest.java
@@ -154,4 +154,23 @@ void testTimeMethod_LongTaskTimer_AsyncFailed() {
         Assertions.assertEquals(0, timer.activeTasks());
     }
 
+    @Test
+    void testTimeMethod_repeatable() {
+        timed.repeatableCall(false);
+        Timer alphaTimer = registry.get("alpha")
+                .tag("method", "repeatableCall")
+                .tag("class", "io.quarkus.micrometer.test.TimedResource")
+                .tag("exception", "none")
+                .tag("extra", "tag").timer();
+        Assertions.assertNotNull(alphaTimer);
+        Assertions.assertEquals(1, alphaTimer.count());
+        Timer bravoTimer = registry.get("bravo")
+                .tag("method", "repeatableCall")
+                .tag("class", "io.quarkus.micrometer.test.TimedResource")
+                .tag("exception", "none")
+                .tag("extra", "tag").timer();
+        Assertions.assertNotNull(bravoTimer);
+        Assertions.assertEquals(1, bravoTimer.count());
+    }
+
 }
diff --git a/extensions/micrometer/deployment/src/test/java/io/quarkus/micrometer/test/TimedResource.java b/extensions/micrometer/deployment/src/test/java/io/quarkus/micrometer/test/TimedResource.java
@@ -42,4 +42,12 @@ public CompletableFuture<?> longAsyncCall(GuardedResult guardedResult) {
         }
         return supplyAsync(guardedResult::get);
     }
+
+    @Timed(value = "alpha", extraTags = { "extra", "tag" })
+    @Timed(value = "bravo", extraTags = { "extra", "tag" })
+    public void repeatableCall(boolean fail) {
+        if (fail) {
+            throw new NullPointerException("Failed on purpose");
+        }
+    }
 }
diff --git a/...ons/micrometer/runtime/src/main/java/io/quarkus/micrometer/runtime/MicrometerCounted.java b/...ons/micrometer/runtime/src/main/java/io/quarkus/micrometer/runtime/MicrometerCounted.java
@@ -6,11 +6,38 @@
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
+import javax.enterprise.util.Nonbinding;
 import javax.interceptor.InterceptorBinding;
 
+import io.micrometer.core.annotation.Counted;
+
 @Inherited
 @InterceptorBinding
 @Target({ ElementType.ANNOTATION_TYPE, ElementType.TYPE, ElementType.METHOD })
 @Retention(RetentionPolicy.RUNTIME)
 public @interface MicrometerCounted {
+
+    /**
+     * @see Counted#value()
+     */
+    @Nonbinding
+    String value() default "method.counted";
+
+    /**
+     * @see Counted#recordFailuresOnly()
+     */
+    @Nonbinding
+    boolean recordFailuresOnly() default false;
+
+    /**
+     * @see Counted#extraTags()
+     */
+    @Nonbinding
+    String[] extraTags() default {};
+
+    /**
+     * @see Counted#description()
+     */
+    @Nonbinding
+    String description() default "";
 }
diff --git a/...ter/runtime/src/main/java/io/quarkus/micrometer/runtime/MicrometerCountedInterceptor.java b/...ter/runtime/src/main/java/io/quarkus/micrometer/runtime/MicrometerCountedInterceptor.java
@@ -6,12 +6,12 @@
 import javax.annotation.Priority;
 import javax.interceptor.AroundInvoke;
 import javax.interceptor.Interceptor;
-import javax.interceptor.InvocationContext;
 
 import io.micrometer.core.annotation.Counted;
 import io.micrometer.core.instrument.Counter;
 import io.micrometer.core.instrument.MeterRegistry;
 import io.micrometer.core.instrument.Tags;
+import io.quarkus.arc.ArcInvocationContext;
 
 /**
  * Quarkus declared interceptor responsible for intercepting all methods
@@ -51,13 +51,12 @@ public MicrometerCountedInterceptor(MeterRegistry meterRegistry) {
      * @throws Throwable When the intercepted method throws one.
      */
     @AroundInvoke
-    Object countedMethod(InvocationContext context) throws Exception {
-        Method method = context.getMethod();
-        Counted counted = method.getAnnotation(Counted.class);
+    Object countedMethod(ArcInvocationContext context) throws Exception {
+        MicrometerCounted counted = context.findIterceptorBinding(MicrometerCounted.class);
         if (counted == null) {
             return context.proceed();
         }
-
+        Method method = context.getMethod();
         Tags commonTags = getCommonTags(method.getDeclaringClass().getName(), method.getName());
 
         // If we're working with a CompletionStage
@@ -84,15 +83,15 @@ Object countedMethod(InvocationContext context) throws Exception {
         }
     }
 
-    private void recordCompletionResult(Counted counted, Tags commonTags, Throwable throwable) {
+    private void recordCompletionResult(MicrometerCounted counted, Tags commonTags, Throwable throwable) {
         if (throwable != null) {
             record(counted, commonTags, throwable);
         } else if (!counted.recordFailuresOnly()) {
             record(counted, commonTags, null);
         }
     }
 
-    private void record(Counted counted, Tags commonTags, Throwable throwable) {
+    private void record(MicrometerCounted counted, Tags commonTags, Throwable throwable) {
         Counter.Builder builder = Counter.builder(counted.value())
                 .tags(commonTags)
                 .tags(counted.extraTags())
@@ -108,4 +107,5 @@ private void record(Counted counted, Tags commonTags, Throwable throwable) {
     private Tags getCommonTags(String className, String methodName) {
         return Tags.of("class", className, "method", methodName);
     }
+
 }
diff --git a/...sions/micrometer/runtime/src/main/java/io/quarkus/micrometer/runtime/MicrometerTimed.java b/...sions/micrometer/runtime/src/main/java/io/quarkus/micrometer/runtime/MicrometerTimed.java