Capture sessionId (#63)

pavolloffay · web-flow · commit b673c01677a5 · 2020-10-28T17:51:08.000+01:00
* Capture sessionId

Signed-off-by: Pavol Loffay &lt;p.loffay@gmail.com&gt;

* Add to helper classes

Signed-off-by: Pavol Loffay &lt;p.loffay@gmail.com&gt;
diff --git a/instrumentation/servlet/servlet-2.3/src/main/java/io/opentelemetry/instrumentation/hypertrace/servlet/v2_3/Servlet2BodyInstrumentation.java b/instrumentation/servlet/servlet-2.3/src/main/java/io/opentelemetry/instrumentation/hypertrace/servlet/v2_3/Servlet2BodyInstrumentation.java
@@ -27,6 +27,7 @@
 import static net.bytebuddy.matcher.ElementMatchers.takesArgument;
 
 import com.google.auto.service.AutoService;
+import io.opentelemetry.instrumentation.hypertrace.servlet.common.ServletSpanDecorator;
 import io.opentelemetry.javaagent.tooling.Instrumenter;
 import io.opentelemetry.trace.Span;
 import java.util.Enumeration;
@@ -102,6 +103,7 @@ public String[] helperClassNames() {
       "io.opentelemetry.instrumentation.hypertrace.servlet.common.CharBufferData",
       "io.opentelemetry.instrumentation.hypertrace.servlet.common.BufferedWriterWrapper",
       "io.opentelemetry.instrumentation.hypertrace.servlet.common.BufferedReaderWrapper",
+      "io.opentelemetry.instrumentation.hypertrace.servlet.common.ServletSpanDecorator",
       packageName + ".InstrumentationName",
       packageName + ".BufferingHttpServletResponse",
       packageName + ".BufferingHttpServletResponse$BufferingServletOutputStream",
@@ -153,6 +155,9 @@ public static Object start(
       rootStart = true;
       response = new BufferingHttpServletResponse(httpResponse);
       request = new BufferingHttpServletRequest(httpRequest, (HttpServletResponse) response);
+
+      ServletSpanDecorator.addSessionId(currentSpan, httpRequest);
+
       // set request headers
       Enumeration<String> headerNames = httpRequest.getHeaderNames();
       Map<String, String> headers = new HashMap<>();
diff --git a/instrumentation/servlet/servlet-3.0/src/main/java/io/opentelemetry/instrumentation/hypertrace/servlet/v3_0/Servlet30BodyInstrumentation.java b/instrumentation/servlet/servlet-3.0/src/main/java/io/opentelemetry/instrumentation/hypertrace/servlet/v3_0/Servlet30BodyInstrumentation.java
@@ -27,6 +27,7 @@
 import static net.bytebuddy.matcher.ElementMatchers.takesArgument;
 
 import com.google.auto.service.AutoService;
+import io.opentelemetry.instrumentation.hypertrace.servlet.common.ServletSpanDecorator;
 import io.opentelemetry.javaagent.tooling.Instrumenter;
 import io.opentelemetry.trace.Span;
 import java.util.Enumeration;
@@ -100,6 +101,7 @@ public String[] helperClassNames() {
       "io.opentelemetry.instrumentation.hypertrace.servlet.common.CharBufferData",
       "io.opentelemetry.instrumentation.hypertrace.servlet.common.BufferedWriterWrapper",
       "io.opentelemetry.instrumentation.hypertrace.servlet.common.BufferedReaderWrapper",
+      "io.opentelemetry.instrumentation.hypertrace.servlet.common.ServletSpanDecorator",
       packageName + ".InstrumentationName",
       packageName + ".BufferingHttpServletResponse",
       packageName + ".BufferingHttpServletResponse$BufferingServletOutputStream",
@@ -152,6 +154,9 @@ public static Object start(
       rootStart = true;
       response = new BufferingHttpServletResponse(httpResponse);
       request = new BufferingHttpServletRequest(httpRequest, (HttpServletResponse) response);
+
+      ServletSpanDecorator.addSessionId(currentSpan, httpRequest);
+
       // set request headers
       Enumeration<String> headerNames = httpRequest.getHeaderNames();
       Map<String, String> headers = new HashMap<>();
diff --git a/instrumentation/servlet/servlet-3.1/src/main/java/io/opentelemetry/instrumentation/hypertrace/servlet/v3_1/Servlet31BodyInstrumentation.java b/instrumentation/servlet/servlet-3.1/src/main/java/io/opentelemetry/instrumentation/hypertrace/servlet/v3_1/Servlet31BodyInstrumentation.java
@@ -26,6 +26,7 @@
 import static net.bytebuddy.matcher.ElementMatchers.takesArgument;
 
 import com.google.auto.service.AutoService;
+import io.opentelemetry.instrumentation.hypertrace.servlet.common.ServletSpanDecorator;
 import io.opentelemetry.javaagent.tooling.Instrumenter;
 import io.opentelemetry.trace.Span;
 import java.util.Enumeration;
@@ -97,6 +98,7 @@ public String[] helperClassNames() {
       "io.opentelemetry.instrumentation.hypertrace.servlet.common.CharBufferData",
       "io.opentelemetry.instrumentation.hypertrace.servlet.common.BufferedWriterWrapper",
       "io.opentelemetry.instrumentation.hypertrace.servlet.common.BufferedReaderWrapper",
+      "io.opentelemetry.instrumentation.hypertrace.servlet.common.ServletSpanDecorator",
       packageName + ".InstrumentationName",
       packageName + ".BufferingHttpServletResponse",
       packageName + ".BufferingHttpServletResponse$BufferingServletOutputStream",
@@ -149,6 +151,9 @@ public static Object start(
       rootStart = true;
       response = new BufferingHttpServletResponse(httpResponse);
       request = new BufferingHttpServletRequest(httpRequest, (HttpServletResponse) response);
+
+      ServletSpanDecorator.addSessionId(currentSpan, httpRequest);
+
       // set request headers
       Enumeration<String> headerNames = httpRequest.getHeaderNames();
       Map<String, String> headers = new HashMap<>();
diff --git a/instrumentation/servlet/servlet-common/build.gradle.kts b/instrumentation/servlet/servlet-common/build.gradle.kts
@@ -4,4 +4,5 @@ plugins {
 
 dependencies {
     compileOnly("javax.servlet:servlet-api:2.3")
+    api("io.opentelemetry:opentelemetry-api:0.9.1")
 }
diff --git a/instrumentation/servlet/servlet-common/src/main/java/io/opentelemetry/instrumentation/hypertrace/servlet/common/ServletSpanDecorator.java b/instrumentation/servlet/servlet-common/src/main/java/io/opentelemetry/instrumentation/hypertrace/servlet/common/ServletSpanDecorator.java
@@ -0,0 +1,36 @@
+/*
+ * Copyright The Hypertrace Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package io.opentelemetry.instrumentation.hypertrace.servlet.common;
+
+import io.opentelemetry.trace.Span;
+import javax.servlet.http.HttpServletRequest;
+import javax.servlet.http.HttpSession;
+import org.hypertrace.agent.core.HypertraceSemanticAttributes;
+
+public class ServletSpanDecorator {
+
+  private ServletSpanDecorator() {}
+
+  public static void addSessionId(Span span, HttpServletRequest httpRequest) {
+    if (httpRequest.isRequestedSessionIdValid()) {
+      HttpSession session = httpRequest.getSession();
+      if (session != null && session.getId() != "") {
+        span.setAttribute(HypertraceSemanticAttributes.HTTP_REQUEST_SESSION_ID, session.getId());
+      }
+    }
+  }
+}
diff --git a/instrumentation/spark-web-framework-2.3/src/main/java/io/opentelemetry/instrumentation/hypertrace/sparkjava/SparkJavaBodyInstrumentation.java b/instrumentation/spark-web-framework-2.3/src/main/java/io/opentelemetry/instrumentation/hypertrace/sparkjava/SparkJavaBodyInstrumentation.java
@@ -24,6 +24,7 @@
 import static net.bytebuddy.matcher.ElementMatchers.takesArgument;
 
 import com.google.auto.service.AutoService;
+import io.opentelemetry.instrumentation.hypertrace.servlet.common.ServletSpanDecorator;
 import io.opentelemetry.instrumentation.hypertrace.servlet.v3_1.BufferingHttpServletRequest;
 import io.opentelemetry.instrumentation.hypertrace.servlet.v3_1.BufferingHttpServletResponse;
 import io.opentelemetry.javaagent.tooling.Instrumenter;
@@ -91,6 +92,7 @@ public String[] helperClassNames() {
       "io.opentelemetry.instrumentation.hypertrace.servlet.common.CharBufferData",
       "io.opentelemetry.instrumentation.hypertrace.servlet.common.BufferedWriterWrapper",
       "io.opentelemetry.instrumentation.hypertrace.servlet.common.BufferedReaderWrapper",
+      "io.opentelemetry.instrumentation.hypertrace.servlet.common.ServletSpanDecorator",
       "io.opentelemetry.instrumentation.hypertrace.servlet.v3_1.BufferingHttpServletResponse",
       "io.opentelemetry.instrumentation.hypertrace.servlet.v3_1.BufferingHttpServletResponse$BufferingServletOutputStream",
       "io.opentelemetry.instrumentation.hypertrace.servlet.v3_1.BufferingHttpServletRequest",
@@ -119,6 +121,8 @@ public static Object onEnter(
       response = new BufferingHttpServletResponse(httpResponse);
       request = new BufferingHttpServletRequest(httpRequest, (HttpServletResponse) response);
 
+      ServletSpanDecorator.addSessionId(currentSpan, httpRequest);
+
       Enumeration<String> headerNames = httpRequest.getHeaderNames();
       Map<String, String> headers = new HashMap<>();
       while (headerNames.hasMoreElements()) {
diff --git a/javaagent-core/src/main/java/org/hypertrace/agent/core/HypertraceSemanticAttributes.java b/javaagent-core/src/main/java/org/hypertrace/agent/core/HypertraceSemanticAttributes.java
@@ -39,4 +39,7 @@ public static AttributeKey<String> httpResponseHeader(String header) {
   public static final AttributeKey<Boolean> OPA_RESULT = booleanKey("hypertrace.opa.result");
 
   public static final AttributeKey<String> OPA_REASON = stringKey("hypertrace.opa.reason");
+
+  public static final AttributeKey<String> HTTP_REQUEST_SESSION_ID =
+      stringKey("http.request.session_id");
 }

Original file line number	Diff line number	Diff line change
`@@ -4,4 +4,5 @@ plugins {`
`4`	`4`
`5`	`5`	`dependencies {`
`6`	`6`	`compileOnly("javax.servlet:servlet-api:2.3")`
	`7`	`+ api("io.opentelemetry:opentelemetry-api:0.9.1")`
`7`	`8`	`}`
Original file line number	Diff line number	Diff line change
`@@ -39,4 +39,7 @@ public static AttributeKey<String> httpResponseHeader(String header) {`
`39`	`39`	`public static final AttributeKey<Boolean> OPA_RESULT = booleanKey("hypertrace.opa.result");`
`40`	`40`
`41`	`41`	`public static final AttributeKey<String> OPA_REASON = stringKey("hypertrace.opa.reason");`
	`42`	`+`
	`43`	`+ public static final AttributeKey<String> HTTP_REQUEST_SESSION_ID =`
	`44`	`+ stringKey("http.request.session_id");`
`42`	`45`	`}`