Split peer connection details different generic argument

This commit is contained in:
Tyler Benson 2019-04-09 11:12:41 -07:00
parent bf05984208
commit b343fe4551
20 changed files with 170 additions and 75 deletions

View File

@ -4,18 +4,21 @@ import datadog.trace.api.Config;
import datadog.trace.api.DDSpanTypes;
import io.opentracing.Span;
import io.opentracing.tag.Tags;
import java.net.URI;
import lombok.extern.slf4j.Slf4j;
public abstract class HttpServerDecorator<REQUEST, RESPONSE> extends ServerDecorator {
@Slf4j
public abstract class HttpServerDecorator<REQUEST, CONNECTION, RESPONSE> extends ServerDecorator {
protected abstract String method(REQUEST request);
protected abstract String url(REQUEST request);
protected abstract URI url(REQUEST request);
protected abstract String peerHostname(REQUEST request);
protected abstract String peerHostname(CONNECTION connection);
protected abstract String peerHostIP(REQUEST request);
protected abstract String peerHostIP(CONNECTION connection);
protected abstract Integer peerPort(REQUEST request);
protected abstract Integer peerPort(CONNECTION connection);
protected abstract Integer status(RESPONSE response);
@ -33,9 +36,37 @@ public abstract class HttpServerDecorator<REQUEST, RESPONSE> extends ServerDecor
assert span != null;
if (request != null) {
Tags.HTTP_METHOD.set(span, method(request));
Tags.HTTP_URL.set(span, url(request));
Tags.PEER_HOSTNAME.set(span, peerHostname(request));
final String ip = peerHostIP(request);
try {
final URI url = url(request);
final StringBuilder urlNoParams = new StringBuilder(url.getScheme());
urlNoParams.append("://");
urlNoParams.append(url.getHost());
if (url.getPort() > 0 && url.getPort() != 80 && url.getPort() != 443) {
urlNoParams.append(":");
urlNoParams.append(url.getPort());
}
final String path = url.getPath();
if (path.isEmpty()) {
urlNoParams.append("/");
} else {
urlNoParams.append(path);
}
Tags.HTTP_URL.set(span, urlNoParams.toString());
} catch (final Exception e) {
log.debug("Error tagging url", e);
}
// TODO set resource name from URL.
}
return span;
}
public Span onConnection(final Span span, final CONNECTION connection) {
assert span != null;
if (connection != null) {
Tags.PEER_HOSTNAME.set(span, peerHostname(connection));
final String ip = peerHostIP(connection);
if (ip != null) {
if (ip.contains(":")) {
Tags.PEER_HOST_IPV6.set(span, ip);
@ -43,8 +74,7 @@ public abstract class HttpServerDecorator<REQUEST, RESPONSE> extends ServerDecor
Tags.PEER_HOST_IPV4.set(span, ip);
}
}
Tags.PEER_PORT.set(span, peerPort(request));
// TODO set resource name from URL.
Tags.PEER_PORT.set(span, peerPort(connection));
}
return span;
}

View File

@ -1,11 +1,11 @@
package datadog.trace.agent.decorator
import static datadog.trace.agent.test.utils.TraceUtils.withConfigOverride
import datadog.trace.api.Config
import io.opentracing.Span
import io.opentracing.tag.Tags
import static datadog.trace.agent.test.utils.TraceUtils.withConfigOverride
class HttpServerDecoratorTest extends ServerDecoratorTest {
def span = Mock(Span)
@ -20,7 +20,29 @@ class HttpServerDecoratorTest extends ServerDecoratorTest {
then:
if (req) {
1 * span.setTag(Tags.HTTP_METHOD.key, "test-method")
1 * span.setTag(Tags.HTTP_URL.key, "test-url")
1 * span.setTag(Tags.HTTP_URL.key, url)
}
0 * _
where:
req | url
null | _
[method: "test-method", url: URI.create("http://test-url?some=query")] | "http://test-url/"
[method: "test-method", url: URI.create("http://a:80/")] | "http://a/"
[method: "test-method", url: URI.create("https://10.0.0.1:443")] | "https://10.0.0.1/"
[method: "test-method", url: URI.create("https://localhost:0/1/")] | "https://localhost/1/"
[method: "test-method", url: URI.create("http://123:8080/some/path")] | "http://123:8080/some/path"
}
def "test onConnection"() {
setup:
def decorator = newDecorator()
when:
decorator.onConnection(span, conn)
then:
if (conn) {
1 * span.setTag(Tags.PEER_HOSTNAME.key, "test-host")
1 * span.setTag(Tags.PEER_PORT.key, 555)
if (ipv4) {
@ -32,11 +54,11 @@ class HttpServerDecoratorTest extends ServerDecoratorTest {
0 * _
where:
ipv4 | req
ipv4 | conn
null | null
null | [method: "test-method", url: "test-url", host: "test-host", ip: null, port: 555]
true | [method: "test-method", url: "test-url", host: "test-host", ip: "10.0.0.1", port: 555]
false | [method: "test-method", url: "test-url", host: "test-host", ip: "3ffe:1900:4545:3:200:f8ff:fe21:67cf", port: 555]
null | [host: "test-host", ip: null, port: 555]
true | [host: "test-host", ip: "10.0.0.1", port: 555]
false | [host: "test-host", ip: "3ffe:1900:4545:3:200:f8ff:fe21:67cf", port: 555]
}
def "test onResponse"() {
@ -90,7 +112,7 @@ class HttpServerDecoratorTest extends ServerDecoratorTest {
@Override
def newDecorator() {
return new HttpServerDecorator<Map, Map>() {
return new HttpServerDecorator<Map, Map, Map>() {
@Override
protected String[] instrumentationNames() {
return ["test1", "test2"]
@ -107,7 +129,7 @@ class HttpServerDecoratorTest extends ServerDecoratorTest {
}
@Override
protected String url(Map m) {
protected URI url(Map m) {
return m.url
}

View File

@ -3,8 +3,10 @@ package datadog.trace.instrumentation.akkahttp;
import akka.http.scaladsl.model.HttpRequest;
import akka.http.scaladsl.model.HttpResponse;
import datadog.trace.agent.decorator.HttpServerDecorator;
import java.net.URI;
public class AkkaHttpServerDecorator extends HttpServerDecorator<HttpRequest, HttpResponse> {
public class AkkaHttpServerDecorator
extends HttpServerDecorator<HttpRequest, HttpRequest, HttpResponse> {
public static final AkkaHttpServerDecorator DECORATE = new AkkaHttpServerDecorator();
@Override
@ -23,8 +25,8 @@ public class AkkaHttpServerDecorator extends HttpServerDecorator<HttpRequest, Ht
}
@Override
protected String url(final HttpRequest httpRequest) {
return httpRequest.uri().toString();
protected URI url(final HttpRequest httpRequest) {
return URI.create(httpRequest.uri().toString());
}
@Override

View File

@ -108,6 +108,7 @@ public final class AkkaHttpServerInstrumentation extends Instrumenter.Default {
.startActive(false);
DECORATE.afterStart(scope.span());
DECORATE.onConnection(scope.span(), request);
DECORATE.onRequest(scope.span(), request);
if (scope instanceof TraceScope) {

View File

@ -2,10 +2,12 @@ package datadog.trace.instrumentation.jetty8;
import datadog.trace.agent.decorator.HttpServerDecorator;
import io.opentracing.Span;
import java.net.URI;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
public class JettyDecorator extends HttpServerDecorator<HttpServletRequest, HttpServletResponse> {
public class JettyDecorator
extends HttpServerDecorator<HttpServletRequest, HttpServletRequest, HttpServletResponse> {
public static final JettyDecorator DECORATE = new JettyDecorator();
@Override
@ -24,8 +26,8 @@ public class JettyDecorator extends HttpServerDecorator<HttpServletRequest, Http
}
@Override
protected String url(final HttpServletRequest httpServletRequest) {
return httpServletRequest.getRequestURL().toString();
protected URI url(final HttpServletRequest httpServletRequest) {
return URI.create(httpServletRequest.getRequestURL().toString());
}
@Override

View File

@ -36,10 +36,12 @@ public class JettyHandlerAdvice {
.withTag("span.origin.type", source.getClass().getName())
.startActive(false);
DECORATE.afterStart(scope.span());
DECORATE.onRequest(scope.span(), req);
final Span span = scope.span();
DECORATE.afterStart(span);
DECORATE.onConnection(span, req);
DECORATE.onRequest(span, req);
final String resourceName = req.getMethod() + " " + source.getClass().getName();
scope.span().setTag(DDTags.RESOURCE_NAME, resourceName);
span.setTag(DDTags.RESOURCE_NAME, resourceName);
if (scope instanceof TraceScope) {
((TraceScope) scope).setAsyncPropagation(true);

View File

@ -12,7 +12,6 @@ import io.opentracing.Span;
import io.opentracing.SpanContext;
import io.opentracing.propagation.Format;
import io.opentracing.util.GlobalTracer;
import java.net.InetSocketAddress;
public class HttpServerRequestTracingHandler extends ChannelInboundHandlerAdapter {
@ -23,7 +22,6 @@ public class HttpServerRequestTracingHandler extends ChannelInboundHandlerAdapte
return;
}
final HttpRequest request = (HttpRequest) msg;
final InetSocketAddress remoteAddress = (InetSocketAddress) ctx.channel().remoteAddress();
final SpanContext extractedContext =
GlobalTracer.get()
@ -33,8 +31,8 @@ public class HttpServerRequestTracingHandler extends ChannelInboundHandlerAdapte
GlobalTracer.get().buildSpan("netty.request").asChildOf(extractedContext).start();
try (final Scope scope = GlobalTracer.get().scopeManager().activate(span, false)) {
DECORATE.afterStart(span);
DECORATE.onConnection(span, ctx.channel());
DECORATE.onRequest(span, request);
DECORATE.onPeerConnection(span, remoteAddress);
if (scope instanceof TraceScope) {
((TraceScope) scope).setAsyncPropagation(true);

View File

@ -3,14 +3,18 @@ package datadog.trace.instrumentation.netty40.server;
import static io.netty.handler.codec.http.HttpHeaders.Names.HOST;
import datadog.trace.agent.decorator.HttpServerDecorator;
import io.netty.channel.Channel;
import io.netty.handler.codec.http.HttpRequest;
import io.netty.handler.codec.http.HttpResponse;
import java.net.InetSocketAddress;
import java.net.SocketAddress;
import java.net.URI;
import java.net.URISyntaxException;
import lombok.extern.slf4j.Slf4j;
@Slf4j
public class NettyHttpServerDecorator extends HttpServerDecorator<HttpRequest, HttpResponse> {
public class NettyHttpServerDecorator
extends HttpServerDecorator<HttpRequest, Channel, HttpResponse> {
public static final NettyHttpServerDecorator DECORATE = new NettyHttpServerDecorator();
@Override
@ -29,33 +33,45 @@ public class NettyHttpServerDecorator extends HttpServerDecorator<HttpRequest, H
}
@Override
protected String url(final HttpRequest request) {
protected URI url(final HttpRequest request) {
// FIXME: This code is duplicated across netty integrations.
try {
URI uri = new URI(request.getUri());
if ((uri.getHost() == null || uri.getHost().equals("")) && request.headers().contains(HOST)) {
uri = new URI("http://" + request.headers().get(HOST) + request.getUri());
}
return new URI(uri.getScheme(), null, uri.getHost(), uri.getPort(), uri.getPath(), null, null)
.toString();
return new URI(
uri.getScheme(), null, uri.getHost(), uri.getPort(), uri.getPath(), null, null);
} catch (final URISyntaxException e) {
log.debug("Cannot parse netty uri: {}", request.getUri());
return request.getUri();
return null;
}
}
@Override
protected String peerHostname(final HttpRequest httpRequest) {
protected String peerHostname(final Channel channel) {
final SocketAddress socketAddress = channel.remoteAddress();
if (socketAddress instanceof InetSocketAddress) {
return ((InetSocketAddress) socketAddress).getHostName();
}
return null;
}
@Override
protected String peerHostIP(final HttpRequest httpRequest) {
protected String peerHostIP(final Channel channel) {
final SocketAddress socketAddress = channel.remoteAddress();
if (socketAddress instanceof InetSocketAddress) {
return ((InetSocketAddress) socketAddress).getAddress().getHostAddress();
}
return null;
}
@Override
protected Integer peerPort(final HttpRequest httpRequest) {
protected Integer peerPort(final Channel channel) {
final SocketAddress socketAddress = channel.remoteAddress();
if (socketAddress instanceof InetSocketAddress) {
return ((InetSocketAddress) socketAddress).getPort();
}
return null;
}

View File

@ -12,7 +12,6 @@ import io.opentracing.Span;
import io.opentracing.SpanContext;
import io.opentracing.propagation.Format;
import io.opentracing.util.GlobalTracer;
import java.net.InetSocketAddress;
public class HttpServerRequestTracingHandler extends ChannelInboundHandlerAdapter {
@ -23,7 +22,6 @@ public class HttpServerRequestTracingHandler extends ChannelInboundHandlerAdapte
return;
}
final HttpRequest request = (HttpRequest) msg;
final InetSocketAddress remoteAddress = (InetSocketAddress) ctx.channel().remoteAddress();
final SpanContext extractedContext =
GlobalTracer.get()
@ -33,8 +31,8 @@ public class HttpServerRequestTracingHandler extends ChannelInboundHandlerAdapte
GlobalTracer.get().buildSpan("netty.request").asChildOf(extractedContext).start();
try (final Scope scope = GlobalTracer.get().scopeManager().activate(span, false)) {
DECORATE.afterStart(span);
DECORATE.onConnection(span, ctx.channel());
DECORATE.onRequest(span, request);
DECORATE.onPeerConnection(span, remoteAddress);
if (scope instanceof TraceScope) {
((TraceScope) scope).setAsyncPropagation(true);

View File

@ -3,14 +3,18 @@ package datadog.trace.instrumentation.netty41.server;
import static io.netty.handler.codec.http.HttpHeaderNames.HOST;
import datadog.trace.agent.decorator.HttpServerDecorator;
import io.netty.channel.Channel;
import io.netty.handler.codec.http.HttpRequest;
import io.netty.handler.codec.http.HttpResponse;
import java.net.InetSocketAddress;
import java.net.SocketAddress;
import java.net.URI;
import java.net.URISyntaxException;
import lombok.extern.slf4j.Slf4j;
@Slf4j
public class NettyHttpServerDecorator extends HttpServerDecorator<HttpRequest, HttpResponse> {
public class NettyHttpServerDecorator
extends HttpServerDecorator<HttpRequest, Channel, HttpResponse> {
public static final NettyHttpServerDecorator DECORATE = new NettyHttpServerDecorator();
@Override
@ -29,33 +33,45 @@ public class NettyHttpServerDecorator extends HttpServerDecorator<HttpRequest, H
}
@Override
protected String url(final HttpRequest request) {
protected URI url(final HttpRequest request) {
// FIXME: This code is duplicated across netty integrations.
try {
URI uri = new URI(request.uri());
if ((uri.getHost() == null || uri.getHost().equals("")) && request.headers().contains(HOST)) {
uri = new URI("http://" + request.headers().get(HOST) + request.uri());
uri = new URI("http://" + request.headers().get(HOST) + request.getUri());
}
return new URI(uri.getScheme(), null, uri.getHost(), uri.getPort(), uri.getPath(), null, null)
.toString();
return new URI(
uri.getScheme(), null, uri.getHost(), uri.getPort(), uri.getPath(), null, null);
} catch (final URISyntaxException e) {
log.debug("Cannot parse netty uri: {}", request.uri());
return request.uri();
return null;
}
}
@Override
protected String peerHostname(final HttpRequest httpRequest) {
protected String peerHostname(final Channel channel) {
final SocketAddress socketAddress = channel.remoteAddress();
if (socketAddress instanceof InetSocketAddress) {
return ((InetSocketAddress) socketAddress).getHostName();
}
return null;
}
@Override
protected String peerHostIP(final HttpRequest httpRequest) {
protected String peerHostIP(final Channel channel) {
final SocketAddress socketAddress = channel.remoteAddress();
if (socketAddress instanceof InetSocketAddress) {
return ((InetSocketAddress) socketAddress).getAddress().getHostAddress();
}
return null;
}
@Override
protected Integer peerPort(final HttpRequest httpRequest) {
protected Integer peerPort(final Channel channel) {
final SocketAddress socketAddress = channel.remoteAddress();
if (socketAddress instanceof InetSocketAddress) {
return ((InetSocketAddress) socketAddress).getPort();
}
return null;
}

View File

@ -76,6 +76,7 @@ class Play26Test extends AgentTestRunner {
"http.status_code" status
"http.url" "http://localhost:$port/$path"
"http.method" "GET"
"peer.ipv4" "127.0.0.1"
"span.kind" "server"
"component" "play-action"
if (isError) {

View File

@ -12,7 +12,7 @@ import play.api.mvc.Result;
import scala.Option;
@Slf4j
public class PlayHttpServerDecorator extends HttpServerDecorator<Request, Result> {
public class PlayHttpServerDecorator extends HttpServerDecorator<Request, Request, Result> {
public static final PlayHttpServerDecorator DECORATE = new PlayHttpServerDecorator();
@Override
@ -31,18 +31,18 @@ public class PlayHttpServerDecorator extends HttpServerDecorator<Request, Result
}
@Override
protected String url(final Request request) {
protected URI url(final Request request) {
// FIXME: This code is similar to that from the netty integrations.
try {
URI uri = new URI(request.uri());
if ((uri.getHost() == null || uri.getHost().equals("")) && !request.host().isEmpty()) {
uri = new URI("http://" + request.host() + request.uri());
}
return new URI(uri.getScheme(), null, uri.getHost(), uri.getPort(), uri.getPath(), null, null)
.toString();
return new URI(
uri.getScheme(), null, uri.getHost(), uri.getPort(), uri.getPath(), null, null);
} catch (final URISyntaxException e) {
log.debug("Cannot parse uri: {}", request.uri());
return request.uri();
return null;
}
}
@ -53,7 +53,7 @@ public class PlayHttpServerDecorator extends HttpServerDecorator<Request, Result
@Override
protected String peerHostIP(final Request request) {
return null;
return request.remoteAddress();
}
@Override

View File

@ -91,6 +91,7 @@ public final class PlayInstrumentation extends Instrumenter.Default {
scope = GlobalTracer.get().buildSpan("play.request").startActive(false);
}
DECORATE.afterStart(scope);
DECORATE.onConnection(scope.span(), req);
if (GlobalTracer.get().scopeManager().active() instanceof TraceScope) {
((TraceScope) GlobalTracer.get().scopeManager().active()).setAsyncPropagation(true);

View File

@ -57,6 +57,7 @@ class Play24Test extends AgentTestRunner {
"http.status_code" status
"http.url" "http://localhost:$port/$path"
"http.method" "GET"
"peer.ipv4" "127.0.0.1"
"span.kind" "server"
"component" "play-action"
if (isError) {

View File

@ -39,8 +39,10 @@ public class Servlet2Advice {
.withTag("span.origin.type", servlet.getClass().getName())
.startActive(true);
DECORATE.afterStart(scope.span());
DECORATE.onRequest(scope.span(), httpServletRequest);
final Span span = scope.span();
DECORATE.afterStart(span);
DECORATE.onConnection(span, httpServletRequest);
DECORATE.onRequest(span, httpServletRequest);
if (scope instanceof TraceScope) {
((TraceScope) scope).setAsyncPropagation(true);

View File

@ -2,10 +2,12 @@ package datadog.trace.instrumentation.servlet2;
import datadog.trace.agent.decorator.HttpServerDecorator;
import io.opentracing.Span;
import java.net.URI;
import javax.servlet.ServletResponse;
import javax.servlet.http.HttpServletRequest;
public class Servlet2Decorator extends HttpServerDecorator<HttpServletRequest, ServletResponse> {
public class Servlet2Decorator
extends HttpServerDecorator<HttpServletRequest, HttpServletRequest, ServletResponse> {
public static final Servlet2Decorator DECORATE = new Servlet2Decorator();
@Override
@ -24,8 +26,8 @@ public class Servlet2Decorator extends HttpServerDecorator<HttpServletRequest, S
}
@Override
protected String url(final HttpServletRequest httpServletRequest) {
return httpServletRequest.getRequestURL().toString();
protected URI url(final HttpServletRequest httpServletRequest) {
return URI.create(httpServletRequest.getRequestURL().toString());
}
@Override
@ -40,7 +42,7 @@ public class Servlet2Decorator extends HttpServerDecorator<HttpServletRequest, S
@Override
protected Integer peerPort(final HttpServletRequest httpServletRequest) {
return httpServletRequest.getServerPort();
return null;
}
@Override

View File

@ -93,7 +93,6 @@ class JettyServlet2Test extends AgentTestRunner {
"component" "java-web-servlet"
"peer.hostname" "127.0.0.1"
"peer.ipv4" "127.0.0.1"
"peer.port" Integer
"span.origin.type" "TestServlet2\$Sync"
"servlet.context" "/ctx"
if (auth) {
@ -140,7 +139,6 @@ class JettyServlet2Test extends AgentTestRunner {
"component" "java-web-servlet"
"peer.hostname" "127.0.0.1"
"peer.ipv4" "127.0.0.1"
"peer.port" Integer
"span.origin.type" "TestServlet2\$Sync"
"servlet.context" "/ctx"
errorTags(RuntimeException, "some $path error")
@ -183,7 +181,6 @@ class JettyServlet2Test extends AgentTestRunner {
"component" "java-web-servlet"
"peer.hostname" "127.0.0.1"
"peer.ipv4" "127.0.0.1"
"peer.port" Integer
"span.origin.type" "TestServlet2\$Sync"
"servlet.context" "/ctx"
defaultTags()

View File

@ -44,14 +44,16 @@ public class Servlet3Advice {
.withTag("span.origin.type", servlet.getClass().getName())
.startActive(false);
DECORATE.afterStart(scope.span());
DECORATE.onRequest(scope.span(), httpServletRequest);
final Span span = scope.span();
DECORATE.afterStart(span);
DECORATE.onConnection(span, httpServletRequest);
DECORATE.onRequest(span, httpServletRequest);
if (scope instanceof TraceScope) {
((TraceScope) scope).setAsyncPropagation(true);
}
req.setAttribute(SERVLET_SPAN, scope.span());
req.setAttribute(SERVLET_SPAN, span);
return scope;
}

View File

@ -2,11 +2,12 @@ package datadog.trace.instrumentation.servlet3;
import datadog.trace.agent.decorator.HttpServerDecorator;
import io.opentracing.Span;
import java.net.URI;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
public class Servlet3Decorator
extends HttpServerDecorator<HttpServletRequest, HttpServletResponse> {
extends HttpServerDecorator<HttpServletRequest, HttpServletRequest, HttpServletResponse> {
public static final Servlet3Decorator DECORATE = new Servlet3Decorator();
@Override
@ -25,8 +26,8 @@ public class Servlet3Decorator
}
@Override
protected String url(final HttpServletRequest httpServletRequest) {
return httpServletRequest.getRequestURL().toString();
protected URI url(final HttpServletRequest httpServletRequest) {
return URI.create(httpServletRequest.getRequestURL().toString());
}
@Override

View File

@ -5,6 +5,7 @@ import datadog.trace.api.DDSpanTypes;
import datadog.trace.api.DDTags;
import io.opentracing.Scope;
import io.opentracing.Span;
import java.net.URI;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import lombok.extern.slf4j.Slf4j;
@ -13,7 +14,7 @@ import org.springframework.web.servlet.ModelAndView;
@Slf4j
public class SpringWebHttpServerDecorator
extends HttpServerDecorator<HttpServletRequest, HttpServletResponse> {
extends HttpServerDecorator<HttpServletRequest, HttpServletRequest, HttpServletResponse> {
public static final SpringWebHttpServerDecorator DECORATE = new SpringWebHttpServerDecorator();
public static final SpringWebHttpServerDecorator DECORATE_RENDER =
new SpringWebHttpServerDecorator() {
@ -39,8 +40,8 @@ public class SpringWebHttpServerDecorator
}
@Override
protected String url(final HttpServletRequest httpServletRequest) {
return httpServletRequest.getRequestURL().toString();
protected URI url(final HttpServletRequest httpServletRequest) {
return URI.create(httpServletRequest.getRequestURL().toString());
}
@Override