You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@htrace.apache.org by st...@apache.org on 2015/09/16 06:37:56 UTC
svn commit: r1703332 [3/3] - in /incubator/htrace/site/publish: ./ apidocs/
apidocs/com/twitter/zipkin/gen/ apidocs/com/twitter/zipkin/gen/class-use/
apidocs/org/apache/htrace/ apidocs/org/apache/htrace/class-use/
apidocs/org/apache/htrace/core/ apidoc...
Modified: incubator/htrace/site/publish/apidocs/org/apache/htrace/viewer/class-use/HBaseSpanViewer.html
URL: http://svn.apache.org/viewvc/incubator/htrace/site/publish/apidocs/org/apache/htrace/viewer/class-use/HBaseSpanViewer.html?rev=1703332&r1=1703331&r2=1703332&view=diff
==============================================================================
--- incubator/htrace/site/publish/apidocs/org/apache/htrace/viewer/class-use/HBaseSpanViewer.html (original)
+++ incubator/htrace/site/publish/apidocs/org/apache/htrace/viewer/class-use/HBaseSpanViewer.html Wed Sep 16 04:37:54 2015
@@ -2,7 +2,7 @@
<!-- NewPage -->
<html lang="en">
<head>
-<!-- Generated by javadoc (version 1.7.0_51) on Tue Sep 15 20:56:58 PDT 2015 -->
+<!-- Generated by javadoc (version 1.7.0_51) on Tue Sep 15 21:31:26 PDT 2015 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>Uses of Class org.apache.htrace.viewer.HBaseSpanViewer (Apache HTrace 4.1.0-incubating-SNAPSHOT API)</title>
<meta name="date" content="2015-09-15">
Modified: incubator/htrace/site/publish/apidocs/org/apache/htrace/viewer/class-use/HBaseSpanViewerServer.html
URL: http://svn.apache.org/viewvc/incubator/htrace/site/publish/apidocs/org/apache/htrace/viewer/class-use/HBaseSpanViewerServer.html?rev=1703332&r1=1703331&r2=1703332&view=diff
==============================================================================
--- incubator/htrace/site/publish/apidocs/org/apache/htrace/viewer/class-use/HBaseSpanViewerServer.html (original)
+++ incubator/htrace/site/publish/apidocs/org/apache/htrace/viewer/class-use/HBaseSpanViewerServer.html Wed Sep 16 04:37:54 2015
@@ -2,7 +2,7 @@
<!-- NewPage -->
<html lang="en">
<head>
-<!-- Generated by javadoc (version 1.7.0_51) on Tue Sep 15 20:56:58 PDT 2015 -->
+<!-- Generated by javadoc (version 1.7.0_51) on Tue Sep 15 21:31:26 PDT 2015 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>Uses of Class org.apache.htrace.viewer.HBaseSpanViewerServer (Apache HTrace 4.1.0-incubating-SNAPSHOT API)</title>
<meta name="date" content="2015-09-15">
Modified: incubator/htrace/site/publish/apidocs/org/apache/htrace/viewer/class-use/HBaseSpanViewerSpansServlet.html
URL: http://svn.apache.org/viewvc/incubator/htrace/site/publish/apidocs/org/apache/htrace/viewer/class-use/HBaseSpanViewerSpansServlet.html?rev=1703332&r1=1703331&r2=1703332&view=diff
==============================================================================
--- incubator/htrace/site/publish/apidocs/org/apache/htrace/viewer/class-use/HBaseSpanViewerSpansServlet.html (original)
+++ incubator/htrace/site/publish/apidocs/org/apache/htrace/viewer/class-use/HBaseSpanViewerSpansServlet.html Wed Sep 16 04:37:54 2015
@@ -2,7 +2,7 @@
<!-- NewPage -->
<html lang="en">
<head>
-<!-- Generated by javadoc (version 1.7.0_51) on Tue Sep 15 20:56:58 PDT 2015 -->
+<!-- Generated by javadoc (version 1.7.0_51) on Tue Sep 15 21:31:26 PDT 2015 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>Uses of Class org.apache.htrace.viewer.HBaseSpanViewerSpansServlet (Apache HTrace 4.1.0-incubating-SNAPSHOT API)</title>
<meta name="date" content="2015-09-15">
Modified: incubator/htrace/site/publish/apidocs/org/apache/htrace/viewer/class-use/HBaseSpanViewerTracesServlet.html
URL: http://svn.apache.org/viewvc/incubator/htrace/site/publish/apidocs/org/apache/htrace/viewer/class-use/HBaseSpanViewerTracesServlet.html?rev=1703332&r1=1703331&r2=1703332&view=diff
==============================================================================
--- incubator/htrace/site/publish/apidocs/org/apache/htrace/viewer/class-use/HBaseSpanViewerTracesServlet.html (original)
+++ incubator/htrace/site/publish/apidocs/org/apache/htrace/viewer/class-use/HBaseSpanViewerTracesServlet.html Wed Sep 16 04:37:54 2015
@@ -2,7 +2,7 @@
<!-- NewPage -->
<html lang="en">
<head>
-<!-- Generated by javadoc (version 1.7.0_51) on Tue Sep 15 20:56:58 PDT 2015 -->
+<!-- Generated by javadoc (version 1.7.0_51) on Tue Sep 15 21:31:26 PDT 2015 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>Uses of Class org.apache.htrace.viewer.HBaseSpanViewerTracesServlet (Apache HTrace 4.1.0-incubating-SNAPSHOT API)</title>
<meta name="date" content="2015-09-15">
Modified: incubator/htrace/site/publish/apidocs/org/apache/htrace/viewer/package-frame.html
URL: http://svn.apache.org/viewvc/incubator/htrace/site/publish/apidocs/org/apache/htrace/viewer/package-frame.html?rev=1703332&r1=1703331&r2=1703332&view=diff
==============================================================================
--- incubator/htrace/site/publish/apidocs/org/apache/htrace/viewer/package-frame.html (original)
+++ incubator/htrace/site/publish/apidocs/org/apache/htrace/viewer/package-frame.html Wed Sep 16 04:37:54 2015
@@ -2,7 +2,7 @@
<!-- NewPage -->
<html lang="en">
<head>
-<!-- Generated by javadoc (version 1.7.0_51) on Tue Sep 15 20:56:58 PDT 2015 -->
+<!-- Generated by javadoc (version 1.7.0_51) on Tue Sep 15 21:31:26 PDT 2015 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>org.apache.htrace.viewer (Apache HTrace 4.1.0-incubating-SNAPSHOT API)</title>
<meta name="date" content="2015-09-15">
Modified: incubator/htrace/site/publish/apidocs/org/apache/htrace/viewer/package-summary.html
URL: http://svn.apache.org/viewvc/incubator/htrace/site/publish/apidocs/org/apache/htrace/viewer/package-summary.html?rev=1703332&r1=1703331&r2=1703332&view=diff
==============================================================================
--- incubator/htrace/site/publish/apidocs/org/apache/htrace/viewer/package-summary.html (original)
+++ incubator/htrace/site/publish/apidocs/org/apache/htrace/viewer/package-summary.html Wed Sep 16 04:37:54 2015
@@ -2,7 +2,7 @@
<!-- NewPage -->
<html lang="en">
<head>
-<!-- Generated by javadoc (version 1.7.0_51) on Tue Sep 15 20:56:58 PDT 2015 -->
+<!-- Generated by javadoc (version 1.7.0_51) on Tue Sep 15 21:31:26 PDT 2015 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>org.apache.htrace.viewer (Apache HTrace 4.1.0-incubating-SNAPSHOT API)</title>
<meta name="date" content="2015-09-15">
Modified: incubator/htrace/site/publish/apidocs/org/apache/htrace/viewer/package-tree.html
URL: http://svn.apache.org/viewvc/incubator/htrace/site/publish/apidocs/org/apache/htrace/viewer/package-tree.html?rev=1703332&r1=1703331&r2=1703332&view=diff
==============================================================================
--- incubator/htrace/site/publish/apidocs/org/apache/htrace/viewer/package-tree.html (original)
+++ incubator/htrace/site/publish/apidocs/org/apache/htrace/viewer/package-tree.html Wed Sep 16 04:37:54 2015
@@ -2,7 +2,7 @@
<!-- NewPage -->
<html lang="en">
<head>
-<!-- Generated by javadoc (version 1.7.0_51) on Tue Sep 15 20:56:58 PDT 2015 -->
+<!-- Generated by javadoc (version 1.7.0_51) on Tue Sep 15 21:31:26 PDT 2015 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>org.apache.htrace.viewer Class Hierarchy (Apache HTrace 4.1.0-incubating-SNAPSHOT API)</title>
<meta name="date" content="2015-09-15">
Modified: incubator/htrace/site/publish/apidocs/org/apache/htrace/viewer/package-use.html
URL: http://svn.apache.org/viewvc/incubator/htrace/site/publish/apidocs/org/apache/htrace/viewer/package-use.html?rev=1703332&r1=1703331&r2=1703332&view=diff
==============================================================================
--- incubator/htrace/site/publish/apidocs/org/apache/htrace/viewer/package-use.html (original)
+++ incubator/htrace/site/publish/apidocs/org/apache/htrace/viewer/package-use.html Wed Sep 16 04:37:54 2015
@@ -2,7 +2,7 @@
<!-- NewPage -->
<html lang="en">
<head>
-<!-- Generated by javadoc (version 1.7.0_51) on Tue Sep 15 20:56:58 PDT 2015 -->
+<!-- Generated by javadoc (version 1.7.0_51) on Tue Sep 15 21:31:26 PDT 2015 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>Uses of Package org.apache.htrace.viewer (Apache HTrace 4.1.0-incubating-SNAPSHOT API)</title>
<meta name="date" content="2015-09-15">
Modified: incubator/htrace/site/publish/apidocs/org/apache/htrace/zipkin/HTraceToZipkinConverter.html
URL: http://svn.apache.org/viewvc/incubator/htrace/site/publish/apidocs/org/apache/htrace/zipkin/HTraceToZipkinConverter.html?rev=1703332&r1=1703331&r2=1703332&view=diff
==============================================================================
--- incubator/htrace/site/publish/apidocs/org/apache/htrace/zipkin/HTraceToZipkinConverter.html (original)
+++ incubator/htrace/site/publish/apidocs/org/apache/htrace/zipkin/HTraceToZipkinConverter.html Wed Sep 16 04:37:54 2015
@@ -2,7 +2,7 @@
<!-- NewPage -->
<html lang="en">
<head>
-<!-- Generated by javadoc (version 1.7.0_51) on Tue Sep 15 20:56:57 PDT 2015 -->
+<!-- Generated by javadoc (version 1.7.0_51) on Tue Sep 15 21:31:25 PDT 2015 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>HTraceToZipkinConverter (Apache HTrace 4.1.0-incubating-SNAPSHOT API)</title>
<meta name="date" content="2015-09-15">
Modified: incubator/htrace/site/publish/apidocs/org/apache/htrace/zipkin/class-use/HTraceToZipkinConverter.html
URL: http://svn.apache.org/viewvc/incubator/htrace/site/publish/apidocs/org/apache/htrace/zipkin/class-use/HTraceToZipkinConverter.html?rev=1703332&r1=1703331&r2=1703332&view=diff
==============================================================================
--- incubator/htrace/site/publish/apidocs/org/apache/htrace/zipkin/class-use/HTraceToZipkinConverter.html (original)
+++ incubator/htrace/site/publish/apidocs/org/apache/htrace/zipkin/class-use/HTraceToZipkinConverter.html Wed Sep 16 04:37:54 2015
@@ -2,7 +2,7 @@
<!-- NewPage -->
<html lang="en">
<head>
-<!-- Generated by javadoc (version 1.7.0_51) on Tue Sep 15 20:56:58 PDT 2015 -->
+<!-- Generated by javadoc (version 1.7.0_51) on Tue Sep 15 21:31:26 PDT 2015 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>Uses of Class org.apache.htrace.zipkin.HTraceToZipkinConverter (Apache HTrace 4.1.0-incubating-SNAPSHOT API)</title>
<meta name="date" content="2015-09-15">
Modified: incubator/htrace/site/publish/apidocs/org/apache/htrace/zipkin/package-frame.html
URL: http://svn.apache.org/viewvc/incubator/htrace/site/publish/apidocs/org/apache/htrace/zipkin/package-frame.html?rev=1703332&r1=1703331&r2=1703332&view=diff
==============================================================================
--- incubator/htrace/site/publish/apidocs/org/apache/htrace/zipkin/package-frame.html (original)
+++ incubator/htrace/site/publish/apidocs/org/apache/htrace/zipkin/package-frame.html Wed Sep 16 04:37:54 2015
@@ -2,7 +2,7 @@
<!-- NewPage -->
<html lang="en">
<head>
-<!-- Generated by javadoc (version 1.7.0_51) on Tue Sep 15 20:56:58 PDT 2015 -->
+<!-- Generated by javadoc (version 1.7.0_51) on Tue Sep 15 21:31:26 PDT 2015 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>org.apache.htrace.zipkin (Apache HTrace 4.1.0-incubating-SNAPSHOT API)</title>
<meta name="date" content="2015-09-15">
Modified: incubator/htrace/site/publish/apidocs/org/apache/htrace/zipkin/package-summary.html
URL: http://svn.apache.org/viewvc/incubator/htrace/site/publish/apidocs/org/apache/htrace/zipkin/package-summary.html?rev=1703332&r1=1703331&r2=1703332&view=diff
==============================================================================
--- incubator/htrace/site/publish/apidocs/org/apache/htrace/zipkin/package-summary.html (original)
+++ incubator/htrace/site/publish/apidocs/org/apache/htrace/zipkin/package-summary.html Wed Sep 16 04:37:54 2015
@@ -2,7 +2,7 @@
<!-- NewPage -->
<html lang="en">
<head>
-<!-- Generated by javadoc (version 1.7.0_51) on Tue Sep 15 20:56:58 PDT 2015 -->
+<!-- Generated by javadoc (version 1.7.0_51) on Tue Sep 15 21:31:26 PDT 2015 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>org.apache.htrace.zipkin (Apache HTrace 4.1.0-incubating-SNAPSHOT API)</title>
<meta name="date" content="2015-09-15">
Modified: incubator/htrace/site/publish/apidocs/org/apache/htrace/zipkin/package-tree.html
URL: http://svn.apache.org/viewvc/incubator/htrace/site/publish/apidocs/org/apache/htrace/zipkin/package-tree.html?rev=1703332&r1=1703331&r2=1703332&view=diff
==============================================================================
--- incubator/htrace/site/publish/apidocs/org/apache/htrace/zipkin/package-tree.html (original)
+++ incubator/htrace/site/publish/apidocs/org/apache/htrace/zipkin/package-tree.html Wed Sep 16 04:37:54 2015
@@ -2,7 +2,7 @@
<!-- NewPage -->
<html lang="en">
<head>
-<!-- Generated by javadoc (version 1.7.0_51) on Tue Sep 15 20:56:58 PDT 2015 -->
+<!-- Generated by javadoc (version 1.7.0_51) on Tue Sep 15 21:31:26 PDT 2015 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>org.apache.htrace.zipkin Class Hierarchy (Apache HTrace 4.1.0-incubating-SNAPSHOT API)</title>
<meta name="date" content="2015-09-15">
Modified: incubator/htrace/site/publish/apidocs/org/apache/htrace/zipkin/package-use.html
URL: http://svn.apache.org/viewvc/incubator/htrace/site/publish/apidocs/org/apache/htrace/zipkin/package-use.html?rev=1703332&r1=1703331&r2=1703332&view=diff
==============================================================================
--- incubator/htrace/site/publish/apidocs/org/apache/htrace/zipkin/package-use.html (original)
+++ incubator/htrace/site/publish/apidocs/org/apache/htrace/zipkin/package-use.html Wed Sep 16 04:37:54 2015
@@ -2,7 +2,7 @@
<!-- NewPage -->
<html lang="en">
<head>
-<!-- Generated by javadoc (version 1.7.0_51) on Tue Sep 15 20:56:58 PDT 2015 -->
+<!-- Generated by javadoc (version 1.7.0_51) on Tue Sep 15 21:31:26 PDT 2015 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>Uses of Package org.apache.htrace.zipkin (Apache HTrace 4.1.0-incubating-SNAPSHOT API)</title>
<meta name="date" content="2015-09-15">
Modified: incubator/htrace/site/publish/apidocs/overview-frame.html
URL: http://svn.apache.org/viewvc/incubator/htrace/site/publish/apidocs/overview-frame.html?rev=1703332&r1=1703331&r2=1703332&view=diff
==============================================================================
--- incubator/htrace/site/publish/apidocs/overview-frame.html (original)
+++ incubator/htrace/site/publish/apidocs/overview-frame.html Wed Sep 16 04:37:54 2015
@@ -2,7 +2,7 @@
<!-- NewPage -->
<html lang="en">
<head>
-<!-- Generated by javadoc (version 1.7.0_51) on Tue Sep 15 20:56:58 PDT 2015 -->
+<!-- Generated by javadoc (version 1.7.0_51) on Tue Sep 15 21:31:26 PDT 2015 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>Overview List (Apache HTrace 4.1.0-incubating-SNAPSHOT API)</title>
<meta name="date" content="2015-09-15">
Modified: incubator/htrace/site/publish/apidocs/overview-summary.html
URL: http://svn.apache.org/viewvc/incubator/htrace/site/publish/apidocs/overview-summary.html?rev=1703332&r1=1703331&r2=1703332&view=diff
==============================================================================
--- incubator/htrace/site/publish/apidocs/overview-summary.html (original)
+++ incubator/htrace/site/publish/apidocs/overview-summary.html Wed Sep 16 04:37:54 2015
@@ -2,7 +2,7 @@
<!-- NewPage -->
<html lang="en">
<head>
-<!-- Generated by javadoc (version 1.7.0_51) on Tue Sep 15 20:56:58 PDT 2015 -->
+<!-- Generated by javadoc (version 1.7.0_51) on Tue Sep 15 21:31:26 PDT 2015 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>Overview (Apache HTrace 4.1.0-incubating-SNAPSHOT API)</title>
<meta name="date" content="2015-09-15">
Modified: incubator/htrace/site/publish/apidocs/overview-tree.html
URL: http://svn.apache.org/viewvc/incubator/htrace/site/publish/apidocs/overview-tree.html?rev=1703332&r1=1703331&r2=1703332&view=diff
==============================================================================
--- incubator/htrace/site/publish/apidocs/overview-tree.html (original)
+++ incubator/htrace/site/publish/apidocs/overview-tree.html Wed Sep 16 04:37:54 2015
@@ -2,7 +2,7 @@
<!-- NewPage -->
<html lang="en">
<head>
-<!-- Generated by javadoc (version 1.7.0_51) on Tue Sep 15 20:56:58 PDT 2015 -->
+<!-- Generated by javadoc (version 1.7.0_51) on Tue Sep 15 21:31:26 PDT 2015 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>Class Hierarchy (Apache HTrace 4.1.0-incubating-SNAPSHOT API)</title>
<meta name="date" content="2015-09-15">
Modified: incubator/htrace/site/publish/apidocs/serialized-form.html
URL: http://svn.apache.org/viewvc/incubator/htrace/site/publish/apidocs/serialized-form.html?rev=1703332&r1=1703331&r2=1703332&view=diff
==============================================================================
--- incubator/htrace/site/publish/apidocs/serialized-form.html (original)
+++ incubator/htrace/site/publish/apidocs/serialized-form.html Wed Sep 16 04:37:54 2015
@@ -2,7 +2,7 @@
<!-- NewPage -->
<html lang="en">
<head>
-<!-- Generated by javadoc (version 1.7.0_51) on Tue Sep 15 20:56:58 PDT 2015 -->
+<!-- Generated by javadoc (version 1.7.0_51) on Tue Sep 15 21:31:26 PDT 2015 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>Serialized Form (Apache HTrace 4.1.0-incubating-SNAPSHOT API)</title>
<meta name="date" content="2015-09-15">
Modified: incubator/htrace/site/publish/index.html
URL: http://svn.apache.org/viewvc/incubator/htrace/site/publish/index.html?rev=1703332&r1=1703331&r2=1703332&view=diff
==============================================================================
--- incubator/htrace/site/publish/index.html (original)
+++ incubator/htrace/site/publish/index.html Wed Sep 16 04:37:54 2015
@@ -115,27 +115,26 @@
</a>
<div class="nav-collapse collapse" id="toc-nav-collapse">
<ul id="toc" class="nav">
+ <li class="toplevel"><a href="#API" title="API">API</a></li>
+ <li class="divider-vertical"></li>
<li class="dropdown">
- <a href="#API" title="API" class="dropdown-toggle" role="button" data-toggle="dropdown" data-target="#">API <b class="caret"></b></a>
+ <a href="#How_to_add_tracing_to_your_application" title="How to add tracing to your application" class="dropdown-toggle" role="button" data-toggle="dropdown" data-target="#">How to add tracing to your application <b class="caret"></b></a>
<ul class="dropdown-menu" role="menu">
<!-- Repeat the item, otherwise it is not clickable as the dropdown root -->
- <li><a href="#API" title="API">API</a></li>
+ <li><a href="#How_to_add_tracing_to_your_application" title="How to add tracing to your application">How to add tracing to your application</a></li>
<li class="divider"></li>
- <li class="dropdown-submenu">
- <a href="#How_to_add_tracing_to_your_application" title="How to add tracing to your application">How to add tracing to your application</a>
- <ul class="dropdown-menu" role="menu">
- <li><a href="#htrace-zipkin" title="htrace-zipkin">htrace-zipkin</a></li>
- <li><a href="#htrace-hbase" title="htrace-hbase">htrace-hbase</a></li>
-
- </ul>
- </li>
+ <li><a href="#Create_a_Tracer_object" title="Create a Tracer object">Create a Tracer object</a></li>
+ <li><a href="#Attach_additional_information_to_your_RPCs" title="Attach additional information to your RPCs">Attach additional information to your RPCs</a></li>
+ <li><a href="#Wrap_your_thread_changes" title="Wrap your thread changes">Wrap your thread changes</a></li>
+ <li><a href="#Add_custom_spans_and_annotations" title="Add custom spans and annotations">Add custom spans and annotations</a></li>
+ <li><a href="#Generating_test_spans" title="Generating test spans">Generating test spans</a></li>
</ul>
</li>
<li class="divider-vertical"></li>
- <li class="toplevel"><a href="#Generating_test_spans" title="Generating test spans">Generating test spans</a></li>
+ <li class="toplevel"><a href="#htrace-zipkin" title="htrace-zipkin">htrace-zipkin</a></li>
<li class="divider-vertical"></li>
- <li class="toplevel"><a href="#Publishing_to_Maven_Central" title="Publishing to Maven Central">Publishing to Maven Central</a></li>
+ <li class="toplevel"><a href="#htrace-hbase" title="htrace-hbase">htrace-hbase</a></li>
</ul>
</div>
</div>
@@ -159,8 +158,7 @@
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License. See accompanying LICENSE file. -->
-<p>Apache HTrace is an <a class="externalLink" href="http://htrace.incubator.apache.org">Apache Incubator</a> project. To add HTrace to your project, see detail on how to add it as a <a href="dependency-info.html">dependency</a>.</p>
-<p>Formerly, HTrace was available at org.htrace.</p>
+<p>Apache HTrace is an <a class="externalLink" href="http://htrace.incubator.apache.org">Apache Incubator</a> project. To add HTrace to your project, see detail on how to add it as a <a href="dependency-info.html">dependency</a>. Formerly, HTrace was available at <tt>org.htrace</tt>.</p>
<ul>
<li>htrace-4.0.0-incubating published September 15th, 2015. <a class="externalLink" href="http://www.apache.org/dyn/closer.cgi/incubator/htrace/">Download it!</a></li>
<li>htrace-3.2.0-incubating published June 2nd, 2015. <a class="externalLink" href="http://www.apache.org/dyn/closer.cgi/incubator/htrace/">Download it!</a></li>
@@ -176,36 +174,28 @@
<p><b>TracerId:</b> Identifies the Tracer object which created a specific Span. The TracerId should identify the source of the Span. â10.0.0.2/DataNodeâ is a typical TracerID.</p>
<p><b>SpanReceiver:</b> SpanReceivers handle spans once they have been created. Typically, Span Receivers send spans to an external data store to be analyzed. HTrace comes with several standard span receivers, such as <tt>LocalFileSpanReceiver</tt>.</p>
<p><b>Sampler:</b> Samplers determine when tracing should be enabled, and when it should be disabled. The goal of HTrace is to trace an entire request.</p>
+</div>
+<div class="section">
+ <h2 id="How_to_add_tracing_to_your_application">How to add tracing to your application</h2>
+ <p>To instrument your system you must:</p>
<div class="section">
- <h3 id="How_to_add_tracing_to_your_application">How to add tracing to your application</h3>
- <p>To instrument your system you must:</p>
- <p><b>1. Create a Tracer object.</b> You can create a Tracer object via the Tracer#Builder.</p>
+ <h3 id="Create_a_Tracer_object">Create a Tracer object</h3>
+ <p>You can create a Tracer object via the <tt>Tracer#Builder</tt>.</p>
<div class="source">
<div class="source">
- <pre> Tracer tracer = new Tracer#Builder(conf).setName("MyApp").build();
-...
-
-The Tracer#Builder will take care of creating the appropriate Sampler and
-SpanReceiver objects, as well as the Tracer itself. If a SpanReceiver was
-created, we will install a shutdown hook to close it when the JVM shuts down.
-
-<b>2. Attach additional information to your RPCs.</b>
-In order to create the causal links necessary for a trace, HTrace needs to know
-about the causal relationships between spans. The only information you need to
-add to your RPCs is the 128-bit span ID. If tracing is enabled when you send an
-RPC, attach the ID of the current span to the message. On the receiving end of
-the RPC, check to see if the message has a span ID attached. If it does, start
-a new trace scope with that span as a parent.
-
-<b>3. Wrap your thread changes.</b>
-HTrace stores span information in java's ThreadLocals, which causes
-the trace to be "lost" on thread changes. The only way to prevent
-this is to "wrap" your thread changes. For example, if your code looks
-like this:
-
+ <pre>Tracer tracer = new Tracer#Builder(conf).setName("MyApp").build();
</pre>
</div>
</div>
+ <p>The <tt>Tracer#Builder</tt> will take care of creating the appropriate Sampler and SpanReceiver objects, as well as the Tracer itself. If a SpanReceiver was created, we will install a shutdown hook to close it when the JVM shuts down.</p>
+ </div>
+ <div class="section">
+ <h3 id="Attach_additional_information_to_your_RPCs">Attach additional information to your RPCs</h3>
+ <p>In order to create the causal links necessary for a trace, HTrace needs to know about the causal relationships between spans. The only information you need to add to your RPCs is the 128-bit span ID. If tracing is enabled when you send an RPC, attach the ID of the current span to the message. On the receiving end of the RPC, check to see if the message has a span ID attached. If it does, start a new trace scope with that span as a parent.</p>
+ </div>
+ <div class="section">
+ <h3 id="Wrap_your_thread_changes">Wrap your thread changes</h3>
+ <p>HTrace stores span information in javaâs ThreadLocals, which causes the trace to be âlostâ on thread changes. The only way to prevent this is to âwrapâ your thread changes. For example, if your code looks like this:</p>
<div class="source">
<div class="source">
<pre>Thread t1 = new Thread(new MyRunnable());
@@ -213,53 +203,20 @@ like this:
</pre>
</div>
</div>
- <div class="source">
- <div class="source">
- <pre>Just change it to look this:
-
-</pre>
- </div>
- </div>
+ <p>Just change it to look this:</p>
<div class="source">
<div class="source">
<pre>Thread t1 = new Thread(Trace.wrap(new MyRunnable()));
</pre>
</div>
</div>
- <div class="source">
- <div class="source">
- <pre>That's it! `Trace.wrap()` takes a single argument (a runnable or a
-callable) and if the current thread is a part of a trace, returns a
-wrapped version of the argument. The wrapped version of a callable
-and runnable just knows about the span that created it and will start
-a new span in the new thread that is the child of the span that
-created the runnable/callable. There may be situations in which a
-simple `Trace.wrap()` does not suffice. In these cases all you need
-to do is keep a reference to the "parent span" (the span before the
-thread change) and once you're in the new thread start a new span that
-is the "child" of the parent span you stored.
-
-For example:
-
-Say you have some object representing a "put" operation. When the
-client does a "put," the put is first added to a list so another
-thread can batch together the puts. In this situation, you
-might want to add another field to the Put class that could store the
-current span at the time the put was created. Then when the put is
-pulled out of the list to be processed, you can start a new span as
-the child of the span stored in the Put.
-
-<b>3. Add custom spans and annotations.</b>
-Once you've augmented your RPC's and wrapped the necessary thread
-changes, you can add more spans and annotations wherever you want.
-For example, you might do some expensive computation that you want to
-see on your traces. In this case, you could start a new span before
-the computation that you then stop after the computation has
-finished. It might look like this:
-
-</pre>
- </div>
- </div>
+ <p>Thatâs it! <tt>Trace.wrap()</tt> takes a single argument (a runnable or a callable) and if the current thread is a part of a trace, returns a wrapped version of the argument. The wrapped version of a callable and runnable just knows about the span that created it and will start a new span in the new thread that is the child of the span that created the runnable/callable. There may be situations in which a simple <tt>Trace.wrap()</tt> does not suffice. In these cases all you need to do is keep a reference to the âparent spanâ (the span before the thread change) and once youâre in the new thread start a new span that is the âchildâ of the parent span you stored.</p>
+ <p>For example:</p>
+ <p>Say you have some object representing a âputâ operation. When the client does a âput,â the put is first added to a list so another thread can batch together the puts. In this situation, you might want to add another field to the Put class that could store the current span at the time the put was created. Then when the put is pulled out of the list to be processed, you can start a new span as the child of the span stored in the Put.</p>
+ </div>
+ <div class="section">
+ <h3 id="Add_custom_spans_and_annotations">Add custom spans and annotations</h3>
+ <p>Once youâve augmented your RPCâs and wrapped the necessary thread changes, you can add more spans and annotations wherever you want. For example, you might do some expensive computation that you want to see on your traces. In this case, you could start a new span before the computation that you then stop after the computation has finished. It might look like this:</p>
<div class="source">
<div class="source">
<pre>Span computationSpan = tracer.newScope("Expensive computation.");
@@ -271,46 +228,34 @@ try {
</pre>
</div>
</div>
- <div class="source">
- <div class="source">
- <pre>HTrace also supports key-value annotations on a per-trace basis.
-
-Example:
-
-</pre>
- </div>
- </div>
+ <p>HTrace also supports key-value annotations on a per-trace basis.</p>
+ <p>Example:</p>
<div class="source">
<div class="source">
<pre>scope.addAnnotation("faultyRecordCounter".getBytes(), "1".getBytes());
</pre>
</div>
</div>
- <p>````</p>
- <div class="section">
- <h4 id="htrace-zipkin">htrace-zipkin</h4>
- <p>htrace-zipkin provides the <tt>SpanReceiver</tt> implementation which sends spans to <a class="externalLink" href="https://github.com/twitter/zipkin">Zipkin</a> collector. You can build the uber-jar (htrace-zipkin-*-jar-withdependency.jar) for manual setup as shown below. This uber-jar contains all dependencies except htrace-core and its dependencies.</p>
- <div class="source">
- <div class="source">
- <pre>$ cd htrace-zipkin
+ </div>
+ <div class="section">
+ <h3 id="Generating_test_spans">Generating test spans</h3>
+ <p>The test that creates a sample trace (TestHTrace) takes a command line argument telling it where to write span information. Run <tt>mvn test -DargLine="-DspanFile=FILE\_PATH"</tt> to write span information to FILE_PATH. If no file is specified, span information will be written to standard out.</p>
+ </div>
+</div>
+<div class="section">
+ <h2 id="htrace-zipkin">htrace-zipkin</h2>
+ <p>htrace-zipkin provides the <tt>SpanReceiver</tt> implementation which sends spans to <a class="externalLink" href="https://github.com/twitter/zipkin">Zipkin</a> collector. You can build the uber-jar (htrace-zipkin-*-jar-withdependency.jar) for manual setup as shown below. This uber-jar contains all dependencies except htrace-core and its dependencies.</p>
+ <div class="source">
+ <div class="source">
+ <pre>$ cd htrace-zipkin
$ mvn compile assembly:single
</pre>
- </div>
- </div>
- </div>
- <div class="section">
- <h4 id="htrace-hbase">htrace-hbase</h4>
- <p>See htrace-hbase for an Span Receiver implementation that writes HBase.</p>
</div>
</div>
</div>
<div class="section">
- <h2 id="Generating_test_spans">Generating test spans</h2>
- <p>The test that creates a sample trace (TestHTrace) takes a command line argument telling it where to write span information. Run <tt>mvn test -DargLine="-DspanFile=FILE\_PATH"</tt> to write span information to FILE_PATH. If no file is specified, span information will be written to standard out.</p>
-</div>
-<div class="section">
- <h2 id="Publishing_to_Maven_Central">Publishing to Maven Central</h2>
- <p>See <a class="externalLink" href="https://issues.sonatype.org/browse/OSSRH-8896">OSSRH-8896</a> for repository vitals.</p>
+ <h2 id="htrace-hbase">htrace-hbase</h2>
+ <p>See htrace-hbase for an Span Receiver implementation that writes HBase.</p>
</div>
</div>
</div>