Apply standard tag name and update spring-web test deps version.

tylerbenson · tylerbenson · commit 1064e35788e8 · 2018-11-16T08:06:40.000-08:00
diff --git a/dd-java-agent/instrumentation/jetty-8/src/main/java/datadog/trace/instrumentation/jetty8/JettyHandlerAdvice.java b/dd-java-agent/instrumentation/jetty-8/src/main/java/datadog/trace/instrumentation/jetty8/JettyHandlerAdvice.java
@@ -52,7 +52,7 @@ public static Scope startSpan(
     Tags.HTTP_URL.set(span, req.getRequestURL().toString());
     span.setTag(DDTags.RESOURCE_NAME, resourceName);
     if (req.getUserPrincipal() != null) {
-      span.setTag("user.principal", req.getUserPrincipal().getName());
+      span.setTag(DDTags.USER_NAME, req.getUserPrincipal().getName());
     }
     return scope;
   }
diff --git a/dd-java-agent/instrumentation/servlet-2/src/main/java/datadog/trace/instrumentation/servlet2/Servlet2Advice.java b/dd-java-agent/instrumentation/servlet-2/src/main/java/datadog/trace/instrumentation/servlet2/Servlet2Advice.java
@@ -64,7 +64,7 @@ public static void stopSpan(
       if (req instanceof HttpServletRequest) {
         final Principal principal = ((HttpServletRequest) req).getUserPrincipal();
         if (principal != null) {
-          currentSpan.setTag("user.principal", principal.getName());
+          currentSpan.setTag(DDTags.USER_NAME, principal.getName());
         }
       }
     }
diff --git a/dd-java-agent/instrumentation/servlet-2/src/test/groovy/JettyServlet2Test.groovy b/dd-java-agent/instrumentation/servlet-2/src/test/groovy/JettyServlet2Test.groovy
@@ -2,6 +2,7 @@ import datadog.trace.agent.test.AgentTestRunner
 import datadog.trace.agent.test.TestUtils
 import datadog.trace.agent.test.utils.OkHttpUtils
 import datadog.trace.api.DDSpanTypes
+import datadog.trace.api.DDTags
 import okhttp3.Credentials
 import okhttp3.Interceptor
 import okhttp3.OkHttpClient
@@ -94,7 +95,7 @@ class JettyServlet2Test extends AgentTestRunner {
             "span.type" DDSpanTypes.WEB_SERVLET
             "servlet.context" "/ctx"
             if (auth) {
-              "user.principal" "user"
+              "$DDTags.USER_NAME" "user"
             }
             defaultTags(distributedTracing)
           }
diff --git a/dd-java-agent/instrumentation/servlet-3/src/main/java/datadog/trace/instrumentation/servlet3/Servlet3Advice.java b/dd-java-agent/instrumentation/servlet-3/src/main/java/datadog/trace/instrumentation/servlet3/Servlet3Advice.java
@@ -68,7 +68,7 @@ public static void stopSpan(
       if (request instanceof HttpServletRequest) {
         final Principal principal = ((HttpServletRequest) request).getUserPrincipal();
         if (principal != null) {
-          currentSpan.setTag("user.principal", principal.getName());
+          currentSpan.setTag(DDTags.USER_NAME, principal.getName());
         }
       }
     }
diff --git a/dd-java-agent/instrumentation/servlet-3/src/test/groovy/JettyServlet3Test.groovy b/dd-java-agent/instrumentation/servlet-3/src/test/groovy/JettyServlet3Test.groovy
@@ -2,6 +2,7 @@ import datadog.trace.agent.test.AgentTestRunner
 import datadog.trace.agent.test.TestUtils
 import datadog.trace.agent.test.utils.OkHttpUtils
 import datadog.trace.api.DDSpanTypes
+import datadog.trace.api.DDTags
 import okhttp3.Credentials
 import okhttp3.Interceptor
 import okhttp3.OkHttpClient
@@ -101,7 +102,7 @@ class JettyServlet3Test extends AgentTestRunner {
             "span.type" DDSpanTypes.WEB_SERVLET
             "http.status_code" 200
             if (auth) {
-              "user.principal" "user"
+              "$DDTags.USER_NAME" "user"
             }
             defaultTags(distributedTracing)
           }
diff --git a/dd-java-agent/instrumentation/spring-web/spring-web.gradle b/dd-java-agent/instrumentation/spring-web/spring-web.gradle
@@ -34,7 +34,7 @@ dependencies {
 
   testCompile group: 'org.spockframework', name: 'spock-spring', version: '1.1-groovy-2.4'
 
-  testCompile group: 'org.springframework.boot', name: 'spring-boot-starter-test', version: '1.5.+'
-  testCompile group: 'org.springframework.boot', name: 'spring-boot-starter-web', version: '1.5.+'
-  testCompile group: 'org.springframework.boot', name: 'spring-boot-starter-security', version: '1.5.+'
+  testCompile group: 'org.springframework.boot', name: 'spring-boot-starter-test', version: '1.5.17.RELEASE'
+  testCompile group: 'org.springframework.boot', name: 'spring-boot-starter-web', version: '1.5.17.RELEASE'
+  testCompile group: 'org.springframework.boot', name: 'spring-boot-starter-security', version: '1.5.17.RELEASE'
 }
