Merge pull request #216 from DataDog/tyler/error-object

Use Field.ERROR_OBJECT instead of string

dd-java-agent/instrumentation/apache-httpclient-4.3/src/main/java/datadog/trace/instrumentation/apachehttpclient/DDTracingClientExec.java

@@ -1,5 +1,7 @@
 package datadog.trace.instrumentation.apachehttpclient;
 
+import static io.opentracing.log.Fields.ERROR_OBJECT;
+
 import datadog.trace.api.DDSpanTypes;
 import datadog.trace.api.DDTags;
 import io.opentracing.Scope;
@@ -158,7 +160,7 @@ public class DDTracingClientExec implements ClientExecChain {
     } catch (IOException | HttpException | RuntimeException e) {
       // error tags
       Tags.ERROR.set(networkSpan, Boolean.TRUE);
-      networkSpan.log(Collections.singletonMap("error.object", e));
+      networkSpan.log(Collections.singletonMap(ERROR_OBJECT, e));
 
       throw e;
     } finally {

dd-java-agent/instrumentation/jdbc/src/main/java/datadog/trace/instrumentation/jdbc/PreparedStatementInstrumentation.java

@@ -1,5 +1,6 @@
 package datadog.trace.instrumentation.jdbc;
 
+import static io.opentracing.log.Fields.ERROR_OBJECT;
 import static net.bytebuddy.matcher.ElementMatchers.hasSuperType;
 import static net.bytebuddy.matcher.ElementMatchers.isInterface;
 import static net.bytebuddy.matcher.ElementMatchers.isPublic;
@@ -87,7 +88,7 @@ public final class PreparedStatementInstrumentation extends Instrumenter.Configu
       if (throwable != null) {
         final Span span = scope.span();
         Tags.ERROR.set(span, true);
-        span.log(Collections.singletonMap("error.object", throwable));
+        span.log(Collections.singletonMap(ERROR_OBJECT, throwable));
       }
       scope.close();
     }

dd-java-agent/instrumentation/jdbc/src/main/java/datadog/trace/instrumentation/jdbc/StatementInstrumentation.java

@@ -1,5 +1,6 @@
 package datadog.trace.instrumentation.jdbc;
 
+import static io.opentracing.log.Fields.ERROR_OBJECT;
 import static net.bytebuddy.matcher.ElementMatchers.hasSuperType;
 import static net.bytebuddy.matcher.ElementMatchers.isInterface;
 import static net.bytebuddy.matcher.ElementMatchers.isPublic;
@@ -88,7 +89,7 @@ public final class StatementInstrumentation extends Instrumenter.Configurable {
       if (throwable != null) {
         final Span span = scope.span();
         Tags.ERROR.set(span, true);
-        span.log(Collections.singletonMap("error.object", throwable));
+        span.log(Collections.singletonMap(ERROR_OBJECT, throwable));
       }
       scope.close();
     }

dd-java-agent/instrumentation/jms-1/src/main/java/datadog/trace/instrumentation/jms1/JMS1MessageConsumerInstrumentation.java

@@ -2,6 +2,7 @@ package datadog.trace.instrumentation.jms1;
 
 import static datadog.trace.agent.tooling.ClassLoaderMatcher.classLoaderHasClasses;
 import static datadog.trace.instrumentation.jms.util.JmsUtil.toResourceName;
+import static io.opentracing.log.Fields.ERROR_OBJECT;
 import static net.bytebuddy.matcher.ElementMatchers.hasSuperType;
 import static net.bytebuddy.matcher.ElementMatchers.isInterface;
 import static net.bytebuddy.matcher.ElementMatchers.isPublic;
@@ -90,7 +91,7 @@ public final class JMS1MessageConsumerInstrumentation extends Instrumenter.Confi
 
       if (throwable != null) {
         Tags.ERROR.set(span, Boolean.TRUE);
-        span.log(Collections.singletonMap("error.object", throwable));
+        span.log(Collections.singletonMap(ERROR_OBJECT, throwable));
       }
       span.setTag(DDTags.RESOURCE_NAME, "Consumed from " + toResourceName(message, null));
       scope.close();

