From ee9e0626df84eb2645a9cb261f503af34d7a0e3f Mon Sep 17 00:00:00 2001 From: renaudboutet Date: Wed, 24 May 2017 13:31:24 +0200 Subject: [PATCH] First version of the agent documentation --- dd-java-agent/src/main/resources/dd-trace.yaml | 18 +++++++----------- .../src/{main => test}/resources/logback.xml | 0 .../src/main/resources/otarules.btm | 0 .../{DBServiceDecorator.java => DB.java} | 6 +++--- .../{HTTPServiceDecorator.java => HTTP.java} | 6 +++--- .../trace/resolver/DDTracerResolver.java | 12 ++++++------ dd-trace/src/main/resources/dd-trace.yaml | 5 ++--- dd-trace/src/main/resources/logback.xml | 16 ---------------- .../trace/resolver/TracerResolverTest.java | 6 +++--- dd-trace/src/test/resources/dd-trace.yaml | 2 +- dd-trace/src/test/resources/logback.xml | 2 +- 11 files changed, 26 insertions(+), 47 deletions(-) rename dd-java-agent/src/{main => test}/resources/logback.xml (100%) delete mode 100644 dd-trace-examples/dropwizard-mongo-client/src/main/resources/otarules.btm rename dd-trace/src/main/java/com/datadoghq/trace/integration/{DBServiceDecorator.java => DB.java} (85%) rename dd-trace/src/main/java/com/datadoghq/trace/integration/{HTTPServiceDecorator.java => HTTP.java} (87%) delete mode 100644 dd-trace/src/main/resources/logback.xml diff --git a/dd-java-agent/src/main/resources/dd-trace.yaml b/dd-java-agent/src/main/resources/dd-trace.yaml index 0f35229cb3..93491b0a85 100644 --- a/dd-java-agent/src/main/resources/dd-trace.yaml +++ b/dd-java-agent/src/main/resources/dd-trace.yaml @@ -23,21 +23,17 @@ sampler: # Decorators are used to add extra information to span # Could be DBServiceDecorator, MapperDecorator or HTTPServiceDecorator decorators: - # This span decorator leverages HTTP tags such as the URL requested - - type: HTTPServiceDecorator + - type: HTTP componentName: java-web-servlet - - # Decorator fot the HTTP client - - type: HTTPServiceDecorator + - type: HTTP componentName: java-okhttp desiredServiceName: http-client - - # This span decorator leverages DB tags such as the statement requested - - type: DBServiceDecorator + - type: DB componentName: java-mongo desiredServiceName: mongo - - # Decorator for the AWS SDK client - - type: HTTPServiceDecorator + - type: DB + componentName: java-jdbc + desiredServiceName: jdbc + - type: HTTP componentName: java-aws-sdk desiredServiceName: aws-client \ No newline at end of file diff --git a/dd-java-agent/src/main/resources/logback.xml b/dd-java-agent/src/test/resources/logback.xml similarity index 100% rename from dd-java-agent/src/main/resources/logback.xml rename to dd-java-agent/src/test/resources/logback.xml diff --git a/dd-trace-examples/dropwizard-mongo-client/src/main/resources/otarules.btm b/dd-trace-examples/dropwizard-mongo-client/src/main/resources/otarules.btm deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/dd-trace/src/main/java/com/datadoghq/trace/integration/DBServiceDecorator.java b/dd-trace/src/main/java/com/datadoghq/trace/integration/DB.java similarity index 85% rename from dd-trace/src/main/java/com/datadoghq/trace/integration/DBServiceDecorator.java rename to dd-trace/src/main/java/com/datadoghq/trace/integration/DB.java index 28d32b50ea..d0feba5287 100644 --- a/dd-trace/src/main/java/com/datadoghq/trace/integration/DBServiceDecorator.java +++ b/dd-trace/src/main/java/com/datadoghq/trace/integration/DB.java @@ -8,18 +8,18 @@ import io.opentracing.tag.Tags; * This span decorator leverages DB tags. It allows the dev to define a custom * service name and retrieves some DB meta such as the statement */ -public class DBServiceDecorator implements DDSpanContextDecorator { +public class DB implements DDSpanContextDecorator { protected final String componentName; protected final String desiredServiceName; - public DBServiceDecorator(String componentName) { + public DB(String componentName) { super(); this.componentName = componentName; this.desiredServiceName = null; } - public DBServiceDecorator(String componentName,String desiredServiceName) { + public DB(String componentName,String desiredServiceName) { super(); this.componentName = componentName; this.desiredServiceName = desiredServiceName; diff --git a/dd-trace/src/main/java/com/datadoghq/trace/integration/HTTPServiceDecorator.java b/dd-trace/src/main/java/com/datadoghq/trace/integration/HTTP.java similarity index 87% rename from dd-trace/src/main/java/com/datadoghq/trace/integration/HTTPServiceDecorator.java rename to dd-trace/src/main/java/com/datadoghq/trace/integration/HTTP.java index a76013f6e0..d7993de1d2 100644 --- a/dd-trace/src/main/java/com/datadoghq/trace/integration/HTTPServiceDecorator.java +++ b/dd-trace/src/main/java/com/datadoghq/trace/integration/HTTP.java @@ -12,18 +12,18 @@ import io.opentracing.tag.Tags; * This span decorator leverages HTTP tags. It allows the dev to define a custom * service name and retrieves some HTTP meta such as the request path */ -public class HTTPServiceDecorator implements DDSpanContextDecorator { +public class HTTP implements DDSpanContextDecorator { protected final String componentName; protected final String desiredServiceName; - public HTTPServiceDecorator(String componentName) { + public HTTP(String componentName) { super(); this.componentName = componentName; this.desiredServiceName = null; } - public HTTPServiceDecorator(String componentName,String desiredServiceName) { + public HTTP(String componentName,String desiredServiceName) { super(); this.componentName = componentName; this.desiredServiceName = desiredServiceName; diff --git a/dd-trace/src/main/java/com/datadoghq/trace/resolver/DDTracerResolver.java b/dd-trace/src/main/java/com/datadoghq/trace/resolver/DDTracerResolver.java index 095c067586..5ef40132d2 100644 --- a/dd-trace/src/main/java/com/datadoghq/trace/resolver/DDTracerResolver.java +++ b/dd-trace/src/main/java/com/datadoghq/trace/resolver/DDTracerResolver.java @@ -10,9 +10,9 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; import com.datadoghq.trace.DDTracer; -import com.datadoghq.trace.integration.DBServiceDecorator; +import com.datadoghq.trace.integration.DB; import com.datadoghq.trace.integration.DDSpanContextDecorator; -import com.datadoghq.trace.integration.HTTPServiceDecorator; +import com.datadoghq.trace.integration.HTTP; import com.datadoghq.trace.sampling.AllSampler; import com.datadoghq.trace.sampling.RateSampler; import com.datadoghq.trace.sampling.Sampler; @@ -88,11 +88,11 @@ public class DDTracerResolver extends TracerResolver { String componentName = (String) map.get("componentName"); String desiredServiceName = (String) map.get("desiredServiceName"); - if (map.get("type").equals(HTTPServiceDecorator.class.getSimpleName())) { - decorator = new HTTPServiceDecorator(componentName, desiredServiceName); + if (map.get("type").equals(HTTP.class.getSimpleName())) { + decorator = new HTTP(componentName, desiredServiceName); tracer.addDecorator(decorator); - } else if (map.get("type").equals(DBServiceDecorator.class.getSimpleName())) { - decorator = new DBServiceDecorator(componentName, desiredServiceName); + } else if (map.get("type").equals(DB.class.getSimpleName())) { + decorator = new DB(componentName, desiredServiceName); tracer.addDecorator(decorator); } } diff --git a/dd-trace/src/main/resources/dd-trace.yaml b/dd-trace/src/main/resources/dd-trace.yaml index b2bc57f602..7eb1bb7d44 100644 --- a/dd-trace/src/main/resources/dd-trace.yaml +++ b/dd-trace/src/main/resources/dd-trace.yaml @@ -24,11 +24,10 @@ sampler: # Could be DBServiceDecorator, MapperDecorator or HTTPServiceDecorator decorators: # This span decorator leverages HTTP tags such as the URL requested - - type: HTTPServiceDecorator + - type: HTTP componentName: http desiredServiceName: unnamed-java-http - # This span decorator leverages DB tags such as the statement requested - - type: DBServiceDecorator + - type: DB componentName: db desiredServiceName: unnamed-java-db diff --git a/dd-trace/src/main/resources/logback.xml b/dd-trace/src/main/resources/logback.xml deleted file mode 100644 index 607d3e615d..0000000000 --- a/dd-trace/src/main/resources/logback.xml +++ /dev/null @@ -1,16 +0,0 @@ - - - - - - - %d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n - - - - - - - - - \ No newline at end of file diff --git a/dd-trace/src/test/java/com/datadoghq/trace/resolver/TracerResolverTest.java b/dd-trace/src/test/java/com/datadoghq/trace/resolver/TracerResolverTest.java index aa97c239cf..d408b2c110 100644 --- a/dd-trace/src/test/java/com/datadoghq/trace/resolver/TracerResolverTest.java +++ b/dd-trace/src/test/java/com/datadoghq/trace/resolver/TracerResolverTest.java @@ -8,7 +8,7 @@ import org.junit.Test; import com.datadoghq.trace.DDTracer; import com.datadoghq.trace.integration.DDSpanContextDecorator; -import com.datadoghq.trace.integration.HTTPServiceDecorator; +import com.datadoghq.trace.integration.HTTP; public class TracerResolverTest { @@ -21,8 +21,8 @@ public class TracerResolverTest { assertThat(decorators.size()).isEqualTo(1); DDSpanContextDecorator decorator = decorators.get(0); - assertThat(decorator.getClass()).isEqualTo(HTTPServiceDecorator.class); - HTTPServiceDecorator httpServiceDecorator = (HTTPServiceDecorator) decorator; + assertThat(decorator.getClass()).isEqualTo(HTTP.class); + HTTP httpServiceDecorator = (HTTP) decorator; assertThat(httpServiceDecorator.getComponentName()).isEqualTo("hello"); assertThat(httpServiceDecorator.getDesiredServiceName()).isEqualTo("world"); } diff --git a/dd-trace/src/test/resources/dd-trace.yaml b/dd-trace/src/test/resources/dd-trace.yaml index 050cf94c09..c6cb503cfc 100644 --- a/dd-trace/src/test/resources/dd-trace.yaml +++ b/dd-trace/src/test/resources/dd-trace.yaml @@ -6,7 +6,7 @@ writer: sampler: type: AllSampler decorators: - - type: HTTPServiceDecorator + - type: HTTP componentName: hello desiredServiceName: world diff --git a/dd-trace/src/test/resources/logback.xml b/dd-trace/src/test/resources/logback.xml index f8fbe556c0..607d3e615d 100644 --- a/dd-trace/src/test/resources/logback.xml +++ b/dd-trace/src/test/resources/logback.xml @@ -9,7 +9,7 @@ - +