diff --git a/dd-java-agent/instrumentation/spring-web/src/test/groovy/test/SpringBootBasedTest.groovy b/dd-java-agent/instrumentation/spring-web/src/test/groovy/test/SpringBootBasedTest.groovy
@@ -48,7 +48,7 @@ class SpringBootBasedTest extends AgentTestRunner {
             "span.origin.type" "org.apache.catalina.core.ApplicationFilterChain"
             "component" "java-web-servlet"
             "http.status_code" 200
-            "user.principal" USER
+            "$DDTags.USER_NAME" USER
             defaultTags()
           }
         }
@@ -78,7 +78,7 @@ class SpringBootBasedTest extends AgentTestRunner {
             "span.origin.type" "org.apache.catalina.core.ApplicationFilterChain"
             "component" "java-web-servlet"
             "http.status_code" 200
-            "user.principal" USER
+            "$DDTags.USER_NAME" USER
             defaultTags()
           }
         }
@@ -163,7 +163,7 @@ class SpringBootBasedTest extends AgentTestRunner {
             "span.origin.type" "org.apache.catalina.core.ApplicationFilterChain"
             "component" "java-web-servlet"
             "http.status_code" 404
-            "user.principal" USER
+            "$DDTags.USER_NAME" USER
             defaultTags()
           }
         }
@@ -219,7 +219,7 @@ class SpringBootBasedTest extends AgentTestRunner {
             "span.origin.type" "org.apache.catalina.core.ApplicationFilterChain"
             "component" "java-web-servlet"
             "http.status_code" 500
-            "user.principal" USER
+            "$DDTags.USER_NAME" USER
             errorTags NestedServletException, "Request processing failed; nested exception is java.lang.RuntimeException: qwerty"
             defaultTags()
           }
@@ -271,7 +271,7 @@ class SpringBootBasedTest extends AgentTestRunner {
             "span.origin.type" "org.apache.catalina.core.ApplicationFilterChain"
             "component" "java-web-servlet"
             "http.status_code" 200
-            "user.principal" USER
+            "$DDTags.USER_NAME" USER
             defaultTags()
           }
         }
