Merge pull request #8 from Dynatrace/addIncomingWebrequests

Add incoming webrequests

Author: Sonja Chèvre

README.md

@@ -20,6 +20,7 @@ This is the official Java implementation of the [Dynatrace OneAgent SDK](https:/
  	* [Trace incoming and outgoing remote calls](#remoting)
  	* [In process linking](#inprocess)
  	* [Add custom request attributes](#scav)
+ 	* [Trace incoming web requests](#webrequests)
 * [Further reading](#furtherreading)
 * [Help & Support](#help)
 * [Release notes](#releasenotes)
@@ -41,6 +42,7 @@ This is the official Java implementation of the [Dynatrace OneAgent SDK](https:/
 
 |OneAgent SDK for Java|Required OneAgent version|
 |:--------------------|:------------------------|
+|1.3.0                |>=1.149                  |
 |1.2.0                |>=1.147                  |
 |1.1.0                |>=1.143                  |
 |1.0.3                |>=1.135                  |
@@ -57,7 +59,7 @@ If you want to integrate the OneAgent SDK into your application, just add the fo
 	<dependency>
 	  <groupId>com.dynatrace.oneagent.sdk.java</groupId>
 	  <artifactId>oneagent-sdk</artifactId>
-	  <version>1.2.0</version>
+	  <version>1.3.0</version>
 	  <scope>compile</scope>
 	</dependency>
 
@@ -128,6 +130,7 @@ A more detailed specification of the features can be found in [Dynatrace OneAgen
 
 |Feature                                   |Required OneAgent SDK for Java version|
 |:-----------------------------------------|:-------------------------------------|
+|Incoming webrequests                      |>=1.3.0                               |
 |Custom request attributes                 |>=1.2.0                               |
 |In process linking                        |>=1.1.0                               |
 |Trace incoming and outgoing remote calls  |>=1.0.3                               |
@@ -213,6 +216,48 @@ oneAgentSDK.addCustomRequestAttribute("salesAmount", 2500);
 
 When no service call is being traced, the custom request attributes are dropped.
 
+<a name="webrequests"/>
+
+## Trace incoming web requests
+
+You can use the SDK to trace incoming web requests. This might be useful if Dynatrace does not support the respective web server framework or language.
+
+To trace any kind of incoming web request you first need to create a WebServerInfo object. The info object represents the endpoint of your web server (webservername, applicationname and context root). This object should be reused for all traced webrequests for the same application.
+
+```Java
+WebServerInfo wsInfo = OneAgentSDK.createWebServerInfo("WebShopProduction", "CheckoutService", "/api/service/checkout");
+```
+
+To trace a specific incoming web request you then need to create a Tracer object. It is important to provide all http headers from the request to the SDK by calling addRequestHeader(...). This ensures that tagging with our built-in sensor is working.
+
+```Java
+IncomingWebRequestTracer tracer = OneAgentSDK.traceIncomingWebRequest(wsInfo,"https://www.oursupershop.com/api/service/checkout/save","POST")
+
+for (Entry<String, String> headerField : httpRequest.getHeaders().entrySet()) {
+	incomingWebrequestTracer.addRequestHeader(headerField.getKey(), headerField.getValue());
+}
+
+for (Entry<String, List<String>> parameterEntry : httpRequest.getParameters().entrySet()) {
+	for (String value : parameterEntry.getValue()) {
+		incomingWebrequestTracer.addParameter(parameterEntry.getKey(), value);
+	}
+}
+
+incomingWebrequestTracer.setRemoteAddress(httpRequest.getRemoteHostName());
+
+tracer.start();
+try {
+	int statusCodeReturnedToClient = processWebRequest();
+	tracer.setStatusCode(statusCodeReturnedToClient);
+} catch (Exception e) {
+	tracer.setStatusCode(500); // we expect, the container sends http 500 in case request processing throws an exception
+	tracer.error(e);
+	throw e;
+} finally {
+	tracer.end();
+}
+```
+
 <a name="furtherreading" />
 
 ## Further readings
@@ -252,6 +297,7 @@ see also https://github.com/Dynatrace/OneAgent-SDK-for-Java/releases
 
 |Version|Description                            |Links                                    |
 |:------|:--------------------------------------|:----------------------------------------|
+|1.3.0  |Added support for incoming webrequests |[binary](https://search.maven.org/remotecontent?filepath=com/dynatrace/oneagent/sdk/java/oneagent-sdk/1.3.0/oneagent-sdk-1.3.0.jar) [source](https://search.maven.org/remotecontent?filepath=com/dynatrace/oneagent/sdk/java/oneagent-sdk/1.3.0/oneagent-sdk-1.3.0-sources.jar) [javadoc](https://search.maven.org/remotecontent?filepath=com/dynatrace/oneagent/sdk/java/oneagent-sdk/1.3.0/oneagent-sdk-1.3.0-javadoc.jar)|
 |1.2.0  |Added support for in-process-linking   |[binary](https://search.maven.org/remotecontent?filepath=com/dynatrace/oneagent/sdk/java/oneagent-sdk/1.2.0/oneagent-sdk-1.2.0.jar) [source](https://search.maven.org/remotecontent?filepath=com/dynatrace/oneagent/sdk/java/oneagent-sdk/1.2.0/oneagent-sdk-1.2.0-sources.jar) [javadoc](https://search.maven.org/remotecontent?filepath=com/dynatrace/oneagent/sdk/java/oneagent-sdk/1.2.0/oneagent-sdk-1.2.0-javadoc.jar)|
 |1.1.0  |Added support for in-process-linking   |[binary](https://search.maven.org/remotecontent?filepath=com/dynatrace/oneagent/sdk/java/oneagent-sdk/1.1.0/oneagent-sdk-1.1.0.jar) [source](https://search.maven.org/remotecontent?filepath=com/dynatrace/oneagent/sdk/java/oneagent-sdk/1.1.0/oneagent-sdk-1.1.0-sources.jar) [javadoc](https://search.maven.org/remotecontent?filepath=com/dynatrace/oneagent/sdk/java/oneagent-sdk/1.1.0/oneagent-sdk-1.1.0-javadoc.jar)|
 |1.0.3  |Initial release                        |[binary](https://search.maven.org/remotecontent?filepath=com/dynatrace/oneagent/sdk/java/oneagent-sdk/1.0.3/oneagent-sdk-1.0.3.jar) [source](https://search.maven.org/remotecontent?filepath=com/dynatrace/oneagent/sdk/java/oneagent-sdk/1.0.3/oneagent-sdk-1.0.3-sources.jar) [javadoc](https://search.maven.org/remotecontent?filepath=com/dynatrace/oneagent/sdk/java/oneagent-sdk/1.0.3/oneagent-sdk-1.0.3-javadoc.jar)|

docs/allclasses-frame.html

@@ -2,12 +2,12 @@
 <!--NewPage-->
 <HTML>
 <HEAD>
-<!-- Generated by javadoc (build 1.6.0_45) on Thu May 24 14:52:46 CEST 2018 -->
+<!-- Generated by javadoc (build 1.6.0_45) on Thu Jun 07 11:05:10 CEST 2018 -->
 <TITLE>
-All Classes (sdk 1.2.0 API)
+All Classes (sdk 1.3.0 API)
 </TITLE>
 
-<META NAME="date" CONTENT="2018-05-24">
+<META NAME="date" CONTENT="2018-06-07">
 
 <LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
 
@@ -27,6 +27,8 @@
 <BR>
 <A HREF="com/dynatrace/oneagent/sdk/api/IncomingTaggable.html" title="interface in com.dynatrace.oneagent.sdk.api" target="classFrame"><I>IncomingTaggable</I></A>
 <BR>
+<A HREF="com/dynatrace/oneagent/sdk/api/IncomingWebRequestTracer.html" title="interface in com.dynatrace.oneagent.sdk.api" target="classFrame"><I>IncomingWebRequestTracer</I></A>
+<BR>
 <A HREF="com/dynatrace/oneagent/sdk/api/InProcessLink.html" title="interface in com.dynatrace.oneagent.sdk.api" target="classFrame"><I>InProcessLink</I></A>
 <BR>
 <A HREF="com/dynatrace/oneagent/sdk/api/InProcessLinkTracer.html" title="interface in com.dynatrace.oneagent.sdk.api" target="classFrame"><I>InProcessLinkTracer</I></A>
@@ -45,6 +47,8 @@
 <BR>
 <A HREF="com/dynatrace/oneagent/sdk/api/Tracer.html" title="interface in com.dynatrace.oneagent.sdk.api" target="classFrame"><I>Tracer</I></A>
 <BR>
+<A HREF="com/dynatrace/oneagent/sdk/api/infos/WebApplicationInfo.html" title="interface in com.dynatrace.oneagent.sdk.api.infos" target="classFrame"><I>WebApplicationInfo</I></A>
+<BR>
 </FONT></TD>
 </TR>
 </TABLE>

docs/allclasses-noframe.html

@@ -2,12 +2,12 @@
 <!--NewPage-->
 <HTML>
 <HEAD>
-<!-- Generated by javadoc (build 1.6.0_45) on Thu May 24 14:52:46 CEST 2018 -->
+<!-- Generated by javadoc (build 1.6.0_45) on Thu Jun 07 11:05:10 CEST 2018 -->
 <TITLE>
-All Classes (sdk 1.2.0 API)
+All Classes (sdk 1.3.0 API)
 </TITLE>
 
-<META NAME="date" CONTENT="2018-05-24">
+<META NAME="date" CONTENT="2018-06-07">
 
 <LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
 
@@ -27,6 +27,8 @@
 <BR>
 <A HREF="com/dynatrace/oneagent/sdk/api/IncomingTaggable.html" title="interface in com.dynatrace.oneagent.sdk.api"><I>IncomingTaggable</I></A>
 <BR>
+<A HREF="com/dynatrace/oneagent/sdk/api/IncomingWebRequestTracer.html" title="interface in com.dynatrace.oneagent.sdk.api"><I>IncomingWebRequestTracer</I></A>
+<BR>
 <A HREF="com/dynatrace/oneagent/sdk/api/InProcessLink.html" title="interface in com.dynatrace.oneagent.sdk.api"><I>InProcessLink</I></A>
 <BR>
 <A HREF="com/dynatrace/oneagent/sdk/api/InProcessLinkTracer.html" title="interface in com.dynatrace.oneagent.sdk.api"><I>InProcessLinkTracer</I></A>
@@ -45,6 +47,8 @@
 <BR>
 <A HREF="com/dynatrace/oneagent/sdk/api/Tracer.html" title="interface in com.dynatrace.oneagent.sdk.api"><I>Tracer</I></A>
 <BR>
+<A HREF="com/dynatrace/oneagent/sdk/api/infos/WebApplicationInfo.html" title="interface in com.dynatrace.oneagent.sdk.api.infos"><I>WebApplicationInfo</I></A>
+<BR>
 </FONT></TD>
 </TR>
 </TABLE>

docs/com/dynatrace/oneagent/sdk/OneAgentSDKFactory.html

@@ -2,20 +2,20 @@
 <!--NewPage-->
 <HTML>
 <HEAD>
-<!-- Generated by javadoc (build 1.6.0_45) on Thu May 24 14:52:46 CEST 2018 -->
+<!-- Generated by javadoc (build 1.6.0_45) on Thu Jun 07 11:05:09 CEST 2018 -->
 <TITLE>
-OneAgentSDKFactory (sdk 1.2.0 API)
+OneAgentSDKFactory (sdk 1.3.0 API)
 </TITLE>
 
-<META NAME="date" CONTENT="2018-05-24">
+<META NAME="date" CONTENT="2018-06-07">
 
 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
 
 <SCRIPT type="text/javascript">
 function windowTitle()
 {
     if (location.href.indexOf('is-external=true') == -1) {
-        parent.document.title="OneAgentSDKFactory (sdk 1.2.0 API)";
+        parent.document.title="OneAgentSDKFactory (sdk 1.3.0 API)";
     }
 }
 </SCRIPT>

docs/com/dynatrace/oneagent/sdk/api/InProcessLink.html

@@ -2,20 +2,20 @@
 <!--NewPage-->
 <HTML>
 <HEAD>
-<!-- Generated by javadoc (build 1.6.0_45) on Thu May 24 14:52:46 CEST 2018 -->
+<!-- Generated by javadoc (build 1.6.0_45) on Thu Jun 07 11:05:09 CEST 2018 -->
 <TITLE>
-InProcessLink (sdk 1.2.0 API)
+InProcessLink (sdk 1.3.0 API)
 </TITLE>
 
-<META NAME="date" CONTENT="2018-05-24">
+<META NAME="date" CONTENT="2018-06-07">
 
 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
 
 <SCRIPT type="text/javascript">
 function windowTitle()
 {
     if (location.href.indexOf('is-external=true') == -1) {
-        parent.document.title="InProcessLink (sdk 1.2.0 API)";
+        parent.document.title="InProcessLink (sdk 1.3.0 API)";
     }
 }
 </SCRIPT>
@@ -54,7 +54,7 @@
 
 <TR>
 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
-&nbsp;<A HREF="../../../../../com/dynatrace/oneagent/sdk/api/IncomingTaggable.html" title="interface in com.dynatrace.oneagent.sdk.api"><B>PREV CLASS</B></A>&nbsp;
+&nbsp;<A HREF="../../../../../com/dynatrace/oneagent/sdk/api/IncomingWebRequestTracer.html" title="interface in com.dynatrace.oneagent.sdk.api"><B>PREV CLASS</B></A>&nbsp;
 &nbsp;<A HREF="../../../../../com/dynatrace/oneagent/sdk/api/InProcessLinkTracer.html" title="interface in com.dynatrace.oneagent.sdk.api"><B>NEXT CLASS</B></A></FONT></TD>
 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
   <A HREF="../../../../../index.html?com/dynatrace/oneagent/sdk/api/InProcessLink.html" target="_top"><B>FRAMES</B></A>  &nbsp;
@@ -141,7 +141,7 @@ <H2>
 
 <TR>
 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
-&nbsp;<A HREF="../../../../../com/dynatrace/oneagent/sdk/api/IncomingTaggable.html" title="interface in com.dynatrace.oneagent.sdk.api"><B>PREV CLASS</B></A>&nbsp;
+&nbsp;<A HREF="../../../../../com/dynatrace/oneagent/sdk/api/IncomingWebRequestTracer.html" title="interface in com.dynatrace.oneagent.sdk.api"><B>PREV CLASS</B></A>&nbsp;
 &nbsp;<A HREF="../../../../../com/dynatrace/oneagent/sdk/api/InProcessLinkTracer.html" title="interface in com.dynatrace.oneagent.sdk.api"><B>NEXT CLASS</B></A></FONT></TD>
 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
   <A HREF="../../../../../index.html?com/dynatrace/oneagent/sdk/api/InProcessLink.html" target="_top"><B>FRAMES</B></A>  &nbsp;

docs/com/dynatrace/oneagent/sdk/api/InProcessLinkTracer.html

@@ -2,20 +2,20 @@
 <!--NewPage-->
 <HTML>
 <HEAD>
-<!-- Generated by javadoc (build 1.6.0_45) on Thu May 24 14:52:46 CEST 2018 -->
+<!-- Generated by javadoc (build 1.6.0_45) on Thu Jun 07 11:05:09 CEST 2018 -->
 <TITLE>
-InProcessLinkTracer (sdk 1.2.0 API)
+InProcessLinkTracer (sdk 1.3.0 API)
 </TITLE>
 
-<META NAME="date" CONTENT="2018-05-24">
+<META NAME="date" CONTENT="2018-06-07">
 
 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
 
 <SCRIPT type="text/javascript">
 function windowTitle()
 {
     if (location.href.indexOf('is-external=true') == -1) {
-        parent.document.title="InProcessLinkTracer (sdk 1.2.0 API)";
+        parent.document.title="InProcessLinkTracer (sdk 1.3.0 API)";
     }
 }
 </SCRIPT>

docs/com/dynatrace/oneagent/sdk/api/IncomingRemoteCallTracer.html

@@ -2,20 +2,20 @@
 <!--NewPage-->
 <HTML>
 <HEAD>
-<!-- Generated by javadoc (build 1.6.0_45) on Thu May 24 14:52:46 CEST 2018 -->
+<!-- Generated by javadoc (build 1.6.0_45) on Thu Jun 07 11:05:09 CEST 2018 -->
 <TITLE>
-IncomingRemoteCallTracer (sdk 1.2.0 API)
+IncomingRemoteCallTracer (sdk 1.3.0 API)
 </TITLE>
 
-<META NAME="date" CONTENT="2018-05-24">
+<META NAME="date" CONTENT="2018-06-07">
 
 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
 
 <SCRIPT type="text/javascript">
 function windowTitle()
 {
     if (location.href.indexOf('is-external=true') == -1) {
-        parent.document.title="IncomingRemoteCallTracer (sdk 1.2.0 API)";
+        parent.document.title="IncomingRemoteCallTracer (sdk 1.3.0 API)";
     }
 }
 </SCRIPT>

docs/com/dynatrace/oneagent/sdk/api/IncomingTaggable.html

@@ -2,20 +2,20 @@
 <!--NewPage-->
 <HTML>
 <HEAD>
-<!-- Generated by javadoc (build 1.6.0_45) on Thu May 24 14:52:46 CEST 2018 -->
+<!-- Generated by javadoc (build 1.6.0_45) on Thu Jun 07 11:05:09 CEST 2018 -->
 <TITLE>
-IncomingTaggable (sdk 1.2.0 API)
+IncomingTaggable (sdk 1.3.0 API)
 </TITLE>
 
-<META NAME="date" CONTENT="2018-05-24">
+<META NAME="date" CONTENT="2018-06-07">
 
 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
 
 <SCRIPT type="text/javascript">
 function windowTitle()
 {
     if (location.href.indexOf('is-external=true') == -1) {
-        parent.document.title="IncomingTaggable (sdk 1.2.0 API)";
+        parent.document.title="IncomingTaggable (sdk 1.3.0 API)";
     }
 }
 </SCRIPT>
@@ -55,7 +55,7 @@
 <TR>
 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 &nbsp;<A HREF="../../../../../com/dynatrace/oneagent/sdk/api/IncomingRemoteCallTracer.html" title="interface in com.dynatrace.oneagent.sdk.api"><B>PREV CLASS</B></A>&nbsp;
-&nbsp;<A HREF="../../../../../com/dynatrace/oneagent/sdk/api/InProcessLink.html" title="interface in com.dynatrace.oneagent.sdk.api"><B>NEXT CLASS</B></A></FONT></TD>
+&nbsp;<A HREF="../../../../../com/dynatrace/oneagent/sdk/api/IncomingWebRequestTracer.html" title="interface in com.dynatrace.oneagent.sdk.api"><B>NEXT CLASS</B></A></FONT></TD>
 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
   <A HREF="../../../../../index.html?com/dynatrace/oneagent/sdk/api/IncomingTaggable.html" target="_top"><B>FRAMES</B></A>  &nbsp;
 &nbsp;<A HREF="IncomingTaggable.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
@@ -91,7 +91,7 @@ <H2>
 <BR>
 Interface IncomingTaggable</H2>
 <DL>
-<DT><B>All Known Subinterfaces:</B> <DD><A HREF="../../../../../com/dynatrace/oneagent/sdk/api/IncomingRemoteCallTracer.html" title="interface in com.dynatrace.oneagent.sdk.api">IncomingRemoteCallTracer</A></DD>
+<DT><B>All Known Subinterfaces:</B> <DD><A HREF="../../../../../com/dynatrace/oneagent/sdk/api/IncomingRemoteCallTracer.html" title="interface in com.dynatrace.oneagent.sdk.api">IncomingRemoteCallTracer</A>, <A HREF="../../../../../com/dynatrace/oneagent/sdk/api/IncomingWebRequestTracer.html" title="interface in com.dynatrace.oneagent.sdk.api">IncomingWebRequestTracer</A></DD>
 </DL>
 <HR>
 <DL>
@@ -209,7 +209,7 @@ <H2>
 <TR>
 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 &nbsp;<A HREF="../../../../../com/dynatrace/oneagent/sdk/api/IncomingRemoteCallTracer.html" title="interface in com.dynatrace.oneagent.sdk.api"><B>PREV CLASS</B></A>&nbsp;
-&nbsp;<A HREF="../../../../../com/dynatrace/oneagent/sdk/api/InProcessLink.html" title="interface in com.dynatrace.oneagent.sdk.api"><B>NEXT CLASS</B></A></FONT></TD>
+&nbsp;<A HREF="../../../../../com/dynatrace/oneagent/sdk/api/IncomingWebRequestTracer.html" title="interface in com.dynatrace.oneagent.sdk.api"><B>NEXT CLASS</B></A></FONT></TD>
 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
   <A HREF="../../../../../index.html?com/dynatrace/oneagent/sdk/api/IncomingTaggable.html" target="_top"><B>FRAMES</B></A>  &nbsp;
 &nbsp;<A HREF="IncomingTaggable.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;