jlengrand/quarkus
1
0
Fork 0
mirror of https://github.com/jlengrand/quarkus.git synced 2026-03-10 08:41:22 +00:00
Code Issues Packages Projects Releases Wiki Activity

Remove Undertow dependency from Opentracing

Browse Source 
Fixes #5419
This commit is contained in:
Stuart Douglas
2019-11-18 15:11:10 +11:00
parent f1fd426883
commit 507ee79be7
6 changed files with 127 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
extensions/smallrye-opentracing/deployment/pom.xml
View File

@@ -22,10 +22,6 @@
<groupId>io.quarkus</groupId>
<artifactId>quarkus-resteasy-deployment</artifactId>
</dependency>
<dependency>
<groupId>io.quarkus</groupId>
<artifactId>quarkus-undertow-deployment</artifactId>
</dependency>
<dependency>
<groupId>io.quarkus</groupId>
<artifactId>quarkus-arc-deployment</artifactId>

29
extensions/smallrye-opentracing/deployment/src/main/java/io/quarkus/smallrye/opentracing/deployment/SmallRyeOpenTracingProcessor.java
View File

@@ -8,12 +8,14 @@ import javax.servlet.DispatcherType;
import io.opentracing.contrib.interceptors.OpenTracingInterceptor;
import io.opentracing.contrib.jaxrs2.server.SpanFinishingFilter;
import io.quarkus.arc.deployment.AdditionalBeanBuildItem;
import io.quarkus.deployment.Capabilities;
import io.quarkus.deployment.annotations.BuildProducer;
import io.quarkus.deployment.annotations.BuildStep;
import io.quarkus.deployment.builditem.FeatureBuildItem;
import io.quarkus.deployment.builditem.nativeimage.ReflectiveMethodBuildItem;
import io.quarkus.resteasy.common.spi.ResteasyJaxrsProviderBuildItem;
import io.quarkus.smallrye.opentracing.runtime.QuarkusSmallRyeTracingDynamicFeature;
import io.quarkus.smallrye.opentracing.runtime.QuarkusSmallRyeTracingStandaloneVertxDynamicFeature;
import io.quarkus.smallrye.opentracing.runtime.TracerProducer;
import io.quarkus.undertow.deployment.FilterBuildItem;
@@ -33,21 +35,28 @@ public class SmallRyeOpenTracingProcessor {
@BuildStep
void setupFilter(BuildProducer<ResteasyJaxrsProviderBuildItem> providers,
BuildProducer<FilterBuildItem> filterProducer,
BuildProducer<FeatureBuildItem> feature) {
BuildProducer<FeatureBuildItem> feature,
Capabilities capabilities) {
feature.produce(new FeatureBuildItem(FeatureBuildItem.SMALLRYE_OPENTRACING));
providers.produce(new ResteasyJaxrsProviderBuildItem(QuarkusSmallRyeTracingDynamicFeature.class.getName()));
FilterBuildItem filterInfo = FilterBuildItem.builder("tracingFilter", SpanFinishingFilter.class.getName())
.setAsyncSupported(true)
.addFilterUrlMapping("*", DispatcherType.FORWARD)
.addFilterUrlMapping("*", DispatcherType.INCLUDE)
.addFilterUrlMapping("*", DispatcherType.REQUEST)
.addFilterUrlMapping("*", DispatcherType.ASYNC)
.addFilterUrlMapping("*", DispatcherType.ERROR)
.build();
filterProducer.produce(filterInfo);
if (capabilities.isCapabilityPresent(Capabilities.SERVLET)) {
FilterBuildItem filterInfo = FilterBuildItem.builder("tracingFilter", SpanFinishingFilter.class.getName())
.setAsyncSupported(true)
.addFilterUrlMapping("*", DispatcherType.FORWARD)
.addFilterUrlMapping("*", DispatcherType.INCLUDE)
.addFilterUrlMapping("*", DispatcherType.REQUEST)
.addFilterUrlMapping("*", DispatcherType.ASYNC)
.addFilterUrlMapping("*", DispatcherType.ERROR)
.build();
filterProducer.produce(filterInfo);
} else {
//otherwise we know we have RESTeasy on vert.x
providers.produce(
new ResteasyJaxrsProviderBuildItem(QuarkusSmallRyeTracingStandaloneVertxDynamicFeature.class.getName()));
}
}
}

