Author: jyates
Date: Sat Aug 23 00:48:58 2014
New Revision: 1619954

URL: http://svn.apache.org/r1619954
Log:
Updating tracing docs to include actual config values, updating build.sh to 
remove temp file

Modified:
    phoenix/build.sh
    phoenix/phoenix-docs/src/main/org/h2/Driver.java
    phoenix/phoenix-docs/src/main/org/h2/jdbc/JdbcCallableStatement.java
    phoenix/phoenix-docs/src/main/org/h2/jdbc/JdbcConnection.java
    phoenix/phoenix-docs/src/main/org/h2/jdbc/JdbcDatabaseMetaData.java
    phoenix/phoenix-docs/src/main/org/h2/jdbc/JdbcResultSet.java
    phoenix/phoenix-docs/src/main/org/h2/jdbc/JdbcStatement.java
    phoenix/phoenix-docs/src/main/org/h2/jdbcx/JdbcConnectionPool.java
    phoenix/phoenix-docs/src/main/org/h2/jdbcx/JdbcDataSource.java
    phoenix/phoenix-docs/src/main/org/h2/tools/SimpleResultSet.java
    phoenix/site/publish/tracing.html
    phoenix/site/source/src/site/markdown/tracing.md

Modified: phoenix/build.sh
URL: 
http://svn.apache.org/viewvc/phoenix/build.sh?rev=1619954&r1=1619953&r2=1619954&view=diff
==============================================================================
--- phoenix/build.sh (original)
+++ phoenix/build.sh Sat Aug 23 00:48:58 2014
@@ -12,3 +12,11 @@ echo "BUILDING SITE"
 echo "==========================="
 cd ../site/source/
 mvn clean site
+
+echo ""
+echo "Removing temp directories"
+echo "==========================="
+cd ../../
+rm -rf phoenix-docs/temp
+rm -rf phoenix-docs/bin
+rm -rf phoenix-docs/docs

Modified: phoenix/phoenix-docs/src/main/org/h2/Driver.java
URL: 
http://svn.apache.org/viewvc/phoenix/phoenix-docs/src/main/org/h2/Driver.java?rev=1619954&r1=1619953&r2=1619954&view=diff
==============================================================================
--- phoenix/phoenix-docs/src/main/org/h2/Driver.java (original)
+++ phoenix/phoenix-docs/src/main/org/h2/Driver.java Sat Aug 23 00:48:58 2014
@@ -17,7 +17,7 @@ import org.h2.message.DbException;
 import org.h2.message.TraceSystem;
 import org.h2.upgrade.DbUpgrade;
 
-/*## Java 1.7 ##
+//## Java 1.7 ##
 import java.util.logging.Logger;
 //*/
 
@@ -138,7 +138,7 @@ public class Driver implements java.sql.
     /**
      * [Not supported]
      */
-/*## Java 1.7 ##
+//## Java 1.7 ##
     public Logger getParentLogger() {
         return null;
     }

Modified: phoenix/phoenix-docs/src/main/org/h2/jdbc/JdbcCallableStatement.java
URL: 
http://svn.apache.org/viewvc/phoenix/phoenix-docs/src/main/org/h2/jdbc/JdbcCallableStatement.java?rev=1619954&r1=1619953&r2=1619954&view=diff
==============================================================================
--- phoenix/phoenix-docs/src/main/org/h2/jdbc/JdbcCallableStatement.java 
(original)
+++ phoenix/phoenix-docs/src/main/org/h2/jdbc/JdbcCallableStatement.java Sat 
Aug 23 00:48:58 2014
@@ -1440,7 +1440,7 @@ public class JdbcCallableStatement exten
      * @param parameterIndex the parameter index (1, 2, ...)
      * @param type the class of the returned value
      */
-/*## Java 1.7 ##
+//## Java 1.7 ##
     public <T> T getObject(int parameterIndex, Class<T> type) {
         return null;
     }
@@ -1452,7 +1452,7 @@ public class JdbcCallableStatement exten
      * @param parameterName the parameter name
      * @param type the class of the returned value
      */
