- Set path template onto Vertx Context

- Update span name with path template for OpenTelemetry - Remove SPI module of `resteasy-observability` and move class into deployment module instead
quarkusio · Jun 9, 2021 · 141a21a · 141a21a
1 parent fea9a08
commit 141a21a
Show file tree

Hide file tree

Showing 22 changed files with 100 additions and 65 deletions.
diff --git a/devtools/bom-descriptor-json/pom.xml b/devtools/bom-descriptor-json/pom.xml
@@ -2008,6 +2008,19 @@
                         </exclusion>
                     </exclusions>
                 </dependency>
+                <dependency>
+                    <groupId>io.quarkus</groupId>
+                    <artifactId>quarkus-resteasy-observability</artifactId>
+                    <version>${project.version}</version>
+                    <type>pom</type>
+                    <scope>test</scope>
+                    <exclusions>
+                        <exclusion>
+                            <groupId>*</groupId>
+                            <artifactId>*</artifactId>
+                        </exclusion>
+                    </exclusions>
+                </dependency>
                 <dependency>
                     <groupId>io.quarkus</groupId>
                     <artifactId>quarkus-resteasy-qute</artifactId>

diff --git a/docs/pom.xml b/docs/pom.xml
@@ -1969,6 +1969,19 @@
                 </exclusion>
             </exclusions>
         </dependency>
+        <dependency>
+            <groupId>io.quarkus</groupId>
+            <artifactId>quarkus-resteasy-observability-deployment</artifactId>
+            <version>${project.version}</version>
+            <type>pom</type>
+            <scope>test</scope>
+            <exclusions>
+                <exclusion>
+                    <groupId>*</groupId>
+                    <artifactId>*</artifactId>
+                </exclusion>
+            </exclusions>
+        </dependency>
         <dependency>
             <groupId>io.quarkus</groupId>
             <artifactId>quarkus-resteasy-qute-deployment</artifactId>

diff --git a/extensions/micrometer/deployment/pom.xml b/extensions/micrometer/deployment/pom.xml
@@ -119,7 +119,7 @@
                 <artifactId>maven-surefire-plugin</artifactId>
                 <configuration>
                     <systemPropertyVariables>
-                        <quarkus.log.level>DEBUG</quarkus.log.level>
+                        <quarkus.log.level>INFO</quarkus.log.level>
                     </systemPropertyVariables>
                 </configuration>
             </plugin>

diff --git a/extensions/micrometer/deployment/src/test/resources/test-logging.properties b/extensions/micrometer/deployment/src/test/resources/test-logging.properties
@@ -1,5 +1,4 @@
-quarkus.log.category."io.quarkus.micrometer".level=DEBUG
-quarkus.log.category."io.quarkus.resteasy.observability".level=DEBUG
+#quarkus.log.category."io.quarkus.micrometer".level=DEBUG
 quarkus.log.category."io.quarkus.bootstrap".level=INFO
-quarkus.log.category."io.quarkus.arc".level=DEBUG
+#quarkus.log.category."io.quarkus.arc".level=DEBUG
 quarkus.log.category."io.netty".level=INFO
diff --git a/...ime/src/main/java/io/quarkus/opentelemetry/runtime/tracing/vertx/VertxTracingAdapter.java b/...ime/src/main/java/io/quarkus/opentelemetry/runtime/tracing/vertx/VertxTracingAdapter.java
@@ -5,6 +5,7 @@
 import static io.opentelemetry.semconv.trace.attributes.SemanticAttributes.HTTP_FLAVOR;
 import static io.opentelemetry.semconv.trace.attributes.SemanticAttributes.HTTP_HOST;
 import static io.opentelemetry.semconv.trace.attributes.SemanticAttributes.HTTP_METHOD;
+import static io.opentelemetry.semconv.trace.attributes.SemanticAttributes.HTTP_ROUTE;
 import static io.opentelemetry.semconv.trace.attributes.SemanticAttributes.HTTP_SCHEME;
 import static io.opentelemetry.semconv.trace.attributes.SemanticAttributes.HTTP_STATUS_CODE;
 import static io.opentelemetry.semconv.trace.attributes.SemanticAttributes.HTTP_TARGET;
@@ -142,6 +143,13 @@ public <R> void sendResponse(
             return;
         }
 
