You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@phoenix.apache.org by el...@apache.org on 2014/09/19 21:12:59 UTC

svn commit: r1626299 - in /phoenix/site: publish/tracing.html source/src/site/markdown/tracing.md

Author: elilevine
Date: Fri Sep 19 19:12:58 2014
New Revision: 1626299

URL: http://svn.apache.org/r1626299
Log:
Add info on custom annotations to tracing.html

Modified:
    phoenix/site/publish/tracing.html
    phoenix/site/source/src/site/markdown/tracing.md

Modified: phoenix/site/publish/tracing.html
URL: http://svn.apache.org/viewvc/phoenix/site/publish/tracing.html?rev=1626299&r1=1626298&r2=1626299&view=diff
==============================================================================
--- phoenix/site/publish/tracing.html (original)
+++ phoenix/site/publish/tracing.html Fri Sep 19 19:12:58 2014
@@ -1,7 +1,7 @@
 
 <!DOCTYPE html>
 <!--
- Generated by Apache Maven Doxia at 2014-09-04
+ Generated by Apache Maven Doxia at 2014-09-19
  Rendered using Reflow Maven Skin 1.1.0 (http://andriusvelykis.github.io/reflow-maven-skin)
 -->
 <html  xml:lang="en" lang="en">
@@ -269,6 +269,7 @@ Connection conn = DriverManager.getConne
  </div> 
  <p>where columns is either <tt>annotations.aX</tt> or <tt>tags.tX</tt> where <tt>X</tt> is the index of the dynamic column to lookup.</p> 
  <p>For more usage, look at our generic <a class="externalLink" href="https://github.com/apache/phoenix/blob/master/phoenix-core/src/main/java/org/apache/phoenix/trace/TraceReader.java">TraceReader</a> which can programatically read a number of traces from the tracing results table.</p> 
+ <p>Custom annotations can also be passed into Phoenix to be added to traces. Phoenix looks for connection properties whose names start with <tt>phoenix.annotation.</tt> and adds these as annotations to client-side traces. e.g. A connection property <tt>phoenix.annotation.myannotation=abc</tt> will result in annotations with key <tt>myannotation</tt> and value <tt>abc</tt> to be added to traces. Use this feature to link traces to other request identifiers in your system, such as user or session ids.</p> 
 </div>
 			</div>
 		</div>

Modified: phoenix/site/source/src/site/markdown/tracing.md
URL: http://svn.apache.org/viewvc/phoenix/site/source/src/site/markdown/tracing.md?rev=1626299&r1=1626298&r2=1626299&view=diff
==============================================================================
--- phoenix/site/source/src/site/markdown/tracing.md (original)
+++ phoenix/site/source/src/site/markdown/tracing.md Fri Sep 19 19:12:58 2014
@@ -154,3 +154,5 @@ SELECT <columns>
 where columns is either <code>annotations.aX</code> or <code>tags.tX</code> where <code>X</code> is the index of the dynamic column to lookup.
 
 For more usage, look at our generic [TraceReader](https://github.com/apache/phoenix/blob/master/phoenix-core/src/main/java/org/apache/phoenix/trace/TraceReader.java) which can programatically read a number of traces from the tracing results table.
+
+Custom annotations can also be passed into Phoenix to be added to traces. Phoenix looks for connection properties whose names start with `phoenix.annotation.` and adds these as annotations to client-side traces. e.g. A connection property `phoenix.annotation.myannotation=abc` will result in annotations with key `myannotation` and value `abc` to be added to traces. Use this feature to link traces to other request identifiers in your system, such as user or session ids.