-/*## Java 1.7 ##
+//## Java 1.7 ##
     public <T> T getObject(String parameterName, Class<T> type) {
         return null;
     }

Modified: phoenix/phoenix-docs/src/main/org/h2/jdbc/JdbcConnection.java
URL: 
http://svn.apache.org/viewvc/phoenix/phoenix-docs/src/main/org/h2/jdbc/JdbcConnection.java?rev=1619954&r1=1619953&r2=1619954&view=diff
==============================================================================
--- phoenix/phoenix-docs/src/main/org/h2/jdbc/JdbcConnection.java (original)
+++ phoenix/phoenix-docs/src/main/org/h2/jdbc/JdbcConnection.java Sat Aug 23 
00:48:58 2014
@@ -49,7 +49,7 @@ import java.sql.SQLXML;
 import java.sql.SQLClientInfoException;
 //*/
 
-/*## Java 1.7 ##
+//## Java 1.7 ##
 import java.util.concurrent.Executor;
 //*/
 
@@ -1678,7 +1678,7 @@ public class JdbcConnection extends Trac
      *
      * @param schema the schema
      */
-/*## Java 1.7 ##
+//## Java 1.7 ##
     public void setSchema(String schema) {
         // not supported
     }
@@ -1687,7 +1687,7 @@ public class JdbcConnection extends Trac
     /**
      * [Not supported]
      */
-/*## Java 1.7 ##
+//## Java 1.7 ##
     public String getSchema() {
         return null;
     }
@@ -1698,7 +1698,7 @@ public class JdbcConnection extends Trac
      *
      * @param executor the executor used by this method
      */
-/*## Java 1.7 ##
+//## Java 1.7 ##
     public void abort(Executor executor) {
         // not supported
     }
@@ -1710,7 +1710,7 @@ public class JdbcConnection extends Trac
      * @param executor the executor used by this method
      * @param milliseconds the TCP connection timeout
      */
-/*## Java 1.7 ##
+//## Java 1.7 ##
     public void setNetworkTimeout(Executor executor, int milliseconds) {
         // not supported
     }
@@ -1719,7 +1719,7 @@ public class JdbcConnection extends Trac
     /**
      * [Not supported]
      */
-/*## Java 1.7 ##
+//## Java 1.7 ##
     public int getNetworkTimeout() {
         return 0;
     }

Modified: phoenix/phoenix-docs/src/main/org/h2/jdbc/JdbcDatabaseMetaData.java
URL: 
http://svn.apache.org/viewvc/phoenix/phoenix-docs/src/main/org/h2/jdbc/JdbcDatabaseMetaData.java?rev=1619954&r1=1619953&r2=1619954&view=diff
==============================================================================
--- phoenix/phoenix-docs/src/main/org/h2/jdbc/JdbcDatabaseMetaData.java 
(original)
+++ phoenix/phoenix-docs/src/main/org/h2/jdbc/JdbcDatabaseMetaData.java Sat Aug 
23 00:48:58 2014
@@ -2885,7 +2885,7 @@ public class JdbcDatabaseMetaData extend
     /**
      * [Not supported]
      */
-    /*## Java 1.7 ##
+    //## Java 1.7 ##
     public boolean generatedKeyAlwaysReturned() {
         return true;
     }
@@ -2902,7 +2902,7 @@ public class JdbcDatabaseMetaData extend
      * @param columnNamePattern null (to get all objects) or a column name
      *            (uppercase for unquoted names)
      */
-    /*## Java 1.7 ##
+    //## Java 1.7 ##
     public ResultSet getPseudoColumns(String catalog, String schemaPattern,
             String tableNamePattern, String columnNamePattern) {
         return null;

Modified: phoenix/phoenix-docs/src/main/org/h2/jdbc/JdbcResultSet.java
URL: 
http://svn.apache.org/viewvc/phoenix/phoenix-docs/src/main/org/h2/jdbc/JdbcResultSet.java?rev=1619954&r1=1619953&r2=1619954&view=diff
==============================================================================
--- phoenix/phoenix-docs/src/main/org/h2/jdbc/JdbcResultSet.java (original)
+++ phoenix/phoenix-docs/src/main/org/h2/jdbc/JdbcResultSet.java Sat Aug 23 
00:48:58 2014
@@ -3431,7 +3431,7 @@ public class JdbcResultSet extends Trace
      * @param columnIndex the column index (1, 2, ...)
      * @param type the class of the returned value
      */
-/*## Java 1.7 ##
+//## Java 1.7 ##
     public <T> T getObject(int columnIndex, Class<T> type) {
         return null;
     }
@@ -3443,7 +3443,7 @@ public class JdbcResultSet extends Trace
      * @param columnName the column name
      * @param type the class of the returned value
      */