+        // Update Span name if parameterized path present
+        String pathTemplate = context.getLocal("UrlPathTemplate");
+        if (pathTemplate != null && !pathTemplate.isEmpty()) {
+            span.updateName(pathTemplate.substring(1));
+            span.setAttribute(HTTP_ROUTE, pathTemplate);
+        }
+
         ((ContextInternal) context).dispatch(() -> {
             if (failure != null) {
                 span.setStatus(StatusCode.ERROR);

diff --git a/extensions/resteasy-classic/resteasy-common/deployment/pom.xml b/extensions/resteasy-classic/resteasy-common/deployment/pom.xml
@@ -29,6 +29,10 @@
             <groupId>io.quarkus</groupId>
             <artifactId>quarkus-arc-deployment</artifactId>
         </dependency>
+        <dependency>
+            <groupId>io.quarkus</groupId>
+            <artifactId>quarkus-resteasy-observability-deployment</artifactId>
+        </dependency>
     </dependencies>
 
     <build>

diff --git a/extensions/resteasy-classic/resteasy-common/runtime/pom.xml b/extensions/resteasy-classic/resteasy-common/runtime/pom.xml
@@ -30,6 +30,10 @@
             <groupId>io.quarkus</groupId>
             <artifactId>quarkus-arc</artifactId>
         </dependency>
+        <dependency>
+            <groupId>io.quarkus</groupId>
+            <artifactId>quarkus-resteasy-observability</artifactId>
+        </dependency>
         <dependency>
             <groupId>com.sun.activation</groupId>
             <artifactId>jakarta.activation</artifactId>

diff --git a/extensions/resteasy-classic/resteasy-server-common/deployment/pom.xml b/extensions/resteasy-classic/resteasy-server-common/deployment/pom.xml
@@ -37,10 +37,6 @@
             <groupId>io.quarkus</groupId>
             <artifactId>quarkus-undertow-spi</artifactId>
         </dependency>
-        <dependency>
-            <groupId>io.quarkus</groupId>
-            <artifactId>quarkus-resteasy-observability-spi</artifactId>
-        </dependency>
     </dependencies>
 
     <build>

diff --git a/...main/java/io/quarkus/resteasy/server/common/deployment/ResteasyServerCommonProcessor.java b/...main/java/io/quarkus/resteasy/server/common/deployment/ResteasyServerCommonProcessor.java
@@ -70,7 +70,7 @@
 import io.quarkus.resteasy.common.deployment.ResteasyCommonProcessor.ResteasyCommonConfig;
 import io.quarkus.resteasy.common.runtime.QuarkusInjectorFactory;
 import io.quarkus.resteasy.common.spi.ResteasyDotNames;
-import io.quarkus.resteasy.observability.spi.RestApplicationPathBuildItem;
+import io.quarkus.resteasy.observability.deployment.RestApplicationPathBuildItem;
 import io.quarkus.resteasy.server.common.runtime.QuarkusResteasyDeployment;
 import io.quarkus.resteasy.server.common.spi.AdditionalJaxRsResourceDefiningAnnotationBuildItem;
 import io.quarkus.resteasy.server.common.spi.AdditionalJaxRsResourceMethodAnnotationsBuildItem;

diff --git a/extensions/resteasy-observability/deployment/pom.xml b/extensions/resteasy-observability/deployment/pom.xml
@@ -25,11 +25,11 @@
         </dependency>
         <dependency>
             <groupId>io.quarkus</groupId>
-            <artifactId>quarkus-resteasy-observability</artifactId>
+            <artifactId>quarkus-vertx-http-deployment</artifactId>
         </dependency>
         <dependency>
             <groupId>io.quarkus</groupId>
-            <artifactId>quarkus-resteasy-observability-spi</artifactId>
+            <artifactId>quarkus-resteasy-observability</artifactId>
         </dependency>
 
         <!-- test -->

diff --git a/...ity/spi/RestApplicationPathBuildItem.java → ...loyment/RestApplicationPathBuildItem.java b/...ity/spi/RestApplicationPathBuildItem.java → ...loyment/RestApplicationPathBuildItem.java
@@ -1,4 +1,4 @@
-package io.quarkus.resteasy.observability.spi;
+package io.quarkus.resteasy.observability.deployment;
 
 import io.quarkus.builder.item.SimpleBuildItem;
 

diff --git a/...ployment/RestPathAnnotationProcessor.java → ...ployment/RestPathAnnotationProcessor.java b/...ployment/RestPathAnnotationProcessor.java → ...ployment/RestPathAnnotationProcessor.java
@@ -1,4 +1,4 @@
-package io.quarkus.resteasy.observability.runtime.deployment;
+package io.quarkus.resteasy.observability.deployment;
 
 import java.util.Optional;
 import java.util.regex.Pattern;
@@ -13,10 +13,14 @@
 import io.quarkus.arc.deployment.AdditionalBeanBuildItem;
 import io.quarkus.arc.deployment.AnnotationsTransformerBuildItem;
 import io.quarkus.arc.processor.AnnotationsTransformer;
+import io.quarkus.deployment.Capabilities;
+import io.quarkus.deployment.Capability;
+import io.quarkus.deployment.annotations.BuildProducer;
 import io.quarkus.deployment.annotations.BuildStep;
+import io.quarkus.deployment.metrics.MetricsCapabilityBuildItem;
 import io.quarkus.resteasy.observability.runtime.QuarkusRestPathTemplate;
 import io.quarkus.resteasy.observability.runtime.QuarkusRestPathTemplateInterceptor;
-import io.quarkus.resteasy.observability.spi.RestApplicationPathBuildItem;
+import io.quarkus.runtime.metrics.MetricsFactory;
 
 public class RestPathAnnotationProcessor {
 
@@ -29,19 +33,30 @@ public class RestPathAnnotationProcessor {
     public static final Pattern MULTIPLE_SLASH_PATTERN = Pattern.compile("//+");
 
     @BuildStep()
-    AdditionalBeanBuildItem registerBeanClasses() {
+    AdditionalBeanBuildItem registerBeanClasses(Capabilities capabilities,
+            Optional<MetricsCapabilityBuildItem> metricsCapability) {
+        if (notRequired(capabilities, metricsCapability)) {
+            return null;
+        }
+
         return AdditionalBeanBuildItem.builder()
-                .setUnremovable()
                 .addBeanClass(TEMPLATE_PATH.toString())
                 .addBeanClass(TEMPLATE_PATH_INTERCEPTOR.toString())
                 .build();
     }
 
     @BuildStep
-    AnnotationsTransformerBuildItem findRestPaths(
+    void findRestPaths(
+            Capabilities capabilities, Optional<MetricsCapabilityBuildItem> metricsCapability,
+            BuildProducer<AnnotationsTransformerBuildItem> transformers,
             Optional<RestApplicationPathBuildItem> restApplicationPath) {
 
-        return new AnnotationsTransformerBuildItem(new AnnotationsTransformer() {
+        if (notRequired(capabilities, metricsCapability)) {
+            // Don't create transformer if Micrometer or OpenTelemetry are not present
+            return;
+        }
+
+        transformers.produce(new AnnotationsTransformerBuildItem(new AnnotationsTransformer() {
             @Override
             public boolean appliesTo(AnnotationTarget.Kind kind) {
                 return kind == AnnotationTarget.Kind.METHOD;
@@ -78,7 +93,7 @@ public void transform(TransformationContext ctx) {
                         .add(TEMPLATE_PATH, AnnotationValue.createStringValue("value", templatePath))
                         .done();
             }
-        });
+        }));
     }
 
     String slashify(String path) {
@@ -97,4 +112,10 @@ String slashify(String path) {
         }
         return '/' + path;
     }
+
+    private boolean notRequired(Capabilities capabilities,
+            Optional<MetricsCapabilityBuildItem> metricsCapability) {
+        return !(metricsCapability.isPresent() && metricsCapability.get().metricsSupported(MetricsFactory.MICROMETER))
+                && capabilities.isMissing(Capability.OPENTELEMETRY_TRACER);
+    }
 }
diff --git a/extensions/resteasy-observability/pom.xml b/extensions/resteasy-observability/pom.xml
@@ -17,7 +17,6 @@
     <packaging>pom</packaging>
 
     <modules>
-        <module>spi</module>
         <module>runtime</module>
         <module>deployment</module>
     </modules>

diff --git a/extensions/resteasy-observability/runtime/pom.xml b/extensions/resteasy-observability/runtime/pom.xml
@@ -25,6 +25,10 @@
             <groupId>io.quarkus</groupId>
             <artifactId>quarkus-arc</artifactId>
         </dependency>
+        <dependency>
+            <groupId>io.quarkus</groupId>
+            <artifactId>quarkus-vertx-http</artifactId>
+        </dependency>
 
     </dependencies>
 

diff --git a/...time/src/main/java/io/quarkus/resteasy/observability/runtime/QuarkusRestPathTemplate.java b/...time/src/main/java/io/quarkus/resteasy/observability/runtime/QuarkusRestPathTemplate.java
@@ -6,12 +6,14 @@
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
+import javax.enterprise.util.Nonbinding;
 import javax.interceptor.InterceptorBinding;
 
 @Inherited
 @InterceptorBinding
 @Target({ ElementType.ANNOTATION_TYPE, ElementType.TYPE, ElementType.METHOD })
 @Retention(RetentionPolicy.RUNTIME)
 public @interface QuarkusRestPathTemplate {
+    @Nonbinding
     String value() default "";
 }
diff --git a/...in/java/io/quarkus/resteasy/observability/runtime/QuarkusRestPathTemplateInterceptor.java b/...in/java/io/quarkus/resteasy/observability/runtime/QuarkusRestPathTemplateInterceptor.java
@@ -11,6 +11,7 @@
 import org.jboss.logging.Logger;
 
 import io.quarkus.arc.ArcInvocationContext;
+import io.vertx.core.Vertx;
 
 @SuppressWarnings("unused")
 @QuarkusRestPathTemplate
@@ -22,21 +23,22 @@ public class QuarkusRestPathTemplateInterceptor {
     @AroundInvoke
     Object restMethodInvoke(InvocationContext context) throws Exception {
         QuarkusRestPathTemplate annotation = getAnnotation(context);
-        log.infof("QuarkusRestPathTemplate annotated method invoked with %s", annotation);
+        log.debugf("QuarkusRestPathTemplate annotated method invoked with %s", annotation);
 
         if (annotation != null) {
-
+            Vertx.currentContext().putLocal("UrlPathTemplate", annotation.value());
         }
         return context.proceed();
     }
 
+    @SuppressWarnings("unchecked")
     static QuarkusRestPathTemplate getAnnotation(InvocationContext context) {
         Set<Annotation> annotations = (Set<Annotation>) context.getContextData()
                 .get(ArcInvocationContext.KEY_INTERCEPTOR_BINDINGS);
 
         for (Annotation a : annotations) {
-            if (QuarkusRestPathTemplate.class.isInstance(a)) {
-                return QuarkusRestPathTemplate.class.cast(a);
+            if (a instanceof QuarkusRestPathTemplate) {
+                return (QuarkusRestPathTemplate) a;
             }
         }
         return null;

diff --git a/extensions/resteasy-observability/spi/pom.xml b/extensions/resteasy-observability/spi/pom.xml
diff --git a/extensions/resteasy-reactive/quarkus-resteasy-reactive-common/deployment/pom.xml b/extensions/resteasy-reactive/quarkus-resteasy-reactive-common/deployment/pom.xml
@@ -45,6 +45,10 @@
             <groupId>io.quarkus</groupId>
             <artifactId>quarkus-jsonp-deployment</artifactId>
         </dependency>
+        <dependency>
+            <groupId>io.quarkus</groupId>
+            <artifactId>quarkus-resteasy-observability-deployment</artifactId>
+        </dependency>
     </dependencies>
 
     <build>

diff --git a/extensions/resteasy-reactive/quarkus-resteasy-reactive-common/runtime/pom.xml b/extensions/resteasy-reactive/quarkus-resteasy-reactive-common/runtime/pom.xml
@@ -34,6 +34,10 @@
             <groupId>io.quarkus</groupId>
             <artifactId>quarkus-jsonp</artifactId>
         </dependency>
+        <dependency>
+            <groupId>io.quarkus</groupId>
+            <artifactId>quarkus-resteasy-observability</artifactId>
+        </dependency>
         <dependency>
             <groupId>org.junit.jupiter</groupId>
             <artifactId>junit-jupiter</artifactId>

diff --git a/extensions/resteasy-reactive/quarkus-resteasy-reactive/deployment/pom.xml b/extensions/resteasy-reactive/quarkus-resteasy-reactive/deployment/pom.xml
@@ -49,10 +49,6 @@
             <groupId>io.quarkus</groupId>
             <artifactId>quarkus-resteasy-reactive-common-deployment</artifactId>
         </dependency>
-        <dependency>
-            <groupId>io.quarkus</groupId>
-            <artifactId>quarkus-resteasy-observability-spi</artifactId>
-        </dependency>
         <dependency>
             <groupId>io.quarkus</groupId>
             <artifactId>quarkus-security-deployment</artifactId>

diff --git a/...c/main/java/io/quarkus/resteasy/reactive/server/deployment/ResteasyReactiveProcessor.java b/...c/main/java/io/quarkus/resteasy/reactive/server/deployment/ResteasyReactiveProcessor.java
@@ -90,7 +90,7 @@
 import io.quarkus.gizmo.ClassCreator;
 import io.quarkus.gizmo.MethodCreator;
 import io.quarkus.netty.deployment.MinNettyAllocatorMaxOrderBuildItem;
-import io.quarkus.resteasy.observability.spi.RestApplicationPathBuildItem;
+import io.quarkus.resteasy.observability.deployment.RestApplicationPathBuildItem;
 import io.quarkus.resteasy.reactive.common.deployment.ApplicationResultBuildItem;
 import io.quarkus.resteasy.reactive.common.deployment.FactoryUtils;
 import io.quarkus.resteasy.reactive.common.deployment.QuarkusFactoryCreator;