CS review

alramlechner · alramlechner · commit 6d9b25310130 · 2018-01-24T07:20:00.000+01:00
diff --git a/README.md b/README.md
@@ -2,18 +2,18 @@
 
 # Dynatrace OneAgent SDK for Java
 
-This SDK allows Dynatrace customers to instrument java applications. This is useful to enhance the visibility for prioritary frameworks or custom framework not directly supported by Dynatrace OneAgent out of the box.
+This SDK allows Dynatrace customers to instrument java applications. This is useful to enhance the visibility for proprietary frameworks or custom frameworks not directly supported by Dynatrace OneAgent out-of-the-box.
 
-It provides the java implementation of the [Dynatrace OneAgent SDK](https://github.com/Dynatrace/OneAgent-SDK). 
+It provides the Java implementation of the [Dynatrace OneAgent SDK](https://github.com/Dynatrace/OneAgent-SDK). 
 
 ## Package contents
 
 - `samples`: contains sample application, which demonstrates the usage of the SDK. see readme inside the samples directory for more details
 - `LICENSE`: license under which the whole SDK and sample applications are published
 
 ## Features
-Dynatrace OneAgent SDK for Java adds support for following features (corresponding to features specified in [Dynatrace OneAgent SDK](https://github.com/Dynatrace/OneAgent-SDK)):
--  outgoing and incoming remote call
+Dynatrace OneAgent SDK for Java currently implements support for the following features (corresponding to features specified in [Dynatrace OneAgent SDK](https://github.com/Dynatrace/OneAgent-SDK)):
+-  outgoing and incoming remote calls
 
 ## Integrating into your application
 
@@ -34,11 +34,11 @@ If you prefer to integrate the SDK using plain jar file, just download them from
 The Dynatrace OneAgent SDK for Java has no further dependencies.
 
 ### Troubleshooting
-If the SDK can't connect to the OneAgent (see usage of SDKState in samples) or you you don't see the desired result in the Dynatrace UI, you might set the following system property to print debug information to standard out:
+If the SDK can't connect to the OneAgent (see usage of SDKState in samples) or you you don't see the desired result in the Dynatrace UI, you can set the following system property to print debug information to standard out:
 	
 	-Dcom.dynatrace.oneagent.sdk.debug=true
 
-This will provide SDK related debug information in agent log. Additionally ensure, that you have set an `LoggingCallback` in your application. For usage see class `StdErrLoggingCallback` in `remotecall-server` module (in samples/remotecall folder).
+Additionally you should/have to ensure, that you have set a `LoggingCallback`. For usage see class `StdErrLoggingCallback` in `remotecall-server` module (in samples/remotecall folder).
 
 ## OneAgent SDK for Java Requirements
 
@@ -52,7 +52,7 @@ This will provide SDK related debug information in agent log. Additionally ensur
 
 ## Feedback
 
-In case of questions, issues or feature requests feel free to contact [Michael Kopp](https://github.com/mikopp) or [Alram Lechner](https://github.com/AlramLechnerDynatrace). Your feedback is welcome!
+In case of questions, issues or feature requests feel free to contact [Michael Kopp](https://github.com/mikopp), [Alram Lechner](https://github.com/AlramLechnerDynatrace) or file an issue. Your feedback is welcome!
 
 
 ## OneAgent SDK for Java release notes
diff --git a/samples/README.md b/samples/README.md
@@ -4,7 +4,7 @@ Sample applications showing how to use Dynatrace OneAgent SDK for Java to create
 
 ## Contents
 
-- `remotecall`: shows usage of remote call API. Allows you to tag remote calls in same or between different JVM's.  
+- `remotecall`: shows usage of remote call API. Allows you to tag remote calls in the same or between different JVMs.  
 
 ## Build and prepare running sample applications
 
@@ -14,49 +14,10 @@ Sample applications showing how to use Dynatrace OneAgent SDK for Java to create
 - run `mvn package` in root directory of the desired sample
 
 ### Run RemoteCall sample application
-This Application shows how to trace remote calls and tag them. To run this sample you need to start a server and client sample application - both with Dynatrace agent injected.
+This Application shows how to trace remote calls and tag them. To run this sample you need to start a server and client sample application - both with Dynatrace OneAgent injected.
 
 - Server: `mvn -pl remotecall-server exec:exec`
 
 - Client: `mvn -pl remotecall-client exec:exec`
 
-Check your Dynatrace environment for newly created services.
-
-## Integrating into your application
-If you want to integrate the OneAgent SDK into your application, just add the following maven dependency:
-
-	<dependency>
-	  <groupId>com.dynatrace.oneagent.sdk.java</groupId>
-	  <artifactId>oneagent-sdk</artifactId>
-	  <version>1.0.1</version>
-	  <scope>compile</scope>
-	</dependency>
-
-If you prefer to integrate the SDK using plain jar file, just download them from mavenCentral: FIXME: add link to mavenCentral 
-
-## Troubleshooting
-As long as the SDK can't connect to agent (see output of sample), you might set the following system property to print debug information to standard out:
-	
-	-Dcom.dynatrace.oneagent.sdk.debug=true
-
-As soon as SDK is active, but no paths are shown in Dynatrace UI, enable the agent debug flag:
-	
-	debugOneAgentSdkJava=true
-
-This will provide additional debug information in agent log.
-
-Additionally ensure, that you have set an `LoggingCallback` in your application. For usage see class `StdErrLoggingCallback` in `remotecall-server` module.
-
-## OneAgent SDK for Java Requirements
-- JRE 1.6 or higher
-- Dynatrace OneAgent Java (supported versions see below)
-
-## Compatibility OneAgent SDK for Java releases with OneAgent for Java releases
-|OneAgent SDK for Java|Dynatrace OneAgent Java|
-|:------|:--------|
-|1.0.1  |>=1.135  |
-
-## Release Notes (OneAgent SDK for Java)
-|Version|Date|Description|
-|:------|:----------|:--------------|
-|1.0.1  |01.2018    |Initial release|
+Check your Dynatrace environment for newly created services.
diff --git a/samples/remotecall/remotecall-client/pom.xml b/samples/remotecall/remotecall-client/pom.xml
@@ -24,7 +24,7 @@
           <archive>
             <manifest>
               <addClasspath>true</addClasspath>
-              <mainClass>com.dynatrace.sample.oneagent.sdk.ClientApp</mainClass>
+              <mainClass>com.dynatrace.oneagent.sdk.samples.ClientApp</mainClass>
             </manifest>
           </archive>
         </configuration>
diff --git a/samples/remotecall/remotecall-client/src/main/java/com/dynatrace/oneagent/sdk/samples/ClientApp.java b/samples/remotecall/remotecall-client/src/main/java/com/dynatrace/oneagent/sdk/samples/ClientApp.java
@@ -1,4 +1,4 @@
-package com.dynatrace.sample.oneagent.sdk;
+package com.dynatrace.oneagent.sdk.samples;
 
 /*
  * Copyright 2018 Dynatrace LLC
@@ -37,10 +37,10 @@ private ClientApp() {
 			break;
 		case PERMANENTLY_INACTIVE:
 			System.err.println(
-					"SDK is PERMANENTLY_INACTIVE; Probably no agent injected or agent is incompatible with SDK.");
+					"SDK is PERMANENTLY_INACTIVE; Probably no OneAgent injected or OneAgent is incompatible with SDK.");
 			break;
 		case TEMPORARILY_INACTIVE:
-			System.err.println("SDK is TEMPORARILY_INACTIVE; Agent has been deactived - check agent configuration.");
+			System.err.println("SDK is TEMPORARILY_INACTIVE; OneAgent has been deactivated - check OneAgent configuration.");
 			break;
 		default:
 			System.err.println("SDK is in unknown state.");
@@ -62,12 +62,12 @@ public static void main(String args[]) {
 		}
 		try {
 			new ClientApp().run(port);
-			System.out.println("remote call client finished. sleeping a while, so agent is able to send data to server ...");
-			Thread.sleep(15000); // we have to wait - so agent is able to send data to server.
+			System.out.println("remote call client finished. sleeping a while, so OneAgent is able to send data to server ...");
+			Thread.sleep(15000); // we have to wait - so OneAgent is able to send data to server.
 		} catch (Exception e) {
 			System.err.println("remote call client failed: " + e.getMessage());
 			e.printStackTrace();
-			System.exit(-1);
+			System.exit(1);
 		}
 	}
 
@@ -79,7 +79,6 @@ private void run(int port) throws IOException, ClassNotFoundException {
 					+ " connected");
 			ObjectOutputStream out = new ObjectOutputStream(socket.getOutputStream());
 			traceCallToServer(out, port);
-
 		} finally {
 			socket.close();
 		}
@@ -102,6 +101,7 @@ private void traceCallToServer(ObjectOutputStream out, int port) throws IOExcept
 	private void invokeCallToServer(ObjectOutputStream out, String outgoingTag) throws IOException {
 		// call the server and send the tag
 		out.writeObject(outgoingTag);
+		out.writeObject("the top secret message");
 	}
 	
 }
diff --git a/samples/remotecall/remotecall-server/pom.xml b/samples/remotecall/remotecall-server/pom.xml
@@ -24,7 +24,7 @@
           <archive>
             <manifest>
               <addClasspath>true</addClasspath>
-              <mainClass>com.dynatrace.sample.oneagent.sdk.ServerApp</mainClass>
+              <mainClass>com.dynatrace.oneagent.sdk.samples.ServerApp</mainClass>
             </manifest>
           </archive>
         </configuration>
diff --git a/samples/remotecall/remotecall-server/src/main/java/com/dynatrace/oneagent/sdk/samples/ServerApp.java b/samples/remotecall/remotecall-server/src/main/java/com/dynatrace/oneagent/sdk/samples/ServerApp.java
@@ -1,4 +1,4 @@
-package com.dynatrace.sample.oneagent.sdk;
+package com.dynatrace.oneagent.sdk.samples;
 
 /*
  * Copyright 2018 Dynatrace LLC
@@ -26,13 +26,12 @@
 import com.dynatrace.oneagent.sdk.api.OneAgentSDK;
 
 /**
- * ServerApp is listing for
+ * ServerApp is listing for remote call requests from remote-call client.
  * 
  * @author Alram.Lechner
  *
  */
 public class ServerApp {
-
 	
 	private final OneAgentSDK oneAgentSdk;
 
@@ -45,10 +44,10 @@ private ServerApp() {
 			break;
 		case PERMANENTLY_INACTIVE:
 			System.err.println(
-					"SDK is PERMANENT_INACTIVE; Probably no agent injected or agent is incompatible with SDK.");
+					"SDK is PERMANENT_INACTIVE; Probably no OneAgent injected or OneAgent is incompatible with SDK.");
 			break;
 		case TEMPORARILY_INACTIVE:
-			System.err.println("SDK is TEMPORARY_INACTIVE; Agent has been deactived - check agent configuration.");
+			System.err.println("SDK is TEMPORARY_INACTIVE; OneAgent has been deactivated - check OneAgent configuration.");
 			break;
 		default:
 			System.err.println("SDK is in unknown state.");
@@ -70,8 +69,8 @@ public static void main(String args[]) {
 		}
 		try {
 			new ServerApp().run(port);
-			System.out.println("remote call server stopped. sleeping a while, so agent is able to send data to server ...");
-			Thread.sleep(15000); // we have to wait - so agent is able to send data to server.
+			System.out.println("remote call server stopped. sleeping a while, so OneAgent is able to send data to server ...");
+			Thread.sleep(15000); // we have to wait - so OneAgent is able to send data to server.
 		} catch (Exception e) {
 			System.err.println("remote call server failed: " + e.getMessage());
 			e.printStackTrace();
@@ -82,16 +81,18 @@ public static void main(String args[]) {
 	private void run(int port) throws IOException, ClassNotFoundException {
 		ServerSocket serverSocket = new ServerSocket(port);
 		try {
-			System.out.println("Waiting for clients no port " + serverSocket.getInetAddress().getHostName() + ":"
+			System.out.println("Waiting for clients on port " + serverSocket.getInetAddress().getHostName() + ":"
 					+ serverSocket.getLocalPort());
 			Socket client = serverSocket.accept();
 			try {
 				System.out.println(
 						"Client " + client.getInetAddress().getHostName() + ":" + client.getPort() + " connected");
 				ObjectInputStream in = new ObjectInputStream(client.getInputStream());
-				Object receviedTag = in.readObject();
-				System.out.println("received tag: " + receviedTag.toString());
-				traceClientRequest(receviedTag);
+				
+				Object receivedTag = in.readObject();
+				String receivedMessage = (String) in.readObject();
+				System.out.println("received tag: " + receivedTag.toString());
+				traceCallFromClient(receivedTag, receivedMessage);
 			} finally {
 				client.close();
 			}
@@ -100,7 +101,7 @@ private void run(int port) throws IOException, ClassNotFoundException {
 		}
 	}
 	
-	private void traceClientRequest(Object receivedTag) {
+	private void traceCallFromClient(Object receivedTag, String receivedMessage) {
 		IncomingRemoteCallTracer incomingRemoteCall = oneAgentSdk.traceIncomingRemoteCall("myMethod", "myService", "endpoint");
 		if (receivedTag instanceof String) {
 			incomingRemoteCall.setDynatraceStringTag((String) receivedTag);
@@ -112,7 +113,7 @@ private void traceClientRequest(Object receivedTag) {
 		
 		incomingRemoteCall.start();
 		try {
-			handleClientRequest();
+			handleCallFromClient(receivedMessage);
 		} catch (Exception e) {
 			incomingRemoteCall.error(e);
 		} finally {
@@ -121,8 +122,9 @@ private void traceClientRequest(Object receivedTag) {
 		
 	}
 
-	private void handleClientRequest() {
+	private void handleCallFromClient(String receivedMessage) {
 		// do whatever the server should do ...
+		System.out.println("Received message from client: " + receivedMessage);
 	}
 	
 }
diff --git a/samples/remotecall/remotecall-server/src/main/java/com/dynatrace/oneagent/sdk/samples/StdErrLoggingCallback.java b/samples/remotecall/remotecall-server/src/main/java/com/dynatrace/oneagent/sdk/samples/StdErrLoggingCallback.java
@@ -1,4 +1,4 @@
-package com.dynatrace.sample.oneagent.sdk;
+package com.dynatrace.oneagent.sdk.samples;
 
 /*
  * Copyright 2018 Dynatrace LLC

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-package com.dynatrace.sample.oneagent.sdk;`
	`1`	`+package com.dynatrace.oneagent.sdk.samples;`
`2`	`2`
`3`	`3`	`/*`
`4`	`4`	`* Copyright 2018 Dynatrace LLC`