dd-java-agent/instrumentation/jms-1/src/main/java/datadog/trace/instrumentation/jms1/JMS1MessageListenerInstrumentation.java

@@ -2,6 +2,7 @@ package datadog.trace.instrumentation.jms1;
 
 import static datadog.trace.agent.tooling.ClassLoaderMatcher.classLoaderHasClasses;
 import static datadog.trace.instrumentation.jms.util.JmsUtil.toResourceName;
+import static io.opentracing.log.Fields.ERROR_OBJECT;
 import static net.bytebuddy.matcher.ElementMatchers.hasSuperType;
 import static net.bytebuddy.matcher.ElementMatchers.isInterface;
 import static net.bytebuddy.matcher.ElementMatchers.isPublic;
@@ -80,7 +81,7 @@ public final class JMS1MessageListenerInstrumentation extends Instrumenter.Confi
         if (throwable != null) {
           final Span span = scope.span();
           Tags.ERROR.set(span, Boolean.TRUE);
-          span.log(Collections.singletonMap("error.object", throwable));
+          span.log(Collections.singletonMap(ERROR_OBJECT, throwable));
         }
         scope.close();
       }

dd-java-agent/instrumentation/jms-1/src/main/java/datadog/trace/instrumentation/jms1/JMS1MessageProducerInstrumentation.java

@@ -2,6 +2,7 @@ package datadog.trace.instrumentation.jms1;
 
 import static datadog.trace.agent.tooling.ClassLoaderMatcher.classLoaderHasClasses;
 import static datadog.trace.instrumentation.jms.util.JmsUtil.toResourceName;
+import static io.opentracing.log.Fields.ERROR_OBJECT;
 import static net.bytebuddy.matcher.ElementMatchers.hasSuperType;
 import static net.bytebuddy.matcher.ElementMatchers.isInterface;
 import static net.bytebuddy.matcher.ElementMatchers.isPublic;
@@ -95,7 +96,7 @@ public final class JMS1MessageProducerInstrumentation extends Instrumenter.Confi
         if (throwable != null) {
           final Span span = scope.span();
           Tags.ERROR.set(span, Boolean.TRUE);
-          span.log(Collections.singletonMap("error.object", throwable));
+          span.log(Collections.singletonMap(ERROR_OBJECT, throwable));
         }
         scope.close();
       }
@@ -135,7 +136,7 @@ public final class JMS1MessageProducerInstrumentation extends Instrumenter.Confi
         if (throwable != null) {
           final Span span = scope.span();
           Tags.ERROR.set(span, Boolean.TRUE);
-          span.log(Collections.singletonMap("error.object", throwable));
+          span.log(Collections.singletonMap(ERROR_OBJECT, throwable));
         }
         scope.close();
       }

dd-java-agent/instrumentation/jms-2/src/main/java/datadog/trace/instrumentation/jms2/JMS2MessageConsumerInstrumentation.java

@@ -2,6 +2,7 @@ package datadog.trace.instrumentation.jms2;
 
 import static datadog.trace.agent.tooling.ClassLoaderMatcher.classLoaderHasClasses;
 import static datadog.trace.instrumentation.jms.util.JmsUtil.toResourceName;
+import static io.opentracing.log.Fields.ERROR_OBJECT;
 import static net.bytebuddy.matcher.ElementMatchers.hasSuperType;
 import static net.bytebuddy.matcher.ElementMatchers.isInterface;
 import static net.bytebuddy.matcher.ElementMatchers.isPublic;
@@ -91,7 +92,7 @@ public final class JMS2MessageConsumerInstrumentation extends Instrumenter.Confi
 
       if (throwable != null) {
         Tags.ERROR.set(span, Boolean.TRUE);
-        span.log(Collections.singletonMap("error.object", throwable));
+        span.log(Collections.singletonMap(ERROR_OBJECT, throwable));
       }
       span.setTag(DDTags.RESOURCE_NAME, "Consumed from " + toResourceName(message, null));
       scope.close();

dd-java-agent/instrumentation/jms-2/src/main/java/datadog/trace/instrumentation/jms2/JMS2MessageListenerInstrumentation.java