13
extensions/smallrye-opentracing/deployment/src/test/java/io/quarkus/smallrye/opentracing/deployment/TracerRegistrar.java
View File

@@ -1,16 +1,15 @@
package io.quarkus.smallrye.opentracing.deployment;
import javax.servlet.ServletContextEvent;
import javax.servlet.ServletContextListener;
import javax.servlet.annotation.WebListener;
import javax.enterprise.context.ApplicationScoped;
import javax.enterprise.event.Observes;
import io.opentracing.util.GlobalTracer;
import io.quarkus.runtime.StartupEvent;
@WebListener
public class TracerRegistrar implements ServletContextListener {
@ApplicationScoped
public class TracerRegistrar {
@Override
public void contextInitialized(ServletContextEvent sce) {
public void start(@Observes StartupEvent start) {
GlobalTracer.register(TracingTest.mockTracer);
}
}

31
extensions/smallrye-opentracing/deployment/src/test/java/io/quarkus/smallrye/opentracing/deployment/TracingTest.java
View File

@@ -1,7 +1,9 @@
package io.quarkus.smallrye.opentracing.deployment;
import java.util.List;
import java.util.Set;
import java.util.concurrent.TimeUnit;
import java.util.stream.Collectors;
import org.awaitility.Awaitility;
import org.jboss.shrinkwrap.api.ShrinkWrap;
@@ -46,13 +48,15 @@ public class TracingTest {
}
@Test
public void testSingleServerRequest() {
public void testSingleServerRequest() throws InterruptedException {
try {
RestAssured.defaultParser = Parser.TEXT;
RestAssured.when().get("/hello")
.then()
.statusCode(200);
Assertions.assertEquals(1, mockTracer.finishedSpans().size());
//inherently racy, tracer is completed after response is sent back to the client
Awaitility.await().atMost(5, TimeUnit.SECONDS)
.until(() -> mockTracer.finishedSpans().size() == 1);
Assertions.assertEquals("GET:io.quarkus.smallrye.opentracing.deployment.TestResource.hello",
mockTracer.finishedSpans().get(0).operationName());
} finally {
@@ -61,12 +65,15 @@ public class TracingTest {
}
@Test
public void testCDI() {
public void testCDI() throws InterruptedException {
try {
RestAssured.defaultParser = Parser.TEXT;
RestAssured.when().get("/cdi")
.then()
.statusCode(200);
//inherently racy, tracer is completed after response is sent back to the client
Awaitility.await().atMost(5, TimeUnit.SECONDS)
.until(() -> mockTracer.finishedSpans().size() == 2);
Assertions.assertEquals(2, mockTracer.finishedSpans().size());
Assertions.assertEquals("io.quarkus.smallrye.opentracing.deployment.Service.foo",
mockTracer.finishedSpans().get(0).operationName());
@@ -78,18 +85,24 @@ public class TracingTest {
}
@Test
public void testMPRestClient() {
public void testMPRestClient() throws InterruptedException {
try {
RestAssured.defaultParser = Parser.TEXT;
RestAssured.when().get("/restClient")
.then()
.statusCode(200);
//inherently racy, tracer is completed after response is sent back to the client
Awaitility.await().atMost(5, TimeUnit.SECONDS)
.until(() -> mockTracer.finishedSpans().size() == 3);
Assertions.assertEquals(3, mockTracer.finishedSpans().size());
Assertions.assertEquals("GET:io.quarkus.smallrye.opentracing.deployment.TestResource.hello",
mockTracer.finishedSpans().get(0).operationName());
Assertions.assertEquals("GET", mockTracer.finishedSpans().get(1).operationName());
Assertions.assertEquals("GET:io.quarkus.smallrye.opentracing.deployment.TestResource.restClient",
mockTracer.finishedSpans().get(2).operationName());
//these can come in any order, as the 'hello' span is finished after the request is sent back.
//this means the client might have already dealt with the response before the hello span is finished
//in practice this means that the spans might be in any order, as they are ordered by the time
//they are completed rather than the time they are started
Set<String> results = mockTracer.finishedSpans().stream().map(MockSpan::operationName).collect(Collectors.toSet());
Assertions.assertTrue(results.contains("GET:io.quarkus.smallrye.opentracing.deployment.TestResource.hello"));
Assertions.assertTrue(results.contains("GET"));
Assertions.assertTrue(results.contains("GET:io.quarkus.smallrye.opentracing.deployment.TestResource.restClient"));
} finally {
RestAssured.reset();
}

2
extensions/smallrye-opentracing/runtime/pom.xml
View File

@@ -46,7 +46,7 @@
</dependency>
<dependency>
<groupId>io.quarkus</groupId>
<artifactId>quarkus-undertow</artifactId>
<artifactId>quarkus-resteasy</artifactId>
</dependency>
<dependency>
<groupId>io.quarkus</groupId>

79
extensions/smallrye-opentracing/runtime/src/main/java/io/quarkus/smallrye/opentracing/runtime/QuarkusSmallRyeTracingStandaloneVertxDynamicFeature.java Normal file
View File

@@ -0,0 +1,79 @@
package io.quarkus.smallrye.opentracing.runtime;
import java.io.IOException;
import java.util.HashMap;
import java.util.Map;
import javax.enterprise.inject.spi.CDI;
import javax.ws.rs.container.ContainerRequestContext;
import javax.ws.rs.container.ContainerRequestFilter;
import javax.ws.rs.container.DynamicFeature;
import javax.ws.rs.container.ResourceInfo;
import javax.ws.rs.core.FeatureContext;
import javax.ws.rs.ext.Provider;
import io.opentracing.Span;
import io.opentracing.contrib.jaxrs2.internal.SpanWrapper;
import io.opentracing.tag.Tags;
import io.quarkus.vertx.http.runtime.CurrentVertxRequest;
import io.vertx.ext.web.RoutingContext;
@Provider
public class QuarkusSmallRyeTracingStandaloneVertxDynamicFeature implements DynamicFeature {
@Override
public void configure(ResourceInfo resourceInfo, FeatureContext context) {
context.register(StandaloneFilter.class);
}
public static class StandaloneFilter implements ContainerRequestFilter {
volatile CurrentVertxRequest currentVertxRequest;
CurrentVertxRequest request() {
if (currentVertxRequest == null) {
currentVertxRequest = CDI.current().select(CurrentVertxRequest.class).get();
}
return currentVertxRequest;
}
@Override
public void filter(ContainerRequestContext requestContext) throws IOException {
request().addRequestDoneListener(new CurrentVertxRequest.Listener() {
@Override
public void initialInvocationComplete(RoutingContext routingContext, boolean goingAsync) {
SpanWrapper wrapper = routingContext.get(SpanWrapper.PROPERTY_NAME);
if (wrapper != null) {
wrapper.getScope().close();
}
}
@Override
public void responseComplete(RoutingContext routingContext) {
SpanWrapper wrapper = routingContext.get(SpanWrapper.PROPERTY_NAME);
if (wrapper == null) {
return;
}
Tags.HTTP_STATUS.set(wrapper.get(), routingContext.response().getStatusCode());
if (routingContext.failure() != null) {
addExceptionLogs(wrapper.get(), routingContext.failure());
}
wrapper.finish();
}
});
}
private static void addExceptionLogs(Span span, Throwable throwable) {
Tags.ERROR.set(span, true);
if (throwable != null) {
Map<String, Object> errorLogs = new HashMap<>(2);
errorLogs.put("event", Tags.ERROR.getKey());
errorLogs.put("error.object", throwable);
span.log(errorLogs);
}
}
}
}