-/*## Java 1.7 ##
+//## Java 1.7 ##
     public <T> T getObject(String columnName, Class<T> type) {
         return null;
     }

Modified: phoenix/phoenix-docs/src/main/org/h2/jdbc/JdbcStatement.java
URL: 
http://svn.apache.org/viewvc/phoenix/phoenix-docs/src/main/org/h2/jdbc/JdbcStatement.java?rev=1619954&r1=1619953&r2=1619954&view=diff
==============================================================================
--- phoenix/phoenix-docs/src/main/org/h2/jdbc/JdbcStatement.java (original)
+++ phoenix/phoenix-docs/src/main/org/h2/jdbc/JdbcStatement.java Sat Aug 23 
00:48:58 2014
@@ -876,7 +876,7 @@ public class JdbcStatement extends Trace
     /**
      * [Not supported]
      */
-/*## Java 1.7 ##
+//## Java 1.7 ##
     public void closeOnCompletion() {
         // not supported
     }
@@ -885,7 +885,7 @@ public class JdbcStatement extends Trace
     /**
      * [Not supported]
      */
-/*## Java 1.7 ##
+//## Java 1.7 ##
     public boolean isCloseOnCompletion() {
         return true;
     }

Modified: phoenix/phoenix-docs/src/main/org/h2/jdbcx/JdbcConnectionPool.java
URL: 
http://svn.apache.org/viewvc/phoenix/phoenix-docs/src/main/org/h2/jdbcx/JdbcConnectionPool.java?rev=1619954&r1=1619953&r2=1619954&view=diff
==============================================================================
--- phoenix/phoenix-docs/src/main/org/h2/jdbcx/JdbcConnectionPool.java 
(original)
+++ phoenix/phoenix-docs/src/main/org/h2/jdbcx/JdbcConnectionPool.java Sat Aug 
23 00:48:58 2014
@@ -35,7 +35,7 @@ import org.h2.util.New;
 import org.h2.message.DbException;
 //*/
 
-/*## Java 1.7 ##
+//## Java 1.7 ##
 import java.util.logging.Logger;
 //*/
 
@@ -330,7 +330,7 @@ public class JdbcConnectionPool implemen
     /**
      * [Not supported]
      */
-/*## Java 1.7 ##
+//## Java 1.7 ##
     public Logger getParentLogger() {
         return null;
     }

Modified: phoenix/phoenix-docs/src/main/org/h2/jdbcx/JdbcDataSource.java
URL: 
http://svn.apache.org/viewvc/phoenix/phoenix-docs/src/main/org/h2/jdbcx/JdbcDataSource.java?rev=1619954&r1=1619953&r2=1619954&view=diff
==============================================================================
--- phoenix/phoenix-docs/src/main/org/h2/jdbcx/JdbcDataSource.java (original)
+++ phoenix/phoenix-docs/src/main/org/h2/jdbcx/JdbcDataSource.java Sat Aug 23 
00:48:58 2014
@@ -26,7 +26,7 @@ import org.h2.jdbc.JdbcConnection;
 import org.h2.message.TraceObject;
 import org.h2.util.StringUtils;
 
-/*## Java 1.7 ##
+//## Java 1.7 ##
 import java.util.logging.Logger;
 //*/
 
@@ -381,7 +381,7 @@ public class JdbcDataSource extends Trac
     /**
      * [Not supported]
      */
-/*## Java 1.7 ##
+//## Java 1.7 ##
     public Logger getParentLogger() {
         return null;
     }

Modified: phoenix/phoenix-docs/src/main/org/h2/tools/SimpleResultSet.java
URL: 
http://svn.apache.org/viewvc/phoenix/phoenix-docs/src/main/org/h2/tools/SimpleResultSet.java?rev=1619954&r1=1619953&r2=1619954&view=diff
==============================================================================
--- phoenix/phoenix-docs/src/main/org/h2/tools/SimpleResultSet.java (original)
+++ phoenix/phoenix-docs/src/main/org/h2/tools/SimpleResultSet.java Sat Aug 23 
00:48:58 2014
@@ -853,7 +853,7 @@ public class SimpleResultSet implements 
      * @param columnIndex the column index (1, 2, ...)
      * @param type the class of the returned value
      */
-/*## Java 1.7 ##
+//## Java 1.7 ##
     public <T> T getObject(int columnIndex, Class<T> type) {
         return null;
     }
@@ -865,7 +865,7 @@ public class SimpleResultSet implements 
      * @param columnName the column name
      * @param type the class of the returned value
      */
