Merge branch 'SF-6010'

darinhoward · darinhoward · commit 47f8e8c58b04 · 2018-08-08T10:43:55.000-05:00
diff --git a/README.md b/README.md
@@ -26,6 +26,31 @@ Add it as a maven dependency:
 
 ## Usage
 
+
+### RUM Manual Instrumentation 
+
+Real User Monitoring (RUM) manual instrumentation allows you to specify where the RUM JavaScript block is injected. 
+
+**Note**: Ensure that auto instrumentation is disabled by adding **rum.autoInstrument=false** to **stackify-api.properties** in your application's classpath.
+
+Your application code will need to call out to the Stackify **getRUMJavaScriptBlock()** method in the `<head>` section as detailed below: 
+
+#### JSP Example
+  
+````
+<html>
+  <head> 
+        <%= com.stackify.apm.Stackify.getRUMJavaScriptBlock() %>
+        <script and link tags>
+    </head>
+    <body>
+    ... 
+    </body>
+</html>
+````
+
+### @Trace Annotation
+
 Add custom instrumentation to classes using the @Trace annotation. The annotation needs to be added to
 the class and the method to be instrumented. This is an alternative to adding a custom configuration
 file (stackify-apm.json) to your application.
diff --git a/src/main/java/com/stackify/apm/Stackify.java b/src/main/java/com/stackify/apm/Stackify.java
@@ -0,0 +1,20 @@
+package com.stackify.apm;
+
+/**
+ * Stackify Utility.
+ * Provides function to manually instrument web requests for RUM tracking.
+ *
+ * @author Darin Howard
+ */
+public class Stackify {
+
+    /**
+     * Returns the RUM JavaScript block for tracking the current web request
+     *
+     * @return String javascript script block
+     */
+    public static String getRUMJavaScriptBlock() {
+        return "";
+    }
+
+}