@@ -2,6 +2,7 @@ package datadog.trace.instrumentation.jms2;
 
 import static datadog.trace.agent.tooling.ClassLoaderMatcher.classLoaderHasClasses;
 import static datadog.trace.instrumentation.jms.util.JmsUtil.toResourceName;
+import static io.opentracing.log.Fields.ERROR_OBJECT;
 import static net.bytebuddy.matcher.ElementMatchers.hasSuperType;
 import static net.bytebuddy.matcher.ElementMatchers.isInterface;
 import static net.bytebuddy.matcher.ElementMatchers.isPublic;
@@ -80,7 +81,7 @@ public final class JMS2MessageListenerInstrumentation extends Instrumenter.Confi
         if (throwable != null) {
           final Span span = scope.span();
           Tags.ERROR.set(span, Boolean.TRUE);
-          span.log(Collections.singletonMap("error.object", throwable));
+          span.log(Collections.singletonMap(ERROR_OBJECT, throwable));
         }
         scope.close();
       }

dd-java-agent/instrumentation/jms-2/src/main/java/datadog/trace/instrumentation/jms2/JMS2MessageProducerInstrumentation.java

@@ -2,6 +2,7 @@ package datadog.trace.instrumentation.jms2;
 
 import static datadog.trace.agent.tooling.ClassLoaderMatcher.classLoaderHasClasses;
 import static datadog.trace.instrumentation.jms.util.JmsUtil.toResourceName;
+import static io.opentracing.log.Fields.ERROR_OBJECT;
 import static net.bytebuddy.matcher.ElementMatchers.hasSuperType;
 import static net.bytebuddy.matcher.ElementMatchers.isInterface;
 import static net.bytebuddy.matcher.ElementMatchers.isPublic;
@@ -95,7 +96,7 @@ public final class JMS2MessageProducerInstrumentation extends Instrumenter.Confi
         if (throwable != null) {
           final Span span = scope.span();
           Tags.ERROR.set(span, Boolean.TRUE);
-          span.log(Collections.singletonMap("error.object", throwable));
+          span.log(Collections.singletonMap(ERROR_OBJECT, throwable));
         }
         scope.close();
       }
@@ -134,7 +135,7 @@ public final class JMS2MessageProducerInstrumentation extends Instrumenter.Confi
         if (throwable != null) {
           final Span span = scope.span();
           Tags.ERROR.set(span, Boolean.TRUE);
-          span.log(Collections.singletonMap("error.object", throwable));
+          span.log(Collections.singletonMap(ERROR_OBJECT, throwable));
         }
         scope.close();
       }

dd-java-agent/instrumentation/kafka-clients-0.11/src/main/java/datadog/trace/instrumentation/kafka_clients/KafkaProducerInstrumentation.java

@@ -1,6 +1,7 @@
 package datadog.trace.instrumentation.kafka_clients;
 
 import static datadog.trace.agent.tooling.ClassLoaderMatcher.classLoaderHasClasses;
+import static io.opentracing.log.Fields.ERROR_OBJECT;
 import static net.bytebuddy.matcher.ElementMatchers.isMethod;
 import static net.bytebuddy.matcher.ElementMatchers.isPublic;
 import static net.bytebuddy.matcher.ElementMatchers.named;
@@ -120,7 +121,7 @@ public final class KafkaProducerInstrumentation extends Instrumenter.Configurabl
       if (throwable != null) {
         final Span span = scope.span();
         Tags.ERROR.set(span, true);
-        span.log(Collections.singletonMap("error.object", throwable));
+        span.log(Collections.singletonMap(ERROR_OBJECT, throwable));
         span.finish();
       }
       scope.close();