@@ -307,7 +307,7 @@ class SpringBootBasedTest extends AgentTestRunner {
             "span.origin.type" "org.apache.catalina.core.ApplicationFilterChain"
             "component" "java-web-servlet"
             "http.status_code" 400
-            "user.principal" USER
+            "$DDTags.USER_NAME" USER
             "error" false
             "error.msg" String
             "error.type" MethodArgumentNotValidException.name
diff --git a/dd-trace-api/src/main/java/datadog/trace/api/DDTags.java b/dd-trace-api/src/main/java/datadog/trace/api/DDTags.java
@@ -8,6 +8,8 @@ public class DDTags {
   public static final String THREAD_ID = "thread.id";
   public static final String DB_STATEMENT = "sql.query";
 
+  public static final String USER_NAME = "user.principal";
+
   public static final String ERROR_MSG = "error.msg"; // string representing the error message
   public static final String ERROR_TYPE = "error.type"; // string representing the type of the error
   public static final String ERROR_STACK = "error.stack"; // human readable version of the stack

Original file line number	Diff line number	Diff line change
`@@ -52,7 +52,7 @@ public static Scope startSpan(`
`52`	`52`	`Tags.HTTP_URL.set(span, req.getRequestURL().toString());`
`53`	`53`	`span.setTag(DDTags.RESOURCE_NAME, resourceName);`
`54`	`54`	`if (req.getUserPrincipal() != null) {`
`55`		`- span.setTag("user.principal", req.getUserPrincipal().getName());`
	`55`	`+ span.setTag(DDTags.USER_NAME, req.getUserPrincipal().getName());`
`56`	`56`	`}`
`57`	`57`	`return scope;`
`58`	`58`	`}`
Original file line number	Diff line number	Diff line change
`@@ -64,7 +64,7 @@ public static void stopSpan(`
`64`	`64`	`if (req instanceof HttpServletRequest) {`
`65`	`65`	`final Principal principal = ((HttpServletRequest) req).getUserPrincipal();`
`66`	`66`	`if (principal != null) {`
`67`		`- currentSpan.setTag("user.principal", principal.getName());`
	`67`	`+ currentSpan.setTag(DDTags.USER_NAME, principal.getName());`
`68`	`68`	`}`
`69`	`69`	`}`
`70`	`70`	`}`
Original file line number	Diff line number	Diff line change
`@@ -68,7 +68,7 @@ public static void stopSpan(`
`68`	`68`	`if (request instanceof HttpServletRequest) {`
`69`	`69`	`final Principal principal = ((HttpServletRequest) request).getUserPrincipal();`
`70`	`70`	`if (principal != null) {`
`71`		`- currentSpan.setTag("user.principal", principal.getName());`
	`71`	`+ currentSpan.setTag(DDTags.USER_NAME, principal.getName());`
`72`	`72`	`}`
`73`	`73`	`}`
`74`	`74`	`}`
Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ dependencies {`
`34`	`34`
`35`	`35`	`testCompile group: 'org.spockframework', name: 'spock-spring', version: '1.1-groovy-2.4'`
`36`	`36`
`37`		`- testCompile group: 'org.springframework.boot', name: 'spring-boot-starter-test', version: '1.5.+'`
`38`		`- testCompile group: 'org.springframework.boot', name: 'spring-boot-starter-web', version: '1.5.+'`
`39`		`- testCompile group: 'org.springframework.boot', name: 'spring-boot-starter-security', version: '1.5.+'`
	`37`	`+ testCompile group: 'org.springframework.boot', name: 'spring-boot-starter-test', version: '1.5.17.RELEASE'`
	`38`	`+ testCompile group: 'org.springframework.boot', name: 'spring-boot-starter-web', version: '1.5.17.RELEASE'`
	`39`	`+ testCompile group: 'org.springframework.boot', name: 'spring-boot-starter-security', version: '1.5.17.RELEASE'`
`40`	`40`	`}`
Original file line number	Diff line number	Diff line change
`@@ -48,7 +48,7 @@ class SpringBootBasedTest extends AgentTestRunner {`
`48`	`48`	`"span.origin.type" "org.apache.catalina.core.ApplicationFilterChain"`
`49`	`49`	`"component" "java-web-servlet"`
`50`	`50`	`"http.status_code" 200`
`51`		`- "user.principal" USER`
	`51`	`+ "$DDTags.USER_NAME" USER`
`52`	`52`	`defaultTags()`
`53`	`53`	`}`
`54`	`54`	`}`
`@@ -78,7 +78,7 @@ class SpringBootBasedTest extends AgentTestRunner {`
`78`	`78`	`"span.origin.type" "org.apache.catalina.core.ApplicationFilterChain"`
`79`	`79`	`"component" "java-web-servlet"`
`80`	`80`	`"http.status_code" 200`
`81`		`- "user.principal" USER`
	`81`	`+ "$DDTags.USER_NAME" USER`
`82`	`82`	`defaultTags()`
`83`	`83`	`}`
`84`	`84`	`}`
`@@ -163,7 +163,7 @@ class SpringBootBasedTest extends AgentTestRunner {`
`163`	`163`	`"span.origin.type" "org.apache.catalina.core.ApplicationFilterChain"`
`164`	`164`	`"component" "java-web-servlet"`
`165`	`165`	`"http.status_code" 404`
`166`		`- "user.principal" USER`
	`166`	`+ "$DDTags.USER_NAME" USER`
`167`	`167`	`defaultTags()`
`168`	`168`	`}`
`169`	`169`	`}`
`@@ -219,7 +219,7 @@ class SpringBootBasedTest extends AgentTestRunner {`
`219`	`219`	`"span.origin.type" "org.apache.catalina.core.ApplicationFilterChain"`
`220`	`220`	`"component" "java-web-servlet"`
`221`	`221`	`"http.status_code" 500`
`222`		`- "user.principal" USER`
	`222`	`+ "$DDTags.USER_NAME" USER`
`223`	`223`	`errorTags NestedServletException, "Request processing failed; nested exception is java.lang.RuntimeException: qwerty"`
`224`	`224`	`defaultTags()`
`225`	`225`	`}`
`@@ -271,7 +271,7 @@ class SpringBootBasedTest extends AgentTestRunner {`
`271`	`271`	`"span.origin.type" "org.apache.catalina.core.ApplicationFilterChain"`
`272`	`272`	`"component" "java-web-servlet"`
`273`	`273`	`"http.status_code" 200`
`274`		`- "user.principal" USER`
	`274`	`+ "$DDTags.USER_NAME" USER`
`275`	`275`	`defaultTags()`
`276`	`276`	`}`
`277`	`277`	`}`
`@@ -307,7 +307,7 @@ class SpringBootBasedTest extends AgentTestRunner {`
`307`	`307`	`"span.origin.type" "org.apache.catalina.core.ApplicationFilterChain"`
`308`	`308`	`"component" "java-web-servlet"`
`309`	`309`	`"http.status_code" 400`
`310`		`- "user.principal" USER`
	`310`	`+ "$DDTags.USER_NAME" USER`
`311`	`311`	`"error" false`
`312`	`312`	`"error.msg" String`
`313`	`313`	`"error.type" MethodArgumentNotValidException.name`