Added: incubator/htrace/site/javadoc/4.1/htrace-core/index-all.html URL: http://svn.apache.org/viewvc/incubator/htrace/site/javadoc/4.1/htrace-core/index-all.html?rev=1741130&view=auto ============================================================================== --- incubator/htrace/site/javadoc/4.1/htrace-core/index-all.html (added) +++ incubator/htrace/site/javadoc/4.1/htrace-core/index-all.html Wed Apr 27 00:25:13 2016 @@ -0,0 +1,826 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (version 1.7.0_10) on Tue Apr 26 16:57:36 PDT 2016 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Index (htrace-core4 4.1.0-incubating API)</title> +<meta name="date" content="2016-04-26"> +<link rel="stylesheet" type="text/css" href="./stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="Index (htrace-core4 4.1.0-incubating API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="./org/apache/htrace/core/package-summary.html">Package</a></li> +<li>Class</li> +<li>Use</li> +<li><a href="./org/apache/htrace/core/package-tree.html">Tree</a></li> +<li><a href="./deprecated-list.html">Deprecated</a></li> +<li class="navBarCell1Rev">Index</li> +<li><a href="./help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="./index.html?index-all.html" target="_top">Frames</a></li> +<li><a href="index-all.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="./allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="contentContainer"><a href="#_A_">A</a> <a href="#_B_">B</a> <a href="#_C_">C</a> <a href="#_D_">D</a> <a href="#_E_">E</a> <a href="#_F_">F</a> <a href="#_G_">G</a> <a href="#_H_">H</a> <a href="#_I_">I</a> <a href="#_L_">L</a> <a href="#_M_">M</a> <a href="#_N_">N</a> <a href="#_O_">O</a> <a href="#_P_">P</a> <a href="#_R_">R</a> <a href="#_S_">S</a> <a href="#_T_">T</a> <a href="#_W_">W</a> <a name="_A_"> +<!-- --> +</a> +<h2 class="title">A</h2> +<dl> +<dt><span class="strong"><a href="./org/apache/htrace/core/MilliSpan.html#addKVAnnotation(java.lang.String, java.lang.String)">addKVAnnotation(String, String)</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/MilliSpan.html" title="class in org.apache.htrace.core">MilliSpan</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/Span.html#addKVAnnotation(java.lang.String, java.lang.String)">addKVAnnotation(String, String)</a></span> - Method in interface org.apache.htrace.core.<a href="./org/apache/htrace/core/Span.html" title="interface in org.apache.htrace.core">Span</a></dt> +<dd> +<div class="block">Add a data annotation associated with this span</div> +</dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/TraceScope.html#addKVAnnotation(java.lang.String, java.lang.String)">addKVAnnotation(String, String)</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/TraceScope.html" title="class in org.apache.htrace.core">TraceScope</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/TracerPool.html#addReceiver(org.apache.htrace.core.SpanReceiver)">addReceiver(SpanReceiver)</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/TracerPool.html" title="class in org.apache.htrace.core">TracerPool</a></dt> +<dd> +<div class="block">Add a new span receiver.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/Tracer.html#addSampler(org.apache.htrace.core.Sampler)">addSampler(Sampler)</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/Tracer.html" title="class in org.apache.htrace.core">Tracer</a></dt> +<dd> +<div class="block">Add a new Sampler.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/MilliSpan.html#addTimelineAnnotation(java.lang.String)">addTimelineAnnotation(String)</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/MilliSpan.html" title="class in org.apache.htrace.core">MilliSpan</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/Span.html#addTimelineAnnotation(java.lang.String)">addTimelineAnnotation(String)</a></span> - Method in interface org.apache.htrace.core.<a href="./org/apache/htrace/core/Span.html" title="interface in org.apache.htrace.core">Span</a></dt> +<dd> +<div class="block">Add a timeline annotation associated with this span</div> +</dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/TraceScope.html#addTimelineAnnotation(java.lang.String)">addTimelineAnnotation(String)</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/TraceScope.html" title="class in org.apache.htrace.core">TraceScope</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/Sampler.html#ALWAYS">ALWAYS</a></span> - Static variable in class org.apache.htrace.core.<a href="./org/apache/htrace/core/Sampler.html" title="class in org.apache.htrace.core">Sampler</a></dt> +<dd> </dd> +<dt><a href="./org/apache/htrace/core/AlwaysSampler.html" title="class in org.apache.htrace.core"><span class="strong">AlwaysSampler</span></a> - Class in <a href="./org/apache/htrace/core/package-summary.html">org.apache.htrace.core</a></dt> +<dd> +<div class="block">A Sampler that always returns true.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/AlwaysSampler.html#AlwaysSampler(org.apache.htrace.core.HTraceConfiguration)">AlwaysSampler(HTraceConfiguration)</a></span> - Constructor for class org.apache.htrace.core.<a href="./org/apache/htrace/core/AlwaysSampler.html" title="class in org.apache.htrace.core">AlwaysSampler</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/TraceExecutorService.html#awaitTermination(long, java.util.concurrent.TimeUnit)">awaitTermination(long, TimeUnit)</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/TraceExecutorService.html" title="class in org.apache.htrace.core">TraceExecutorService</a></dt> +<dd> </dd> +</dl> +<a name="_B_"> +<!-- --> +</a> +<h2 class="title">B</h2> +<dl> +<dt><span class="strong"><a href="./org/apache/htrace/core/MilliSpan.Builder.html#begin(long)">begin(long)</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/MilliSpan.Builder.html" title="class in org.apache.htrace.core">MilliSpan.Builder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/MilliSpan.Builder.html#build()">build()</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/MilliSpan.Builder.html" title="class in org.apache.htrace.core">MilliSpan.Builder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/Sampler.Builder.html#build()">build()</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/Sampler.Builder.html" title="class in org.apache.htrace.core">Sampler.Builder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/SpanReceiver.Builder.html#build()">build()</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/SpanReceiver.Builder.html" title="class in org.apache.htrace.core">SpanReceiver.Builder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/Tracer.Builder.html#build()">build()</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/Tracer.Builder.html" title="class in org.apache.htrace.core">Tracer.Builder</a></dt> +<dd> </dd> +</dl> +<a name="_C_"> +<!-- --> +</a> +<h2 class="title">C</h2> +<dl> +<dt><span class="strong"><a href="./org/apache/htrace/core/TraceCallable.html#call()">call()</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/TraceCallable.html" title="class in org.apache.htrace.core">TraceCallable</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/LocalFileSpanReceiver.html#CAPACITY_DEFAULT">CAPACITY_DEFAULT</a></span> - Static variable in class org.apache.htrace.core.<a href="./org/apache/htrace/core/LocalFileSpanReceiver.html" title="class in org.apache.htrace.core">LocalFileSpanReceiver</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/LocalFileSpanReceiver.html#CAPACITY_KEY">CAPACITY_KEY</a></span> - Static variable in class org.apache.htrace.core.<a href="./org/apache/htrace/core/LocalFileSpanReceiver.html" title="class in org.apache.htrace.core">LocalFileSpanReceiver</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/MilliSpan.html#child(java.lang.String)">child(String)</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/MilliSpan.html" title="class in org.apache.htrace.core">MilliSpan</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/Span.html#child(java.lang.String)">child(String)</a></span> - Method in interface org.apache.htrace.core.<a href="./org/apache/htrace/core/Span.html" title="interface in org.apache.htrace.core">Span</a></dt> +<dd> +<div class="block"><span class="strong">Deprecated.</span> +<div class="block"><i>Since 4.0.0. Use <a href="./org/apache/htrace/core/MilliSpan.Builder.html" title="class in org.apache.htrace.core"><code>MilliSpan.Builder</code></a></i></div> +</div> +</dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/Sampler.Builder.html#classLoader(java.lang.ClassLoader)">classLoader(ClassLoader)</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/Sampler.Builder.html" title="class in org.apache.htrace.core">Sampler.Builder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/SpanReceiver.Builder.html#classLoader(java.lang.ClassLoader)">classLoader(ClassLoader)</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/SpanReceiver.Builder.html" title="class in org.apache.htrace.core">SpanReceiver.Builder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/Sampler.Builder.html#className(java.lang.String)">className(String)</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/Sampler.Builder.html" title="class in org.apache.htrace.core">Sampler.Builder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/SpanReceiver.Builder.html#className(java.lang.String)">className(String)</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/SpanReceiver.Builder.html" title="class in org.apache.htrace.core">SpanReceiver.Builder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/LocalFileSpanReceiver.html#close()">close()</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/LocalFileSpanReceiver.html" title="class in org.apache.htrace.core">LocalFileSpanReceiver</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/POJOSpanReceiver.html#close()">close()</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/POJOSpanReceiver.html" title="class in org.apache.htrace.core">POJOSpanReceiver</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/StandardOutSpanReceiver.html#close()">close()</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/StandardOutSpanReceiver.html" title="class in org.apache.htrace.core">StandardOutSpanReceiver</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/Tracer.html#close()">close()</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/Tracer.html" title="class in org.apache.htrace.core">Tracer</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/TraceScope.html#close()">close()</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/TraceScope.html" title="class in org.apache.htrace.core">TraceScope</a></dt> +<dd> +<div class="block">Close this TraceScope, ending the trace span it is managing.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/SpanId.html#compareTo(org.apache.htrace.core.SpanId)">compareTo(SpanId)</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/SpanId.html" title="class in org.apache.htrace.core">SpanId</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/Tracer.Builder.html#conf(org.apache.htrace.core.HTraceConfiguration)">conf(HTraceConfiguration)</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/Tracer.Builder.html" title="class in org.apache.htrace.core">Tracer.Builder</a></dt> +<dd> </dd> +<dt><a href="./org/apache/htrace/core/CountSampler.html" title="class in org.apache.htrace.core"><span class="strong">CountSampler</span></a> - Class in <a href="./org/apache/htrace/core/package-summary.html">org.apache.htrace.core</a></dt> +<dd> +<div class="block">Sampler that returns true every N calls.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/CountSampler.html#CountSampler(org.apache.htrace.core.HTraceConfiguration)">CountSampler(HTraceConfiguration)</a></span> - Constructor for class org.apache.htrace.core.<a href="./org/apache/htrace/core/CountSampler.html" title="class in org.apache.htrace.core">CountSampler</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/MilliSpan.html#currentTimeMillis()">currentTimeMillis()</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/MilliSpan.html" title="class in org.apache.htrace.core">MilliSpan</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/Tracer.html#curThreadTracer()">curThreadTracer()</a></span> - Static method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/Tracer.html" title="class in org.apache.htrace.core">Tracer</a></dt> +<dd> </dd> +</dl> +<a name="_D_"> +<!-- --> +</a> +<h2 class="title">D</h2> +<dl> +<dt><span class="strong"><a href="./org/apache/htrace/core/MilliSpan.Builder.html#description(java.lang.String)">description(String)</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/MilliSpan.Builder.html" title="class in org.apache.htrace.core">MilliSpan.Builder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/MilliSpan.MilliSpanDeserializer.html#deserialize(com.fasterxml.jackson.core.JsonParser, com.fasterxml.jackson.databind.DeserializationContext)">deserialize(JsonParser, DeserializationContext)</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/MilliSpan.MilliSpanDeserializer.html" title="class in org.apache.htrace.core">MilliSpan.MilliSpanDeserializer</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/TraceScope.html#detach()">detach()</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/TraceScope.html" title="class in org.apache.htrace.core">TraceScope</a></dt> +<dd> +<div class="block">Detach this TraceScope from the current thread.</div> +</dd> +</dl> +<a name="_E_"> +<!-- --> +</a> +<h2 class="title">E</h2> +<dl> +<dt><span class="strong"><a href="./org/apache/htrace/core/HTraceConfiguration.html#EMPTY">EMPTY</a></span> - Static variable in class org.apache.htrace.core.<a href="./org/apache/htrace/core/HTraceConfiguration.html" title="class in org.apache.htrace.core">HTraceConfiguration</a></dt> +<dd> +<div class="block">An empty HTrace configuration.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/MilliSpan.Builder.html#end(long)">end(long)</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/MilliSpan.Builder.html" title="class in org.apache.htrace.core">MilliSpan.Builder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/SpanId.html#equals(java.lang.Object)">equals(Object)</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/SpanId.html" title="class in org.apache.htrace.core">SpanId</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/Tracer.html#equals(java.lang.Object)">equals(Object)</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/Tracer.html" title="class in org.apache.htrace.core">Tracer</a></dt> +<dd> +<div class="block">Compare two tracer objects.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/TraceExecutorService.html#execute(java.lang.Runnable)">execute(Runnable)</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/TraceExecutorService.html" title="class in org.apache.htrace.core">TraceExecutorService</a></dt> +<dd> </dd> +</dl> +<a name="_F_"> +<!-- --> +</a> +<h2 class="title">F</h2> +<dl> +<dt><span class="strong"><a href="./org/apache/htrace/core/MilliSpan.html#fromJson(java.lang.String)">fromJson(String)</a></span> - Static method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/MilliSpan.html" title="class in org.apache.htrace.core">MilliSpan</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/HTraceConfiguration.html#fromKeyValuePairs(java.lang.String...)">fromKeyValuePairs(String...)</a></span> - Static method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/HTraceConfiguration.html" title="class in org.apache.htrace.core">HTraceConfiguration</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/HTraceConfiguration.html#fromMap(java.util.Map)">fromMap(Map<String, String>)</a></span> - Static method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/HTraceConfiguration.html" title="class in org.apache.htrace.core">HTraceConfiguration</a></dt> +<dd> +<div class="block">Create an HTrace configuration from a map.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/SpanId.html#fromRandom()">fromRandom()</a></span> - Static method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/SpanId.html" title="class in org.apache.htrace.core">SpanId</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/SpanId.html#fromString(java.lang.String)">fromString(String)</a></span> - Static method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/SpanId.html" title="class in org.apache.htrace.core">SpanId</a></dt> +<dd> </dd> +</dl> +<a name="_G_"> +<!-- --> +</a> +<h2 class="title">G</h2> +<dl> +<dt><span class="strong"><a href="./org/apache/htrace/core/HTraceConfiguration.html#get(java.lang.String)">get(String)</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/HTraceConfiguration.html" title="class in org.apache.htrace.core">HTraceConfiguration</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/HTraceConfiguration.html#get(java.lang.String, java.lang.String)">get(String, String)</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/HTraceConfiguration.html" title="class in org.apache.htrace.core">HTraceConfiguration</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/TracerId.html#get()">get()</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/TracerId.html" title="class in org.apache.htrace.core">TracerId</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/MilliSpan.html#getAccumulatedMillis()">getAccumulatedMillis()</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/MilliSpan.html" title="class in org.apache.htrace.core">MilliSpan</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/Span.html#getAccumulatedMillis()">getAccumulatedMillis()</a></span> - Method in interface org.apache.htrace.core.<a href="./org/apache/htrace/core/Span.html" title="interface in org.apache.htrace.core">Span</a></dt> +<dd> +<div class="block">Return the total amount of time elapsed since start was called, if running, + or difference between stop and start</div> +</dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/HTraceConfiguration.html#getBoolean(java.lang.String, boolean)">getBoolean(String, boolean)</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/HTraceConfiguration.html" title="class in org.apache.htrace.core">HTraceConfiguration</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/Tracer.html#getCurrentSpan()">getCurrentSpan()</a></span> - Static method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/Tracer.html" title="class in org.apache.htrace.core">Tracer</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/Tracer.html#getCurrentSpanId()">getCurrentSpanId()</a></span> - Static method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/Tracer.html" title="class in org.apache.htrace.core">Tracer</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/MilliSpan.html#getDescription()">getDescription()</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/MilliSpan.html" title="class in org.apache.htrace.core">MilliSpan</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/Span.html#getDescription()">getDescription()</a></span> - Method in interface org.apache.htrace.core.<a href="./org/apache/htrace/core/Span.html" title="interface in org.apache.htrace.core">Span</a></dt> +<dd> +<div class="block">Return a textual description of this span.<p/> + + Will never be null.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/TracerPool.html#getGlobalTracerPool()">getGlobalTracerPool()</a></span> - Static method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/TracerPool.html" title="class in org.apache.htrace.core">TracerPool</a></dt> +<dd> +<div class="block">Get the global tracer pool.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/SpanId.html#getHigh()">getHigh()</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/SpanId.html" title="class in org.apache.htrace.core">SpanId</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/SpanReceiver.html#getId()">getId()</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/SpanReceiver.html" title="class in org.apache.htrace.core">SpanReceiver</a></dt> +<dd> +<div class="block">Get an ID uniquely identifying this SpanReceiver.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/TraceCallable.html#getImpl()">getImpl()</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/TraceCallable.html" title="class in org.apache.htrace.core">TraceCallable</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/HTraceConfiguration.html#getInt(java.lang.String, int)">getInt(String, int)</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/HTraceConfiguration.html" title="class in org.apache.htrace.core">HTraceConfiguration</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/MilliSpan.html#getKVAnnotations()">getKVAnnotations()</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/MilliSpan.html" title="class in org.apache.htrace.core">MilliSpan</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/Span.html#getKVAnnotations()">getKVAnnotations()</a></span> - Method in interface org.apache.htrace.core.<a href="./org/apache/htrace/core/Span.html" title="interface in org.apache.htrace.core">Span</a></dt> +<dd> +<div class="block">Get data associated with this span (read only)<p/> + + Will never be null.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/SpanId.html#getLow()">getLow()</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/SpanId.html" title="class in org.apache.htrace.core">SpanId</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/TimelineAnnotation.html#getMessage()">getMessage()</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/TimelineAnnotation.html" title="class in org.apache.htrace.core">TimelineAnnotation</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/TracerPool.html#getName()">getName()</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/TracerPool.html" title="class in org.apache.htrace.core">TracerPool</a></dt> +<dd> +<div class="block">Return the name of this TracerPool.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/MilliSpan.html#getParents()">getParents()</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/MilliSpan.html" title="class in org.apache.htrace.core">MilliSpan</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/Span.html#getParents()">getParents()</a></span> - Method in interface org.apache.htrace.core.<a href="./org/apache/htrace/core/Span.html" title="interface in org.apache.htrace.core">Span</a></dt> +<dd> +<div class="block">Returns the parent IDs of the span.<p/> + + The array will be empty if there are no parents.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/TracerPool.html#getReceivers()">getReceivers()</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/TracerPool.html" title="class in org.apache.htrace.core">TracerPool</a></dt> +<dd> +<div class="block">Returns an array of all the current span receivers.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/TraceRunnable.html#getRunnable()">getRunnable()</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/TraceRunnable.html" title="class in org.apache.htrace.core">TraceRunnable</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/Tracer.html#getSamplers()">getSamplers()</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/Tracer.html" title="class in org.apache.htrace.core">Tracer</a></dt> +<dd> +<div class="block">Returns an array of all the current Samplers.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/TraceScope.html#getSpan()">getSpan()</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/TraceScope.html" title="class in org.apache.htrace.core">TraceScope</a></dt> +<dd> +<div class="block">Returns the span which this scope is managing.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/MilliSpan.html#getSpanId()">getSpanId()</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/MilliSpan.html" title="class in org.apache.htrace.core">MilliSpan</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/Span.html#getSpanId()">getSpanId()</a></span> - Method in interface org.apache.htrace.core.<a href="./org/apache/htrace/core/Span.html" title="interface in org.apache.htrace.core">Span</a></dt> +<dd> +<div class="block">A pseudo-unique (random) number assigned to this span instance.<p/> + + The spanId is immutable and cannot be changed.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/TraceScope.html#getSpanId()">getSpanId()</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/TraceScope.html" title="class in org.apache.htrace.core">TraceScope</a></dt> +<dd> +<div class="block">Returns the span ID which this scope is managing.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/POJOSpanReceiver.html#getSpans()">getSpans()</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/POJOSpanReceiver.html" title="class in org.apache.htrace.core">POJOSpanReceiver</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/MilliSpan.html#getStartTimeMillis()">getStartTimeMillis()</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/MilliSpan.html" title="class in org.apache.htrace.core">MilliSpan</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/Span.html#getStartTimeMillis()">getStartTimeMillis()</a></span> - Method in interface org.apache.htrace.core.<a href="./org/apache/htrace/core/Span.html" title="interface in org.apache.htrace.core">Span</a></dt> +<dd> +<div class="block">Get the start time, in milliseconds</div> +</dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/MilliSpan.html#getStopTimeMillis()">getStopTimeMillis()</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/MilliSpan.html" title="class in org.apache.htrace.core">MilliSpan</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/Span.html#getStopTimeMillis()">getStopTimeMillis()</a></span> - Method in interface org.apache.htrace.core.<a href="./org/apache/htrace/core/Span.html" title="interface in org.apache.htrace.core">Span</a></dt> +<dd> +<div class="block">Get the stop time, in milliseconds</div> +</dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/TimelineAnnotation.html#getTime()">getTime()</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/TimelineAnnotation.html" title="class in org.apache.htrace.core">TimelineAnnotation</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/MilliSpan.html#getTimelineAnnotations()">getTimelineAnnotations()</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/MilliSpan.html" title="class in org.apache.htrace.core">MilliSpan</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/Span.html#getTimelineAnnotations()">getTimelineAnnotations()</a></span> - Method in interface org.apache.htrace.core.<a href="./org/apache/htrace/core/Span.html" title="interface in org.apache.htrace.core">Span</a></dt> +<dd> +<div class="block">Get any timeline annotations (read only)<p/> + + Will never be null.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/MilliSpan.html#getTracerId()">getTracerId()</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/MilliSpan.html" title="class in org.apache.htrace.core">MilliSpan</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/Span.html#getTracerId()">getTracerId()</a></span> - Method in interface org.apache.htrace.core.<a href="./org/apache/htrace/core/Span.html" title="interface in org.apache.htrace.core">Span</a></dt> +<dd> +<div class="block">Return a unique id for the process from which this Span originated.<p/> + + Will never be null.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/Tracer.html#getTracerId()">getTracerId()</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/Tracer.html" title="class in org.apache.htrace.core">Tracer</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/Tracer.html#getTracerPool()">getTracerPool()</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/Tracer.html" title="class in org.apache.htrace.core">Tracer</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/TracerPool.html#getTracers()">getTracers()</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/TracerPool.html" title="class in org.apache.htrace.core">TracerPool</a></dt> +<dd> +<div class="block">Returns an array of all the current Tracers.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/LocalFileSpanReceiver.html#getUniqueLocalTraceFileName()">getUniqueLocalTraceFileName()</a></span> - Static method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/LocalFileSpanReceiver.html" title="class in org.apache.htrace.core">LocalFileSpanReceiver</a></dt> +<dd> </dd> +</dl> +<a name="_H_"> +<!-- --> +</a> +<h2 class="title">H</h2> +<dl> +<dt><span class="strong"><a href="./org/apache/htrace/core/SpanId.html#hashCode()">hashCode()</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/SpanId.html" title="class in org.apache.htrace.core">SpanId</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/Tracer.html#hashCode()">hashCode()</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/Tracer.html" title="class in org.apache.htrace.core">Tracer</a></dt> +<dd> +<div class="block">Get the hash code of a Tracer object.</div> +</dd> +<dt><a href="./org/apache/htrace/core/HTraceConfiguration.html" title="class in org.apache.htrace.core"><span class="strong">HTraceConfiguration</span></a> - Class in <a href="./org/apache/htrace/core/package-summary.html">org.apache.htrace.core</a></dt> +<dd> +<div class="block">Wrapper which integrating applications should implement in order + to provide tracing configuration.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/HTraceConfiguration.html#HTraceConfiguration()">HTraceConfiguration()</a></span> - Constructor for class org.apache.htrace.core.<a href="./org/apache/htrace/core/HTraceConfiguration.html" title="class in org.apache.htrace.core">HTraceConfiguration</a></dt> +<dd> </dd> +</dl> +<a name="_I_"> +<!-- --> +</a> +<h2 class="title">I</h2> +<dl> +<dt><span class="strong"><a href="./org/apache/htrace/core/AlwaysSampler.html#INSTANCE">INSTANCE</a></span> - Static variable in class org.apache.htrace.core.<a href="./org/apache/htrace/core/AlwaysSampler.html" title="class in org.apache.htrace.core">AlwaysSampler</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/NeverSampler.html#INSTANCE">INSTANCE</a></span> - Static variable in class org.apache.htrace.core.<a href="./org/apache/htrace/core/NeverSampler.html" title="class in org.apache.htrace.core">NeverSampler</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/SpanId.html#INVALID">INVALID</a></span> - Static variable in class org.apache.htrace.core.<a href="./org/apache/htrace/core/SpanId.html" title="class in org.apache.htrace.core">SpanId</a></dt> +<dd> +<div class="block">The invalid span ID, which is all zeroes.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/TraceExecutorService.html#invokeAll(java.util.Collection)">invokeAll(Collection<? extends Callable<T>>)</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/TraceExecutorService.html" title="class in org.apache.htrace.core">TraceExecutorService</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/TraceExecutorService.html#invokeAll(java.util.Collection, long, java.util.concurrent.TimeUnit)">invokeAll(Collection<? extends Callable<T>>, long, TimeUnit)</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/TraceExecutorService.html" title="class in org.apache.htrace.core">TraceExecutorService</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/TraceExecutorService.html#invokeAny(java.util.Collection)">invokeAny(Collection<? extends Callable<T>>)</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/TraceExecutorService.html" title="class in org.apache.htrace.core">TraceExecutorService</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/TraceExecutorService.html#invokeAny(java.util.Collection, long, java.util.concurrent.TimeUnit)">invokeAny(Collection<? extends Callable<T>>, long, TimeUnit)</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/TraceExecutorService.html" title="class in org.apache.htrace.core">TraceExecutorService</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/MilliSpan.html#isRunning()">isRunning()</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/MilliSpan.html" title="class in org.apache.htrace.core">MilliSpan</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/Span.html#isRunning()">isRunning()</a></span> - Method in interface org.apache.htrace.core.<a href="./org/apache/htrace/core/Span.html" title="interface in org.apache.htrace.core">Span</a></dt> +<dd> +<div class="block">Has the span been started and not yet stopped?</div> +</dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/TraceExecutorService.html#isShutdown()">isShutdown()</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/TraceExecutorService.html" title="class in org.apache.htrace.core">TraceExecutorService</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/TraceExecutorService.html#isTerminated()">isTerminated()</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/TraceExecutorService.html" title="class in org.apache.htrace.core">TraceExecutorService</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/SpanId.html#isValid()">isValid()</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/SpanId.html" title="class in org.apache.htrace.core">SpanId</a></dt> +<dd> </dd> +</dl> +<a name="_L_"> +<!-- --> +</a> +<h2 class="title">L</h2> +<dl> +<dt><span class="strong"><a href="./org/apache/htrace/core/TracerPool.html#loadReceiverType(java.lang.String, org.apache.htrace.core.HTraceConfiguration, java.lang.ClassLoader)">loadReceiverType(String, HTraceConfiguration, ClassLoader)</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/TracerPool.html" title="class in org.apache.htrace.core">TracerPool</a></dt> +<dd> +<div class="block">Given a SpanReceiver class name, return the existing instance of that span + receiver, if possible; otherwise, invoke the callable to create a new + instance.</div> +</dd> +<dt><a href="./org/apache/htrace/core/LocalFileSpanReceiver.html" title="class in org.apache.htrace.core"><span class="strong">LocalFileSpanReceiver</span></a> - Class in <a href="./org/apache/htrace/core/package-summary.html">org.apache.htrace.core</a></dt> +<dd> +<div class="block">Writes the spans it receives to a local file.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/LocalFileSpanReceiver.html#LocalFileSpanReceiver(org.apache.htrace.core.HTraceConfiguration)">LocalFileSpanReceiver(HTraceConfiguration)</a></span> - Constructor for class org.apache.htrace.core.<a href="./org/apache/htrace/core/LocalFileSpanReceiver.html" title="class in org.apache.htrace.core">LocalFileSpanReceiver</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/SpanReceiver.Builder.html#logErrors(boolean)">logErrors(boolean)</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/SpanReceiver.Builder.html" title="class in org.apache.htrace.core">SpanReceiver.Builder</a></dt> +<dd> +<div class="block">Configure whether we should log errors during build().</div> +</dd> +</dl> +<a name="_M_"> +<!-- --> +</a> +<h2 class="title">M</h2> +<dl> +<dt><a href="./org/apache/htrace/core/MilliSpan.html" title="class in org.apache.htrace.core"><span class="strong">MilliSpan</span></a> - Class in <a href="./org/apache/htrace/core/package-summary.html">org.apache.htrace.core</a></dt> +<dd> +<div class="block">A Span implementation that stores its information in milliseconds since the + epoch.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/MilliSpan.html#MilliSpan()">MilliSpan()</a></span> - Constructor for class org.apache.htrace.core.<a href="./org/apache/htrace/core/MilliSpan.html" title="class in org.apache.htrace.core">MilliSpan</a></dt> +<dd> </dd> +<dt><a href="./org/apache/htrace/core/MilliSpan.Builder.html" title="class in org.apache.htrace.core"><span class="strong">MilliSpan.Builder</span></a> - Class in <a href="./org/apache/htrace/core/package-summary.html">org.apache.htrace.core</a></dt> +<dd> +<div class="block">The public interface for constructing a MilliSpan.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/MilliSpan.Builder.html#MilliSpan.Builder()">MilliSpan.Builder()</a></span> - Constructor for class org.apache.htrace.core.<a href="./org/apache/htrace/core/MilliSpan.Builder.html" title="class in org.apache.htrace.core">MilliSpan.Builder</a></dt> +<dd> </dd> +<dt><a href="./org/apache/htrace/core/MilliSpan.MilliSpanDeserializer.html" title="class in org.apache.htrace.core"><span class="strong">MilliSpan.MilliSpanDeserializer</span></a> - Class in <a href="./org/apache/htrace/core/package-summary.html">org.apache.htrace.core</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/MilliSpan.MilliSpanDeserializer.html#MilliSpan.MilliSpanDeserializer()">MilliSpan.MilliSpanDeserializer()</a></span> - Constructor for class org.apache.htrace.core.<a href="./org/apache/htrace/core/MilliSpan.MilliSpanDeserializer.html" title="class in org.apache.htrace.core">MilliSpan.MilliSpanDeserializer</a></dt> +<dd> </dd> +</dl> +<a name="_N_"> +<!-- --> +</a> +<h2 class="title">N</h2> +<dl> +<dt><span class="strong"><a href="./org/apache/htrace/core/Tracer.Builder.html#name(java.lang.String)">name(String)</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/Tracer.Builder.html" title="class in org.apache.htrace.core">Tracer.Builder</a></dt> +<dd> +<div class="block"><span class="strong">Deprecated.</span> +<div class="block"><i>Since 4.0.0. Use Constructor that takes a <code>name</code> argument instead.</i></div> +</div> +</dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/Sampler.html#NEVER">NEVER</a></span> - Static variable in class org.apache.htrace.core.<a href="./org/apache/htrace/core/Sampler.html" title="class in org.apache.htrace.core">Sampler</a></dt> +<dd> </dd> +<dt><a href="./org/apache/htrace/core/NeverSampler.html" title="class in org.apache.htrace.core"><span class="strong">NeverSampler</span></a> - Class in <a href="./org/apache/htrace/core/package-summary.html">org.apache.htrace.core</a></dt> +<dd> +<div class="block">A Sampler that never returns true.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/NeverSampler.html#NeverSampler(org.apache.htrace.core.HTraceConfiguration)">NeverSampler(HTraceConfiguration)</a></span> - Constructor for class org.apache.htrace.core.<a href="./org/apache/htrace/core/NeverSampler.html" title="class in org.apache.htrace.core">NeverSampler</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/SpanId.html#newChildId()">newChildId()</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/SpanId.html" title="class in org.apache.htrace.core">SpanId</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/Tracer.html#newNullScope()">newNullScope()</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/Tracer.html" title="class in org.apache.htrace.core">Tracer</a></dt> +<dd> +<div class="block">Return a null trace scope.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/Tracer.html#newScope(java.lang.String, org.apache.htrace.core.SpanId)">newScope(String, SpanId)</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/Tracer.html" title="class in org.apache.htrace.core">Tracer</a></dt> +<dd> +<div class="block">Create a new trace scope.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/Tracer.html#newScope(java.lang.String)">newScope(String)</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/Tracer.html" title="class in org.apache.htrace.core">Tracer</a></dt> +<dd> +<div class="block">Create a new trace scope.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/Tracer.html#newTraceExecutorService(java.util.concurrent.ExecutorService, java.lang.String)">newTraceExecutorService(ExecutorService, String)</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/Tracer.html" title="class in org.apache.htrace.core">Tracer</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/AlwaysSampler.html#next()">next()</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/AlwaysSampler.html" title="class in org.apache.htrace.core">AlwaysSampler</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/CountSampler.html#next()">next()</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/CountSampler.html" title="class in org.apache.htrace.core">CountSampler</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/NeverSampler.html#next()">next()</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/NeverSampler.html" title="class in org.apache.htrace.core">NeverSampler</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/ProbabilitySampler.html#next()">next()</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/ProbabilitySampler.html" title="class in org.apache.htrace.core">ProbabilitySampler</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/Sampler.html#next()">next()</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/Sampler.html" title="class in org.apache.htrace.core">Sampler</a></dt> +<dd> </dd> +</dl> +<a name="_O_"> +<!-- --> +</a> +<h2 class="title">O</h2> +<dl> +<dt><a href="./org/apache/htrace/core/package-summary.html">org.apache.htrace.core</a> - package org.apache.htrace.core</dt> +<dd> </dd> +</dl> +<a name="_P_"> +<!-- --> +</a> +<h2 class="title">P</h2> +<dl> +<dt><span class="strong"><a href="./org/apache/htrace/core/MilliSpan.Builder.html#parents(org.apache.htrace.core.SpanId[])">parents(SpanId[])</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/MilliSpan.Builder.html" title="class in org.apache.htrace.core">MilliSpan.Builder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/MilliSpan.Builder.html#parents(java.util.List)">parents(List<SpanId>)</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/MilliSpan.Builder.html" title="class in org.apache.htrace.core">MilliSpan.Builder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/LocalFileSpanReceiver.html#PATH_KEY">PATH_KEY</a></span> - Static variable in class org.apache.htrace.core.<a href="./org/apache/htrace/core/LocalFileSpanReceiver.html" title="class in org.apache.htrace.core">LocalFileSpanReceiver</a></dt> +<dd> </dd> +<dt><a href="./org/apache/htrace/core/POJOSpanReceiver.html" title="class in org.apache.htrace.core"><span class="strong">POJOSpanReceiver</span></a> - Class in <a href="./org/apache/htrace/core/package-summary.html">org.apache.htrace.core</a></dt> +<dd> +<div class="block">SpanReceiver for testing only that just collects the Span objects it + receives.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/POJOSpanReceiver.html#POJOSpanReceiver(org.apache.htrace.core.HTraceConfiguration)">POJOSpanReceiver(HTraceConfiguration)</a></span> - Constructor for class org.apache.htrace.core.<a href="./org/apache/htrace/core/POJOSpanReceiver.html" title="class in org.apache.htrace.core">POJOSpanReceiver</a></dt> +<dd> </dd> +<dt><a href="./org/apache/htrace/core/ProbabilitySampler.html" title="class in org.apache.htrace.core"><span class="strong">ProbabilitySampler</span></a> - Class in <a href="./org/apache/htrace/core/package-summary.html">org.apache.htrace.core</a></dt> +<dd> +<div class="block">Sampler that returns true a certain percentage of the time.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/ProbabilitySampler.html#ProbabilitySampler(org.apache.htrace.core.HTraceConfiguration)">ProbabilitySampler(HTraceConfiguration)</a></span> - Constructor for class org.apache.htrace.core.<a href="./org/apache/htrace/core/ProbabilitySampler.html" title="class in org.apache.htrace.core">ProbabilitySampler</a></dt> +<dd> </dd> +</dl> +<a name="_R_"> +<!-- --> +</a> +<h2 class="title">R</h2> +<dl> +<dt><span class="strong"><a href="./org/apache/htrace/core/TraceScope.html#reattach()">reattach()</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/TraceScope.html" title="class in org.apache.htrace.core">TraceScope</a></dt> +<dd> +<div class="block">Attach this TraceScope to the current thread.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/LocalFileSpanReceiver.html#receiveSpan(org.apache.htrace.core.Span)">receiveSpan(Span)</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/LocalFileSpanReceiver.html" title="class in org.apache.htrace.core">LocalFileSpanReceiver</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/POJOSpanReceiver.html#receiveSpan(org.apache.htrace.core.Span)">receiveSpan(Span)</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/POJOSpanReceiver.html" title="class in org.apache.htrace.core">POJOSpanReceiver</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/SpanReceiver.html#receiveSpan(org.apache.htrace.core.Span)">receiveSpan(Span)</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/SpanReceiver.html" title="class in org.apache.htrace.core">SpanReceiver</a></dt> +<dd> +<div class="block">Called when a Span is stopped and can now be stored.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/StandardOutSpanReceiver.html#receiveSpan(org.apache.htrace.core.Span)">receiveSpan(Span)</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/StandardOutSpanReceiver.html" title="class in org.apache.htrace.core">StandardOutSpanReceiver</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/TracerPool.html#removeAndCloseReceiver(org.apache.htrace.core.SpanReceiver)">removeAndCloseReceiver(SpanReceiver)</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/TracerPool.html" title="class in org.apache.htrace.core">TracerPool</a></dt> +<dd> +<div class="block">Remove and close a span receiver.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/TracerPool.html#removeReceiver(org.apache.htrace.core.SpanReceiver)">removeReceiver(SpanReceiver)</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/TracerPool.html" title="class in org.apache.htrace.core">TracerPool</a></dt> +<dd> +<div class="block">Remove a span receiver.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/Tracer.html#removeSampler(org.apache.htrace.core.Sampler)">removeSampler(Sampler)</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/Tracer.html" title="class in org.apache.htrace.core">Tracer</a></dt> +<dd> +<div class="block">Remove a SpanReceiver.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/Sampler.Builder.html#reset()">reset()</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/Sampler.Builder.html" title="class in org.apache.htrace.core">Sampler.Builder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/SpanReceiver.Builder.html#reset()">reset()</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/SpanReceiver.Builder.html" title="class in org.apache.htrace.core">SpanReceiver.Builder</a></dt> +<dd> +<div class="block">Set this builder back to defaults.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/TraceRunnable.html#run()">run()</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/TraceRunnable.html" title="class in org.apache.htrace.core">TraceRunnable</a></dt> +<dd> </dd> +</dl> +<a name="_S_"> +<!-- --> +</a> +<h2 class="title">S</h2> +<dl> +<dt><a href="./org/apache/htrace/core/Sampler.html" title="class in org.apache.htrace.core"><span class="strong">Sampler</span></a> - Class in <a href="./org/apache/htrace/core/package-summary.html">org.apache.htrace.core</a></dt> +<dd> +<div class="block">Extremely simple callback to determine the frequency that an action should be + performed.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/Sampler.html#Sampler()">Sampler()</a></span> - Constructor for class org.apache.htrace.core.<a href="./org/apache/htrace/core/Sampler.html" title="class in org.apache.htrace.core">Sampler</a></dt> +<dd> </dd> +<dt><a href="./org/apache/htrace/core/Sampler.Builder.html" title="class in org.apache.htrace.core"><span class="strong">Sampler.Builder</span></a> - Class in <a href="./org/apache/htrace/core/package-summary.html">org.apache.htrace.core</a></dt> +<dd> +<div class="block">A <a href="./org/apache/htrace/core/Sampler.html" title="class in org.apache.htrace.core"><code>Sampler</code></a> builder.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/Sampler.Builder.html#Sampler.Builder(org.apache.htrace.core.HTraceConfiguration)">Sampler.Builder(HTraceConfiguration)</a></span> - Constructor for class org.apache.htrace.core.<a href="./org/apache/htrace/core/Sampler.Builder.html" title="class in org.apache.htrace.core">Sampler.Builder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/Tracer.html#SAMPLER_CLASSES_KEY">SAMPLER_CLASSES_KEY</a></span> - Static variable in class org.apache.htrace.core.<a href="./org/apache/htrace/core/Tracer.html" title="class in org.apache.htrace.core">Tracer</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/ProbabilitySampler.html#SAMPLER_FRACTION_CONF_KEY">SAMPLER_FRACTION_CONF_KEY</a></span> - Static variable in class org.apache.htrace.core.<a href="./org/apache/htrace/core/ProbabilitySampler.html" title="class in org.apache.htrace.core">ProbabilitySampler</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/CountSampler.html#SAMPLER_FREQUENCY_CONF_KEY">SAMPLER_FREQUENCY_CONF_KEY</a></span> - Static variable in class org.apache.htrace.core.<a href="./org/apache/htrace/core/CountSampler.html" title="class in org.apache.htrace.core">CountSampler</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/Span.SpanSerializer.html#serialize(org.apache.htrace.core.Span, com.fasterxml.jackson.core.JsonGenerator, com.fasterxml.jackson.databind.SerializerProvider)">serialize(Span, JsonGenerator, SerializerProvider)</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/Span.SpanSerializer.html" title="class in org.apache.htrace.core">Span.SpanSerializer</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/MilliSpan.html#setParents(org.apache.htrace.core.SpanId[])">setParents(SpanId[])</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/MilliSpan.html" title="class in org.apache.htrace.core">MilliSpan</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/Span.html#setParents(org.apache.htrace.core.SpanId[])">setParents(SpanId[])</a></span> - Method in interface org.apache.htrace.core.<a href="./org/apache/htrace/core/Span.html" title="interface in org.apache.htrace.core">Span</a></dt> +<dd> +<div class="block">Set the parents of this span.<p/> + + Any existing parents will be cleared by this call.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/MilliSpan.html#setTracerId(java.lang.String)">setTracerId(String)</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/MilliSpan.html" title="class in org.apache.htrace.core">MilliSpan</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/Span.html#setTracerId(java.lang.String)">setTracerId(String)</a></span> - Method in interface org.apache.htrace.core.<a href="./org/apache/htrace/core/Span.html" title="interface in org.apache.htrace.core">Span</a></dt> +<dd> +<div class="block">Set the process id of a span.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/TraceExecutorService.html#shutdown()">shutdown()</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/TraceExecutorService.html" title="class in org.apache.htrace.core">TraceExecutorService</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/TraceExecutorService.html#shutdownNow()">shutdownNow()</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/TraceExecutorService.html" title="class in org.apache.htrace.core">TraceExecutorService</a></dt> +<dd> </dd> +<dt><a href="./org/apache/htrace/core/Span.html" title="interface in org.apache.htrace.core"><span class="strong">Span</span></a> - Interface in <a href="./org/apache/htrace/core/package-summary.html">org.apache.htrace.core</a></dt> +<dd> +<div class="block">Base interface for gathering and reporting statistics about a block of + execution.</div> +</dd> +<dt><a href="./org/apache/htrace/core/Span.SpanSerializer.html" title="class in org.apache.htrace.core"><span class="strong">Span.SpanSerializer</span></a> - Class in <a href="./org/apache/htrace/core/package-summary.html">org.apache.htrace.core</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/Span.SpanSerializer.html#Span.SpanSerializer()">Span.SpanSerializer()</a></span> - Constructor for class org.apache.htrace.core.<a href="./org/apache/htrace/core/Span.SpanSerializer.html" title="class in org.apache.htrace.core">Span.SpanSerializer</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/Tracer.html#SPAN_RECEIVER_CLASSES_KEY">SPAN_RECEIVER_CLASSES_KEY</a></span> - Static variable in class org.apache.htrace.core.<a href="./org/apache/htrace/core/Tracer.html" title="class in org.apache.htrace.core">Tracer</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/MilliSpan.Builder.html#spanId(org.apache.htrace.core.SpanId)">spanId(SpanId)</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/MilliSpan.Builder.html" title="class in org.apache.htrace.core">MilliSpan.Builder</a></dt> +<dd> </dd> +<dt><a href="./org/apache/htrace/core/SpanId.html" title="class in org.apache.htrace.core"><span class="strong">SpanId</span></a> - Class in <a href="./org/apache/htrace/core/package-summary.html">org.apache.htrace.core</a></dt> +<dd> +<div class="block">Uniquely identifies an HTrace span.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/SpanId.html#SpanId(long, long)">SpanId(long, long)</a></span> - Constructor for class org.apache.htrace.core.<a href="./org/apache/htrace/core/SpanId.html" title="class in org.apache.htrace.core">SpanId</a></dt> +<dd> </dd> +<dt><a href="./org/apache/htrace/core/SpanReceiver.html" title="class in org.apache.htrace.core"><span class="strong">SpanReceiver</span></a> - Class in <a href="./org/apache/htrace/core/package-summary.html">org.apache.htrace.core</a></dt> +<dd> +<div class="block">The collector within a process that is the destination of Spans when a trace is running.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/SpanReceiver.html#SpanReceiver()">SpanReceiver()</a></span> - Constructor for class org.apache.htrace.core.<a href="./org/apache/htrace/core/SpanReceiver.html" title="class in org.apache.htrace.core">SpanReceiver</a></dt> +<dd> </dd> +<dt><a href="./org/apache/htrace/core/SpanReceiver.Builder.html" title="class in org.apache.htrace.core"><span class="strong">SpanReceiver.Builder</span></a> - Class in <a href="./org/apache/htrace/core/package-summary.html">org.apache.htrace.core</a></dt> +<dd> +<div class="block">A <a href="./org/apache/htrace/core/SpanReceiver.html" title="class in org.apache.htrace.core"><code>SpanReceiver</code></a> builder.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/SpanReceiver.Builder.html#SpanReceiver.Builder(org.apache.htrace.core.HTraceConfiguration)">SpanReceiver.Builder(HTraceConfiguration)</a></span> - Constructor for class org.apache.htrace.core.<a href="./org/apache/htrace/core/SpanReceiver.Builder.html" title="class in org.apache.htrace.core">SpanReceiver.Builder</a></dt> +<dd> </dd> +<dt><a href="./org/apache/htrace/core/StandardOutSpanReceiver.html" title="class in org.apache.htrace.core"><span class="strong">StandardOutSpanReceiver</span></a> - Class in <a href="./org/apache/htrace/core/package-summary.html">org.apache.htrace.core</a></dt> +<dd> +<div class="block">Used for testing.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/StandardOutSpanReceiver.html#StandardOutSpanReceiver(org.apache.htrace.core.HTraceConfiguration)">StandardOutSpanReceiver(HTraceConfiguration)</a></span> - Constructor for class org.apache.htrace.core.<a href="./org/apache/htrace/core/StandardOutSpanReceiver.html" title="class in org.apache.htrace.core">StandardOutSpanReceiver</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/MilliSpan.html#stop()">stop()</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/MilliSpan.html" title="class in org.apache.htrace.core">MilliSpan</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/Span.html#stop()">stop()</a></span> - Method in interface org.apache.htrace.core.<a href="./org/apache/htrace/core/Span.html" title="interface in org.apache.htrace.core">Span</a></dt> +<dd> +<div class="block">The block has completed, stop the clock</div> +</dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/TraceExecutorService.html#submit(java.util.concurrent.Callable)">submit(Callable<T>)</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/TraceExecutorService.html" title="class in org.apache.htrace.core">TraceExecutorService</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/TraceExecutorService.html#submit(java.lang.Runnable, T)">submit(Runnable, T)</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/TraceExecutorService.html" title="class in org.apache.htrace.core">TraceExecutorService</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/TraceExecutorService.html#submit(java.lang.Runnable)">submit(Runnable)</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/TraceExecutorService.html" title="class in org.apache.htrace.core">TraceExecutorService</a></dt> +<dd> </dd> +</dl> +<a name="_T_"> +<!-- --> +</a> +<h2 class="title">T</h2> +<dl> +<dt><span class="strong"><a href="./org/apache/htrace/core/ProbabilitySampler.html#threshold">threshold</a></span> - Variable in class org.apache.htrace.core.<a href="./org/apache/htrace/core/ProbabilitySampler.html" title="class in org.apache.htrace.core">ProbabilitySampler</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/MilliSpan.Builder.html#timeline(java.util.List)">timeline(List<TimelineAnnotation>)</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/MilliSpan.Builder.html" title="class in org.apache.htrace.core">MilliSpan.Builder</a></dt> +<dd> </dd> +<dt><a href="./org/apache/htrace/core/TimelineAnnotation.html" title="class in org.apache.htrace.core"><span class="strong">TimelineAnnotation</span></a> - Class in <a href="./org/apache/htrace/core/package-summary.html">org.apache.htrace.core</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/TimelineAnnotation.html#TimelineAnnotation(long, java.lang.String)">TimelineAnnotation(long, String)</a></span> - Constructor for class org.apache.htrace.core.<a href="./org/apache/htrace/core/TimelineAnnotation.html" title="class in org.apache.htrace.core">TimelineAnnotation</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/MilliSpan.html#toJson()">toJson()</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/MilliSpan.html" title="class in org.apache.htrace.core">MilliSpan</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/Span.html#toJson()">toJson()</a></span> - Method in interface org.apache.htrace.core.<a href="./org/apache/htrace/core/Span.html" title="interface in org.apache.htrace.core">Span</a></dt> +<dd> +<div class="block">Serialize to Json</div> +</dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/MilliSpan.html#toString()">toString()</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/MilliSpan.html" title="class in org.apache.htrace.core">MilliSpan</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/Span.html#toString()">toString()</a></span> - Method in interface org.apache.htrace.core.<a href="./org/apache/htrace/core/Span.html" title="interface in org.apache.htrace.core">Span</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/SpanId.html#toString()">toString()</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/SpanId.html" title="class in org.apache.htrace.core">SpanId</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/TimelineAnnotation.html#toString()">toString()</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/TimelineAnnotation.html" title="class in org.apache.htrace.core">TimelineAnnotation</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/Tracer.html#toString()">toString()</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/Tracer.html" title="class in org.apache.htrace.core">Tracer</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/TracerPool.html#toString()">toString()</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/TracerPool.html" title="class in org.apache.htrace.core">TracerPool</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/TraceScope.html#toString()">toString()</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/TraceScope.html" title="class in org.apache.htrace.core">TraceScope</a></dt> +<dd> </dd> +<dt><a href="./org/apache/htrace/core/TraceCallable.html" title="class in org.apache.htrace.core"><span class="strong">TraceCallable</span></a><<a href="./org/apache/htrace/core/TraceCallable.html" title="type parameter in TraceCallable">V</a>> - Class in <a href="./org/apache/htrace/core/package-summary.html">org.apache.htrace.core</a></dt> +<dd> +<div class="block">Wrap a Callable with a Span that survives a change in threads.</div> +</dd> +<dt><a href="./org/apache/htrace/core/TraceExecutorService.html" title="class in org.apache.htrace.core"><span class="strong">TraceExecutorService</span></a> - Class in <a href="./org/apache/htrace/core/package-summary.html">org.apache.htrace.core</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/MilliSpan.Builder.html#traceInfo(java.util.Map)">traceInfo(Map<String, String>)</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/MilliSpan.Builder.html" title="class in org.apache.htrace.core">MilliSpan.Builder</a></dt> +<dd> </dd> +<dt><a href="./org/apache/htrace/core/Tracer.html" title="class in org.apache.htrace.core"><span class="strong">Tracer</span></a> - Class in <a href="./org/apache/htrace/core/package-summary.html">org.apache.htrace.core</a></dt> +<dd> +<div class="block">Use a Tracer instance inside a 'process' to collect and distribute its trace Spans.</div> +</dd> +<dt><a href="./org/apache/htrace/core/Tracer.Builder.html" title="class in org.apache.htrace.core"><span class="strong">Tracer.Builder</span></a> - Class in <a href="./org/apache/htrace/core/package-summary.html">org.apache.htrace.core</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/Tracer.Builder.html#Tracer.Builder()">Tracer.Builder()</a></span> - Constructor for class org.apache.htrace.core.<a href="./org/apache/htrace/core/Tracer.Builder.html" title="class in org.apache.htrace.core">Tracer.Builder</a></dt> +<dd> +<div class="block"><span class="strong">Deprecated.</span> +<div class="block"><i>Since 4.0.0. Use Constructor that takes a <code>name</code> argument instead</i></div> +</div> +</dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/Tracer.Builder.html#Tracer.Builder(java.lang.String)">Tracer.Builder(String)</a></span> - Constructor for class org.apache.htrace.core.<a href="./org/apache/htrace/core/Tracer.Builder.html" title="class in org.apache.htrace.core">Tracer.Builder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/TracerId.html#TRACER_ID_KEY">TRACER_ID_KEY</a></span> - Static variable in class org.apache.htrace.core.<a href="./org/apache/htrace/core/TracerId.html" title="class in org.apache.htrace.core">TracerId</a></dt> +<dd> +<div class="block">The configuration key to use for process id</div> +</dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/MilliSpan.Builder.html#tracerId(java.lang.String)">tracerId(String)</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/MilliSpan.Builder.html" title="class in org.apache.htrace.core">MilliSpan.Builder</a></dt> +<dd> </dd> +<dt><a href="./org/apache/htrace/core/TracerId.html" title="class in org.apache.htrace.core"><span class="strong">TracerId</span></a> - Class in <a href="./org/apache/htrace/core/package-summary.html">org.apache.htrace.core</a></dt> +<dd> +<div class="block">The HTrace tracer ID.<p/> + + HTrace tracer IDs are created from format strings.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/TracerId.html#TracerId(org.apache.htrace.core.HTraceConfiguration, java.lang.String)">TracerId(HTraceConfiguration, String)</a></span> - Constructor for class org.apache.htrace.core.<a href="./org/apache/htrace/core/TracerId.html" title="class in org.apache.htrace.core">TracerId</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/Tracer.Builder.html#tracerPool(org.apache.htrace.core.TracerPool)">tracerPool(TracerPool)</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/Tracer.Builder.html" title="class in org.apache.htrace.core">Tracer.Builder</a></dt> +<dd> </dd> +<dt><a href="./org/apache/htrace/core/TracerPool.html" title="class in org.apache.htrace.core"><span class="strong">TracerPool</span></a> - Class in <a href="./org/apache/htrace/core/package-summary.html">org.apache.htrace.core</a></dt> +<dd> +<div class="block">A pool of Tracer objects.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/TracerPool.html#TracerPool(java.lang.String)">TracerPool(String)</a></span> - Constructor for class org.apache.htrace.core.<a href="./org/apache/htrace/core/TracerPool.html" title="class in org.apache.htrace.core">TracerPool</a></dt> +<dd> </dd> +<dt><a href="./org/apache/htrace/core/TraceRunnable.html" title="class in org.apache.htrace.core"><span class="strong">TraceRunnable</span></a> - Class in <a href="./org/apache/htrace/core/package-summary.html">org.apache.htrace.core</a></dt> +<dd> +<div class="block">Wrap a Runnable with a Span that survives a change in threads.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/TraceRunnable.html#TraceRunnable(org.apache.htrace.core.Tracer, org.apache.htrace.core.TraceScope, java.lang.Runnable, java.lang.String)">TraceRunnable(Tracer, TraceScope, Runnable, String)</a></span> - Constructor for class org.apache.htrace.core.<a href="./org/apache/htrace/core/TraceRunnable.html" title="class in org.apache.htrace.core">TraceRunnable</a></dt> +<dd> </dd> +<dt><a href="./org/apache/htrace/core/TraceScope.html" title="class in org.apache.htrace.core"><span class="strong">TraceScope</span></a> - Class in <a href="./org/apache/htrace/core/package-summary.html">org.apache.htrace.core</a></dt> +<dd> +<div class="block">Create a new TraceScope at major transitions.</div> +</dd> +</dl> +<a name="_W_"> +<!-- --> +</a> +<h2 class="title">W</h2> +<dl> +<dt><span class="strong"><a href="./org/apache/htrace/core/Tracer.html#wrap(java.util.concurrent.Callable, java.lang.String)">wrap(Callable<V>, String)</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/Tracer.html" title="class in org.apache.htrace.core">Tracer</a></dt> +<dd> +<div class="block">Wrap the callable in a TraceCallable, if tracing.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/htrace/core/Tracer.html#wrap(java.lang.Runnable, java.lang.String)">wrap(Runnable, String)</a></span> - Method in class org.apache.htrace.core.<a href="./org/apache/htrace/core/Tracer.html" title="class in org.apache.htrace.core">Tracer</a></dt> +<dd> +<div class="block">Wrap the runnable in a TraceRunnable, if tracing</div> +</dd> +</dl> +<a href="#_A_">A</a> <a href="#_B_">B</a> <a href="#_C_">C</a> <a href="#_D_">D</a> <a href="#_E_">E</a> <a href="#_F_">F</a> <a href="#_G_">G</a> <a href="#_H_">H</a> <a href="#_I_">I</a> <a href="#_L_">L</a> <a href="#_M_">M</a> <a href="#_N_">N</a> <a href="#_O_">O</a> <a href="#_P_">P</a> <a href="#_R_">R</a> <a href="#_S_">S</a> <a href="#_T_">T</a> <a href="#_W_">W</a> </div> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="./org/apache/htrace/core/package-summary.html">Package</a></li> +<li>Class</li> +<li>Use</li> +<li><a href="./org/apache/htrace/core/package-tree.html">Tree</a></li> +<li><a href="./deprecated-list.html">Deprecated</a></li> +<li class="navBarCell1Rev">Index</li> +<li><a href="./help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="./index.html?index-all.html" target="_top">Frames</a></li> +<li><a href="index-all.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="./allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2016 <a href="http://www.apache.org/";>The Apache Software Foundation</a>. All Rights Reserved.</small></p> +</body> +</html>
Added: incubator/htrace/site/javadoc/4.1/htrace-core/index.html URL: http://svn.apache.org/viewvc/incubator/htrace/site/javadoc/4.1/htrace-core/index.html?rev=1741130&view=auto ============================================================================== --- incubator/htrace/site/javadoc/4.1/htrace-core/index.html (added) +++ incubator/htrace/site/javadoc/4.1/htrace-core/index.html Wed Apr 27 00:25:13 2016 @@ -0,0 +1,31 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN" "http://www.w3.org/TR/html4/frameset.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc on Tue Apr 26 16:57:36 PDT 2016 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>htrace-core4 4.1.0-incubating API</title> +<script type="text/javascript"> + targetPage = "" + window.location.search; + if (targetPage != "" && targetPage != "undefined") + targetPage = targetPage.substring(1); + if (targetPage.indexOf(":") != -1) + targetPage = "undefined"; + function loadFrames() { + if (targetPage != "" && targetPage != "undefined") + top.classFrame.location = top.targetPage; + } +</script> +</head> +<frameset cols="20%,80%" title="Documentation frame" onload="top.loadFrames()"> +<frame src="allclasses-frame.html" name="packageFrame" title="All classes and interfaces (except non-static nested types)"> +<frame src="org/apache/htrace/core/package-summary.html" name="classFrame" title="Package, class and interface descriptions" scrolling="yes"> +<noframes> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<h2>Frame Alert</h2> +<p>This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client. Link to <a href="org/apache/htrace/core/package-summary.html">Non-frame version</a>.</p> +</noframes> +</frameset> +</html>