-/*## Java 1.7 ##
+//## Java 1.7 ##
     public <T> T getObject(String columnName, Class<T> type) {
         return null;
     }

Modified: phoenix/site/publish/tracing.html
URL: 
http://svn.apache.org/viewvc/phoenix/site/publish/tracing.html?rev=1619954&r1=1619953&r2=1619954&view=diff
==============================================================================
--- phoenix/site/publish/tracing.html (original)
+++ phoenix/site/publish/tracing.html Sat Aug 23 00:48:58 2014
@@ -1,7 +1,7 @@
 
 <!DOCTYPE html>
 <!--
- Generated by Apache Maven Doxia at 2014-08-21
+ Generated by Apache Maven Doxia at 2014-08-22
  Rendered using Reflow Maven Skin 1.1.0 
(http://andriusvelykis.github.io/reflow-maven-skin)
 -->
 <html  xml:lang="en" lang="en">
@@ -129,7 +129,7 @@
 <p><b>Writing traces to a phoenix table is not supported on Hadoop1</b></p> 
 <div class="section"> 
  <h2 id="Configuration">Configuration</h2> 
- <p>In the Phoenix release tarball (phoenix-XXXX.tar.gz) for Hadoop2 there are 
two files in the bin/ directory:</p> 
+ <p>There are two key configuration files that you will need to update.</p> 
  <ul> 
   <li>hadoop-metrics2-phoenix.properties</li> 
   <li>hadoop-metrics2-hbase.properties</li> 
@@ -138,13 +138,38 @@
  <p>Put these filse on their respective classpaths and restart the process to 
pick-up the new configurations.</p> 
  <div class="section"> 
   <h3 
id="hadoop-metrics2-phoenix.properties">hadoop-metrics2-phoenix.properties</h3> 
-  <p>This file will configure the <a class="externalLink" 
href="http://hadoop.apache.org/docs/current/api/index.html?org/apache/hadoop/metrics2/package-summary.html";>Hadoop
 Metrics2</a> system for <i>Phoenix clients</i>. By placing the file as-is on 
the classpath you will use the standard Phoenix metrics sink (which collects 
the trace information) and writer (which writes the traces to the Phoenix 
SYSTEM.TRACING_STATS table).</p> 
-  <p>See the properties file for more information on setting your own sinks 
and writer.</p> 
+  <p>This file will configure the <a class="externalLink" 
href="http://hadoop.apache.org/docs/current/api/index.html?org/apache/hadoop/metrics2/package-summary.html";>Hadoop
 Metrics2</a> system for <i>Phoenix clients</i>. </p> 
+  <p>The default properties you should set are:</p> 
+  <div class="source"> 
+   <pre># Sample from all the sources every 10 seconds
+*.period=10
+
+# Write Traces to Phoenix
+##########################
+# ensure that we receive traces on the server
+phoenix.sink.tracing.class=org.apache.phoenix.trace.PhoenixMetricsSink
+# Tell the sink where to write the metrics
+phoenix.sink.tracing.writer-class=org.apache.phoenix.trace.PhoenixTableMetricsWriter
+# Only handle traces with a context of &quot;tracing&quot;
+phoenix.sink.tracing.context=tracing
+</pre> 
+  </div> 
+  <p>This enables standard Phoenix metrics sink (which collects the trace 
information) and writer (writes the traces to the Phoenix SYSTEM.TRACING_STATS 
table). You can modify this to set your own custom classes as well, if you have 
them.</p> 
+  <p>See the properties file in the source (phoenix-hadop2-compat/bin) for 
more information on setting your own sinks and writer.</p> 
  </div> 
  <div class="section"> 
   <h3 
id="hadoop-metrics2-hbase.properties">hadoop-metrics2-hbase.properties</h3> 
-  <p>HBase already comes with a metrics2 configuration, so the metrics2 
configuration included in the phoenix distribution can either replace the 
existing file (if you don’t have any special configurations) or the 
properties can be copied to your exisiting metrics2 configuration file.</p> 
-  <p>They are essentially the same properties as in the 
hadoop-metrics2-phoenix.properties but prefixed by “hbase” rather than 
“phoenix” so they are loaded in the HBase metrics system.</p> 
+  <p>HBase default deployment already comes with a metrics2 configuration, so 
the metrics2 configuration from phoenix can either replace the existing file 
(if you don’t have any special configurations) or the properties can be 
copied to your exisiting metrics2 configuration file.</p> 
+  <div class="source"> 
+   <pre># ensure that we receive traces on the server
+hbase.sink.tracing.class=org.apache.phoenix.trace.PhoenixMetricsSink
+# Tell the sink where to write the metrics
+hbase.sink.tracing.writer-class=org.apache.phoenix.trace.PhoenixTableMetricsWriter
+# Only handle traces with a context of &quot;tracing&quot;
+hbase.sink.tracing.context=tracing
+</pre> 
+  </div> 
+  <p>They are essentially the same properties as in the 
hadoop-metrics2-phoenix.properties but prefixed by “hbase” rather than 
“phoenix” so they are loaded with the rest of the HBase metrics.</p> 
  </div> 
  <div class="section"> 
   <h3 id="Disabling_Tracing"><u>Disabling Tracing</u></h3> 

Modified: phoenix/site/source/src/site/markdown/tracing.md
URL: 
http://svn.apache.org/viewvc/phoenix/site/source/src/site/markdown/tracing.md?rev=1619954&r1=1619953&r2=1619954&view=diff
==============================================================================
--- phoenix/site/source/src/site/markdown/tracing.md (original)
+++ phoenix/site/source/src/site/markdown/tracing.md Sat Aug 23 00:48:58 2014
@@ -8,7 +8,7 @@ We leverage Cloudera's [HTrace](https://
 
 ## Configuration
 
-In the Phoenix release tarball (phoenix-XXXX.tar.gz) for Hadoop2 there are two 
files in the bin/ directory:
+There are two key configuration files that you will need to update.
 
   * hadoop-metrics2-phoenix.properties
   * hadoop-metrics2-hbase.properties
@@ -19,15 +19,42 @@ Put these filse on their respective clas
 
 ### hadoop-metrics2-phoenix.properties
 
-This file will configure the [Hadoop 
Metrics2](http://hadoop.apache.org/docs/current/api/index.html?org/apache/hadoop/metrics2/package-summary.html)
 system for *Phoenix clients*. By placing the file as-is on the classpath you 
will use the standard Phoenix metrics sink (which collects the trace 
information) and writer (which writes the traces to the Phoenix 
SYSTEM.TRACING_STATS table).
+This file will configure the [Hadoop 
Metrics2](http://hadoop.apache.org/docs/current/api/index.html?org/apache/hadoop/metrics2/package-summary.html)
 system for *Phoenix clients*. 
 
-See the properties file for more information on setting your own sinks and 
writer.
+The default properties you should set are:
+
+```
+# Sample from all the sources every 10 seconds
+*.period=10
+
+# Write Traces to Phoenix
+##########################
+# ensure that we receive traces on the server
+phoenix.sink.tracing.class=org.apache.phoenix.trace.PhoenixMetricsSink
+# Tell the sink where to write the metrics
+phoenix.sink.tracing.writer-class=org.apache.phoenix.trace.PhoenixTableMetricsWriter
+# Only handle traces with a context of "tracing"
+phoenix.sink.tracing.context=tracing
+```
+
+This enables standard Phoenix metrics sink (which collects the trace 
information) and writer (writes the traces to the Phoenix SYSTEM.TRACING_STATS 
table). You can modify this to set your own custom classes as well, if you have 
them.
+
+See the properties file in the source (phoenix-hadop2-compat/bin) for more 
information on setting your own sinks and writer.
 
 ### hadoop-metrics2-hbase.properties
 
-HBase already comes with a metrics2 configuration, so the metrics2 
configuration included in the phoenix distribution can either replace the 
existing file (if you don't have any special configurations) or the properties 
can be copied to your exisiting metrics2 configuration file.
+HBase default deployment already comes with a metrics2 configuration, so the 
metrics2 configuration from phoenix can either replace the existing file (if 
you don't have any special configurations) or the properties can be copied to 
your exisiting metrics2 configuration file.
+
+```
+# ensure that we receive traces on the server
+hbase.sink.tracing.class=org.apache.phoenix.trace.PhoenixMetricsSink
+# Tell the sink where to write the metrics
+hbase.sink.tracing.writer-class=org.apache.phoenix.trace.PhoenixTableMetricsWriter
+# Only handle traces with a context of "tracing"
+hbase.sink.tracing.context=tracing
+```
 
-They are essentially the same properties as in the 
hadoop-metrics2-phoenix.properties but prefixed by "hbase" rather than 
"phoenix" so they are loaded in the HBase metrics system.
+They are essentially the same properties as in the 
hadoop-metrics2-phoenix.properties but prefixed by "hbase" rather than 
"phoenix" so they are loaded with the rest of the HBase metrics.
 
 ### <u>Disabling Tracing</u>
 


Reply via email to