SF-5575 - adding in tracked function attributes to trace annotation

darinhoward · darinhoward · commit 45f76f796ba3 · 2016-08-19T10:24:37.000-05:00
diff --git a/.gitignore b/.gitignore
@@ -2,4 +2,6 @@
 .project
 .settings
 target
-coverage.ec
+coverage.ec
+.idea
+*.iml
diff --git a/README.md b/README.md
@@ -26,7 +26,17 @@ Add it as a maven dependency:
 
 ## Usage
 
-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.
+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.
+
+
+#### Tracked Functions
+* **trackedFunction**  marks a specific method as a tracked function.
+* **trackedFunctionName** gives control over how the tracked function will be identified in the dashboard. The function
+name can be a `String` and can also include the variables `{{ClassName}}`, `{{MethodName}}` and `{{MethodParameters[#]}}`
+(where `#` is an `int` referencing the parameter index on the annotated method, index starts at 0).
+
 
 ```
 import com.stackify.apm.Trace;
@@ -45,7 +55,19 @@ public class ClassToBeInstrumented
     {
         ...
     }
-    
+
+    @Trace(trackedFunction = true, trackedFunctionName = "Tracked Function Identifier")
+    public void anotherMethodToBeInstrumentedAndMarkedAsTrackedFunction()
+    {
+        ...
+    }
+
+    @Trace(trackedFunction = true, trackedFunctionName = "Tracked Function {{ClassName}} - {{MethodParameters[0]}}")
+    public void anotherMethodToBeInstrumentedAndMarkedAsTrackedFunctionVariable(String value)
+    {
+        ...
+    }
+
     public void notInstrumented()
     {
         ...
diff --git a/src/main/java/com/stackify/apm/Trace.java b/src/main/java/com/stackify/apm/Trace.java
@@ -22,43 +22,59 @@
 
 /**
  * Trace Annotation for Stackify Java APM+
- * 
  * <p>
- * 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 
+ * 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.
- * 
+ * <p>
  * <pre>
  * <code>
  * import com.stackify.apm.Trace;
- * 
+ *
  * {@literal @}Trace
- * public class ClassToBeInstrumented 
+ * public class ClassToBeInstrumented
  * {
  *     {@literal @}Trace
  *     public void methodToBeInstrumented()
  *     {
  *         ...
  *     }
- *     
+ *
  *     {@literal @}Trace
  *     public void anotherMethodToBeInstrumented()
  *     {
  *         ...
  *     }
- *     
+ *
+ *     {@literal @}Trace(trackedFunction = true, trackedFunctionName = "Function Identifier")
+ *     public void anotherMethodToBeInstrumentedAndMarkedAsTrackedFunction()
+ *     {
+ *         ...
+ *     }
+ *
+ *     {@literal @}Trace(trackedFunction = true, trackedFunctionName = "Tracked Function {{ClassName}} - {{MethodParameters[0]}}")
+ *     public void anotherMethodToBeInstrumentedAndMarkedAsTrackedFunctionVariable(String value)
+ *     {
+ *          ...
+ *     }
+ *
  *     public void notInstrumented()
  *     {
  *         ...
  *     }
  * }
- * </code> 
+ * </code>
  * </pre>
  *
  * @author Eric Martin
  */
 @Retention(value = RetentionPolicy.RUNTIME)
 @Target(value = {ElementType.TYPE, ElementType.METHOD})
 public @interface Trace {
+
+    boolean trackedFunction() default false;
+
+    String trackedFunctionName() default "";
+
 }