@@ -140,7 +141,7 @@ public final class KafkaProducerInstrumentation extends Instrumenter.Configurabl
     public void onCompletion(final RecordMetadata metadata, final Exception exception) {
       if (exception != null) {
         Tags.ERROR.set(scope.span(), Boolean.TRUE);
-        scope.span().log(Collections.singletonMap("error.object", exception));
+        scope.span().log(Collections.singletonMap(ERROR_OBJECT, exception));
       }
       try {
         if (callback != null) {

dd-java-agent/instrumentation/kafka-streams-0.11/src/main/java/datadog/trace/instrumentation/kafka_streams/KafkaStreamsProcessorInstrumentation.java

@@ -1,6 +1,7 @@
 package datadog.trace.instrumentation.kafka_streams;
 
 import static datadog.trace.agent.tooling.ClassLoaderMatcher.classLoaderHasClasses;
+import static io.opentracing.log.Fields.ERROR_OBJECT;
 import static net.bytebuddy.matcher.ElementMatchers.isMethod;
 import static net.bytebuddy.matcher.ElementMatchers.isPackagePrivate;
 import static net.bytebuddy.matcher.ElementMatchers.isPublic;
@@ -134,7 +135,7 @@ public class KafkaStreamsProcessorInstrumentation {
           if (throwable != null) {
             final Span span = scope.span();
             Tags.ERROR.set(span, Boolean.TRUE);
-            span.log(Collections.singletonMap("error.object", throwable));
+            span.log(Collections.singletonMap(ERROR_OBJECT, throwable));
           }
           scope.close();
         }

dd-java-agent/instrumentation/mongo-3.1/src/main/java/datadog/trace/instrumentation/mongo/DDTracingCommandListener.java

@@ -1,5 +1,7 @@
 package datadog.trace.instrumentation.mongo;
 
+import static io.opentracing.log.Fields.ERROR_OBJECT;
+
 import com.mongodb.event.CommandFailedEvent;
 import com.mongodb.event.CommandListener;
 import com.mongodb.event.CommandStartedEvent;
@@ -39,36 +41,36 @@ public class DDTracingCommandListener implements CommandListener {
   /** requestID -> span */
   private final Map<Integer, Span> cache = new ConcurrentHashMap<>();
 
-  public DDTracingCommandListener(Tracer tracer) {
+  public DDTracingCommandListener(final Tracer tracer) {
     this.tracer = tracer;
   }
 
   @Override
-  public void commandStarted(CommandStartedEvent event) {
+  public void commandStarted(final CommandStartedEvent event) {
-    Span span = buildSpan(event);
+    final Span span = buildSpan(event);
     cache.put(event.getRequestId(), span);
   }
 
   @Override
-  public void commandSucceeded(CommandSucceededEvent event) {
+  public void commandSucceeded(final CommandSucceededEvent event) {
-    Span span = cache.remove(event.getRequestId());
+    final Span span = cache.remove(event.getRequestId());
     if (span != null) {
       span.finish();
     }
   }
 
   @Override
-  public void commandFailed(CommandFailedEvent event) {
+  public void commandFailed(final CommandFailedEvent event) {
-    Span span = cache.remove(event.getRequestId());
+    final Span span = cache.remove(event.getRequestId());
     if (span != null) {
       Tags.ERROR.set(span, Boolean.TRUE);
-      span.log(Collections.singletonMap("error.object", event.getThrowable()));
+      span.log(Collections.singletonMap(ERROR_OBJECT, event.getThrowable()));
       span.finish();
     }
   }
 
-  private Span buildSpan(CommandStartedEvent event) {
+  private Span buildSpan(final CommandStartedEvent event) {
-    Tracer.SpanBuilder spanBuilder =
+    final Tracer.SpanBuilder spanBuilder =
         tracer.buildSpan(MONGO_OPERATION).withTag(Tags.SPAN_KIND.getKey(), Tags.SPAN_KIND_CLIENT);
 
     final Span span = spanBuilder.startManual();
@@ -81,7 +83,7 @@ public class DDTracingCommandListener implements CommandListener {
     return span;
   }
 
-  public static void decorate(Span span, CommandStartedEvent event) {
+  public static void decorate(final Span span, final CommandStartedEvent event) {
     // scrub the Mongo command so that parameters are removed from the string
     final BsonDocument scrubbed = scrub(event.getCommand());
     final String mongoCmd = scrubbed.toString();
@@ -92,7 +94,7 @@ public class DDTracingCommandListener implements CommandListener {
 
     Tags.PEER_HOSTNAME.set(span, event.getConnectionDescription().getServerAddress().getHost());
 
-    InetAddress inetAddress =
+    final InetAddress inetAddress =
         event.getConnectionDescription().getServerAddress().getSocketAddress().getAddress();
     if (inetAddress instanceof Inet4Address) {
       Tags.PEER_HOST_IPV4.set(span, inetAddress.getHostAddress());

dd-java-agent/instrumentation/servlet-2/src/main/java/datadog/trace/instrumentation/servlet2/FilterChain2Instrumentation.java

@@ -1,6 +1,7 @@
 package datadog.trace.instrumentation.servlet2;
 
 import static datadog.trace.agent.tooling.ClassLoaderMatcher.classLoaderHasClasses;
+import static io.opentracing.log.Fields.ERROR_OBJECT;
 import static net.bytebuddy.matcher.ElementMatchers.hasSuperType;
 import static net.bytebuddy.matcher.ElementMatchers.isInterface;
 import static net.bytebuddy.matcher.ElementMatchers.isPublic;
@@ -109,7 +110,7 @@ public final class FilterChain2Instrumentation extends Instrumenter.Configurable
 
           if (throwable != null) {
             ServletFilterSpanDecorator.STANDARD_TAGS.onError(req, resp, throwable, span);
-            span.log(Collections.singletonMap("error.object", throwable));
+            span.log(Collections.singletonMap(ERROR_OBJECT, throwable));
           } else {
             ServletFilterSpanDecorator.STANDARD_TAGS.onResponse(req, resp, span);
           }

dd-java-agent/instrumentation/servlet-2/src/main/java/datadog/trace/instrumentation/servlet2/HttpServlet2Instrumentation.java

@@ -1,6 +1,7 @@
 package datadog.trace.instrumentation.servlet2;
 
 import static datadog.trace.agent.tooling.ClassLoaderMatcher.classLoaderHasClasses;
+import static io.opentracing.log.Fields.ERROR_OBJECT;
 import static net.bytebuddy.matcher.ElementMatchers.hasSuperType;
 import static net.bytebuddy.matcher.ElementMatchers.isInterface;
 import static net.bytebuddy.matcher.ElementMatchers.isProtected;
@@ -109,7 +110,7 @@ public final class HttpServlet2Instrumentation extends Instrumenter.Configurable
 
           if (throwable != null) {
             ServletFilterSpanDecorator.STANDARD_TAGS.onError(req, resp, throwable, span);
-            span.log(Collections.singletonMap("error.object", throwable));
+            span.log(Collections.singletonMap(ERROR_OBJECT, throwable));
           } else {
             ServletFilterSpanDecorator.STANDARD_TAGS.onResponse(req, resp, span);
           }

dd-java-agent/instrumentation/servlet-3/src/main/java/datadog/trace/instrumentation/servlet3/FilterChain3Instrumentation.java

@@ -1,6 +1,7 @@
 package datadog.trace.instrumentation.servlet3;
 
 import static datadog.trace.agent.tooling.ClassLoaderMatcher.classLoaderHasClasses;
+import static io.opentracing.log.Fields.ERROR_OBJECT;
 import static net.bytebuddy.matcher.ElementMatchers.hasSuperType;
 import static net.bytebuddy.matcher.ElementMatchers.isInterface;
 import static net.bytebuddy.matcher.ElementMatchers.isPublic;
@@ -110,7 +111,7 @@ public final class FilterChain3Instrumentation extends Instrumenter.Configurable
 
           if (throwable != null) {
             ServletFilterSpanDecorator.STANDARD_TAGS.onError(req, resp, throwable, span);
-            span.log(Collections.singletonMap("error.object", throwable));
+            span.log(Collections.singletonMap(ERROR_OBJECT, throwable));
             scope.close();
             scope.span().finish(); // Finish the span manually since finishSpanOnClose was false
           } else if (req.isAsyncStarted()) {
@@ -169,7 +170,7 @@ public final class FilterChain3Instrumentation extends Instrumenter.Configurable
                 (HttpServletResponse) event.getSuppliedResponse(),
                 event.getThrowable(),
                 span);
-            span.log(Collections.singletonMap("error.object", event.getThrowable()));
+            span.log(Collections.singletonMap(ERROR_OBJECT, event.getThrowable()));
           }
         }
       }

dd-java-agent/instrumentation/servlet-3/src/main/java/datadog/trace/instrumentation/servlet3/HttpServlet3Instrumentation.java

@@ -1,6 +1,7 @@
 package datadog.trace.instrumentation.servlet3;
 
 import static datadog.trace.agent.tooling.ClassLoaderMatcher.classLoaderHasClasses;
+import static io.opentracing.log.Fields.ERROR_OBJECT;
 import static net.bytebuddy.matcher.ElementMatchers.hasSuperType;
 import static net.bytebuddy.matcher.ElementMatchers.isInterface;
 import static net.bytebuddy.matcher.ElementMatchers.isProtected;
@@ -102,7 +103,7 @@ public final class HttpServlet3Instrumentation extends Instrumenter.Configurable
         final Span span = scope.span();
         if (throwable != null) {
           ServletFilterSpanDecorator.STANDARD_TAGS.onError(req, resp, throwable, span);
-          span.log(Collections.singletonMap("error.object", throwable));
+          span.log(Collections.singletonMap(ERROR_OBJECT, throwable));
           scope.close();
           scope.span().finish(); // Finish the span manually since finishSpanOnClose was false
         } else if (req.isAsyncStarted()) {
@@ -160,7 +161,7 @@ public final class HttpServlet3Instrumentation extends Instrumenter.Configurable
                 (HttpServletResponse) event.getSuppliedResponse(),
                 event.getThrowable(),
                 span);
-            span.log(Collections.singletonMap("error.object", event.getThrowable()));
+            span.log(Collections.singletonMap(ERROR_OBJECT, event.getThrowable()));
           }
         }
       }

dd-java-agent/instrumentation/trace-annotation/src/main/java/datadog/trace/instrumentation/trace_annotation/TraceAnnotationInstrumentation.java

@@ -1,5 +1,6 @@
 package datadog.trace.instrumentation.trace_annotation;
 
+import static io.opentracing.log.Fields.ERROR_OBJECT;
 import static net.bytebuddy.matcher.ElementMatchers.declaresMethod;
 import static net.bytebuddy.matcher.ElementMatchers.hasSuperType;
 import static net.bytebuddy.matcher.ElementMatchers.isAnnotatedWith;
@@ -52,7 +53,7 @@ public final class TraceAnnotationInstrumentation extends Instrumenter.Configura
       if (throwable != null) {
         final Span span = scope.span();
         Tags.ERROR.set(span, true);
-        span.log(Collections.singletonMap("error.object", throwable));
+        span.log(Collections.singletonMap(ERROR_OBJECT, throwable));
       }
       scope.close();
     }

dd-trace-ot/docs/opentracing-api.md

@@ -125,7 +125,7 @@ Errors are manually captured in a span by setting the error flag and logging the
     // capture error
     ActiveSpan span = GlobalTracer.get().activeSpan();
     Tags.ERROR.set(span, Boolean.TRUE);
-    span.log(Collections.singletonMap("error.object", e));
+    span.log(Collections.singletonMap(io.opentracing.log.Fields.ERROR_OBJECT, e));
 
     // recovery code
   }

dd-trace-ot/src/main/java/datadog/opentracing/DDSpan.java

@@ -1,5 +1,7 @@
 package datadog.opentracing;
 
+import static io.opentracing.log.Fields.ERROR_OBJECT;
+
 import com.fasterxml.jackson.annotation.JsonGetter;
 import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonInclude;
@@ -121,8 +123,8 @@ public class DDSpan implements Span {
   }
 
   private boolean extractError(final Map<String, ?> map) {
-    if (map.get("error.object") instanceof Throwable) {
+    if (map.get(ERROR_OBJECT) instanceof Throwable) {
-      final Throwable error = (Throwable) map.get("error.object");
+      final Throwable error = (Throwable) map.get(ERROR_OBJECT);
       setErrorMeta(error);
       return true;
     }
@@ -245,7 +247,7 @@ public class DDSpan implements Span {
    *
    * <p>Has no effect if the span priority has been propagated (injected or extracted).
    */
-  public final DDSpan setSamplingPriority(int newPriority) {
+  public final DDSpan setSamplingPriority(final int newPriority) {
     this.context().setSamplingPriority(newPriority);
     return this;
   }