Index (htrace-core 3.0 API)

A C D E F G H I L M N O P R S T W

A

addKVAnnotation(byte[], byte[]) - Method in class org.htrace.impl.MilliSpan
addKVAnnotation(byte[], byte[]) - Method in interface org.htrace.Span: Add a data annotation associated with this span
addKVAnnotation(byte[], byte[]) - Static method in class org.htrace.Trace: Adds a data annotation to the current span if tracing is currently on.
addReceiver(SpanReceiver) - Static method in class org.htrace.Trace: Adds the given SpanReceiver to the current Tracer instance's list of SpanReceivers.
addReceiver(SpanReceiver) - Method in class org.htrace.Tracer
addTimelineAnnotation(String) - Method in class org.htrace.impl.MilliSpan
addTimelineAnnotation(String) - Method in interface org.htrace.Span: Add a timeline annotation associated with this span
addTimelineAnnotation(String) - Static method in class org.htrace.Trace: Annotate the current span with the given message.
ALWAYS - Static variable in interface org.htrace.Sampler
AlwaysSampler - Class in org.htrace.impl
awaitTermination(long, TimeUnit) - Method in class org.htrace.wrappers.TraceExecutorService

C

call() - Method in class org.htrace.wrappers.TraceCallable
child(String) - Method in class org.htrace.impl.MilliSpan
child(String) - Method in interface org.htrace.Span: Create a child span of this span with the given description
close() - Method in class org.htrace.impl.LocalFileSpanReceiver
close() - Method in class org.htrace.impl.POJOSpanReceiver
close() - Method in class org.htrace.impl.StandardOutSpanReceiver
close() - Method in class org.htrace.TraceScope
configure(HTraceConfiguration) - Method in class org.htrace.impl.LocalFileSpanReceiver
configure(HTraceConfiguration) - Method in class org.htrace.impl.POJOSpanReceiver
configure(HTraceConfiguration) - Method in class org.htrace.impl.StandardOutSpanReceiver
configure(HTraceConfiguration) - Method in interface org.htrace.SpanReceiver: Hosts of SpanReceivers should call this method to provide configuration to SpanReceivers after creating them.
continueSpan(Span) - Static method in class org.htrace.Trace: Pick up an existing span from another thread.
continueSpan(Span) - Method in class org.htrace.Tracer
CountSampler - Class in org.htrace.impl: Sampler that returns true every N calls.
CountSampler(long) - Constructor for class org.htrace.impl.CountSampler
createNew(String) - Method in class org.htrace.Tracer
currentSpan() - Static method in class org.htrace.Trace: If we are tracing, return the current span, else null
currentSpan() - Method in class org.htrace.Tracer
currentTimeMillis() - Method in class org.htrace.impl.MilliSpan

D

DEFAULT_CAPACITY - Static variable in class org.htrace.impl.LocalFileSpanReceiver
DEFAULT_EXECUTOR_TERMINATION_TIMEOUT_DURATION - Static variable in class org.htrace.impl.LocalFileSpanReceiver
deliver(Span) - Method in class org.htrace.Tracer
detach() - Method in class org.htrace.TraceScope: Remove this span as the current thread, but don't stop it yet or send it for collection.
DONT_TRACE - Static variable in class org.htrace.Tracer

E

execute(Runnable) - Method in class org.htrace.wrappers.TraceExecutorService

F

fromMap(Map<String, String>) - Static method in class org.htrace.HTraceConfiguration
fromSpan(Span) - Static method in class org.htrace.TraceInfo

G

get(String) - Method in class org.htrace.HTraceConfiguration
get(String, String) - Method in class org.htrace.HTraceConfiguration
getAccumulatedMillis() - Method in class org.htrace.impl.MilliSpan
getAccumulatedMillis() - Method in interface org.htrace.Span: Return the total amount of time elapsed since start was called, if running, or difference between stop and start
getBoolean(String, boolean) - Method in class org.htrace.HTraceConfiguration
getDescription() - Method in class org.htrace.impl.MilliSpan
getDescription() - Method in interface org.htrace.Span: Return a textual description of this span
getImpl() - Method in class org.htrace.wrappers.TraceCallable
getInstance() - Static method in class org.htrace.Tracer
getInt(String, int) - Method in class org.htrace.HTraceConfiguration
getKVAnnotations() - Method in class org.htrace.impl.MilliSpan
getKVAnnotations() - Method in interface org.htrace.Span: Get data associated with this span (read only)
getMessage() - Method in class org.htrace.TimelineAnnotation
getParentId() - Method in class org.htrace.impl.MilliSpan
getParentId() - Method in interface org.htrace.Span: Return the pseudo-unique (random) number of the parent span, returns ROOT_SPAN_ID if this is the root span
getProcessId() - Method in class org.htrace.impl.MilliSpan
getProcessId() - Method in interface org.htrace.Span: Return a unique id for the node or process from which this Span originated.
getRoots() - Method in class org.htrace.TraceTree
getSpan() - Method in class org.htrace.TraceScope
getSpanId() - Method in class org.htrace.impl.MilliSpan
getSpanId() - Method in interface org.htrace.Span: A pseudo-unique (random) number assigned to this span instance
getSpans() - Method in class org.htrace.impl.POJOSpanReceiver
getSpans() - Method in class org.htrace.TraceTree
getSpansByParentIdMap() - Method in class org.htrace.TraceTree
getSpansByPidMap() - Method in class org.htrace.TraceTree
getStartTimeMillis() - Method in class org.htrace.impl.MilliSpan
getStartTimeMillis() - Method in interface org.htrace.Span: Get the start time, in milliseconds
getStopTimeMillis() - Method in class org.htrace.impl.MilliSpan
getStopTimeMillis() - Method in interface org.htrace.Span: Get the stop time, in milliseconds
getTime() - Method in class org.htrace.TimelineAnnotation
getTimelineAnnotations() - Method in class org.htrace.impl.MilliSpan
getTimelineAnnotations() - Method in interface org.htrace.Span: Get any timeline annotations (read only)
getTraceId() - Method in class org.htrace.impl.MilliSpan
getTraceId() - Method in interface org.htrace.Span: A pseudo-unique (random) number assigned to the trace associated with this span

H

HTraceConfiguration - Class in org.htrace: Wrapper which integrating applications should implement in order to provide tracing configuration.
HTraceConfiguration() - Constructor for class org.htrace.HTraceConfiguration

I

INSTANCE - Static variable in class org.htrace.impl.AlwaysSampler
INSTANCE - Static variable in class org.htrace.impl.NeverSampler
INSTANCE - Static variable in class org.htrace.impl.TrueIfTracingSampler
invokeAll(Collection<? extends Callable<T>>) - Method in class org.htrace.wrappers.TraceExecutorService
invokeAll(Collection<? extends Callable<T>>, long, TimeUnit) - Method in class org.htrace.wrappers.TraceExecutorService
invokeAny(Collection<? extends Callable<T>>) - Method in class org.htrace.wrappers.TraceExecutorService
invokeAny(Collection<? extends Callable<T>>, long, TimeUnit) - Method in class org.htrace.wrappers.TraceExecutorService
isRunning() - Method in class org.htrace.impl.MilliSpan
isRunning() - Method in interface org.htrace.Span: Has the span been started and not yet stopped?
isShutdown() - Method in class org.htrace.wrappers.TraceExecutorService
isTerminated() - Method in class org.htrace.wrappers.TraceExecutorService
isTracing() - Static method in class org.htrace.Trace: Returns true if the current thread is a part of a trace, false otherwise.
isTracing() - Method in class org.htrace.Tracer

L

LocalFileSpanReceiver - Class in org.htrace.impl: Writes the spans it receives to a local file.
LocalFileSpanReceiver() - Constructor for class org.htrace.impl.LocalFileSpanReceiver
LOG - Static variable in class org.htrace.impl.LocalFileSpanReceiver
LOG - Static variable in class org.htrace.Tracer
LOG - Static variable in class org.htrace.TraceTree

M

MilliSpan - Class in org.htrace.impl: A Span implementation that stores its information in milliseconds since the epoch.
MilliSpan(String, long, long, long, String) - Constructor for class org.htrace.impl.MilliSpan

N

NEVER - Static variable in interface org.htrace.Sampler
NeverSampler - Class in org.htrace.impl
next(Object) - Method in class org.htrace.impl.AlwaysSampler
next(Object) - Method in class org.htrace.impl.CountSampler
next(Object) - Method in class org.htrace.impl.NeverSampler
next(Object) - Method in class org.htrace.impl.ProbabilitySampler
next(Object) - Method in class org.htrace.impl.TrueIfTracingSampler
next(T) - Method in interface org.htrace.Sampler
numReceivers() - Method in class org.htrace.Tracer

O

org.htrace - package org.htrace
org.htrace.impl - package org.htrace.impl
org.htrace.wrappers - package org.htrace.wrappers

P

POJOSpanReceiver - Class in org.htrace.impl: SpanReceiver for testing only that just collects the Span objects it receives.
POJOSpanReceiver() - Constructor for class org.htrace.impl.POJOSpanReceiver
ProbabilitySampler - Class in org.htrace.impl
ProbabilitySampler(double) - Constructor for class org.htrace.impl.ProbabilitySampler
processId - Static variable in class org.htrace.Tracer

R

receiveSpan(Span) - Method in class org.htrace.impl.LocalFileSpanReceiver
receiveSpan(Span) - Method in class org.htrace.impl.POJOSpanReceiver
receiveSpan(Span) - Method in class org.htrace.impl.StandardOutSpanReceiver
receiveSpan(Span) - Method in interface org.htrace.SpanReceiver: Called when a Span is stopped and can now be stored.
removeReceiver(SpanReceiver) - Static method in class org.htrace.Trace: Removes the given SpanReceiver from the list of SpanReceivers.
removeReceiver(SpanReceiver) - Method in class org.htrace.Tracer
ROOT_SPAN_ID - Static variable in interface org.htrace.Span
run() - Method in class org.htrace.wrappers.TraceRunnable

S

Sampler<T> - Interface in org.htrace: Extremely simple callback to determine the frequency that an action should be performed.
setCurrentSpan(Span) - Method in class org.htrace.Tracer
setProcessId(String) - Static method in class org.htrace.Trace: Set the processId to be used for all Spans created by this Tracer.
shutdown() - Method in class org.htrace.wrappers.TraceExecutorService
shutdownNow() - Method in class org.htrace.wrappers.TraceExecutorService
Span - Interface in org.htrace: Base interface for gathering and reporting statistics about a block of execution.
spanId - Variable in class org.htrace.TraceInfo
SpanReceiver - Interface in org.htrace: The collector within a process that is the destination of Spans when a trace is running.
StandardOutSpanReceiver - Class in org.htrace.impl: Used for testing.
StandardOutSpanReceiver() - Constructor for class org.htrace.impl.StandardOutSpanReceiver
startSpan(String) - Static method in class org.htrace.Trace: Starts and returns a new span as the child of the current span if the default sampler (TrueIfTracingSampler) returns true, otherwise returns the NullSpan.
startSpan(String, Span) - Static method in class org.htrace.Trace: Starts and returns a new span as the child of the parameter 'parent'.
startSpan(String, TraceInfo) - Static method in class org.htrace.Trace
startSpan(String, Sampler<T>) - Static method in class org.htrace.Trace
startSpan(String, Sampler<TraceInfo>, TraceInfo) - Static method in class org.htrace.Trace
startSpan(String, Sampler<T>, T) - Static method in class org.htrace.Trace
stop() - Method in class org.htrace.impl.MilliSpan
stop() - Method in interface org.htrace.Span: The block has completed, stop the clock
submit(Callable<T>) - Method in class org.htrace.wrappers.TraceExecutorService
submit(Runnable, T) - Method in class org.htrace.wrappers.TraceExecutorService
submit(Runnable) - Method in class org.htrace.wrappers.TraceExecutorService

T

threshold - Variable in class org.htrace.impl.ProbabilitySampler
TimelineAnnotation - Class in org.htrace
TimelineAnnotation(long, String) - Constructor for class org.htrace.TimelineAnnotation
toString() - Method in class org.htrace.impl.MilliSpan
toString() - Method in interface org.htrace.Span
toString() - Method in class org.htrace.TimelineAnnotation
toString() - Method in class org.htrace.TraceInfo
Trace - Class in org.htrace: The primary way to interact with the library.
Trace() - Constructor for class org.htrace.Trace
trace(T) - Static method in class org.htrace.wrappers.TraceProxy: Returns an object that will trace all calls to itself.
trace(T, Sampler<V>) - Static method in class org.htrace.wrappers.TraceProxy: Returns an object that will trace all calls to itself.
TraceCallable<V> - Class in org.htrace.wrappers: Wrap a Callable with a Span that survives a change in threads.
TraceCallable(Callable<V>) - Constructor for class org.htrace.wrappers.TraceCallable
TraceCallable(Span, Callable<V>) - Constructor for class org.htrace.wrappers.TraceCallable
TraceCallable(Span, Callable<V>, String) - Constructor for class org.htrace.wrappers.TraceCallable
TraceExecutorService - Class in org.htrace.wrappers
TraceExecutorService(ExecutorService) - Constructor for class org.htrace.wrappers.TraceExecutorService
traceId - Variable in class org.htrace.TraceInfo
TraceInfo - Class in org.htrace
TraceInfo(long, long) - Constructor for class org.htrace.TraceInfo
TraceProxy - Class in org.htrace.wrappers
TraceProxy() - Constructor for class org.htrace.wrappers.TraceProxy
Tracer - Class in org.htrace: A Tracer provides the implementation for collecting and distributing Spans within a process.
Tracer() - Constructor for class org.htrace.Tracer
TraceRunnable - Class in org.htrace.wrappers: Wrap a Runnable with a Span that survives a change in threads.
TraceRunnable(Runnable) - Constructor for class org.htrace.wrappers.TraceRunnable
TraceRunnable(Span, Runnable) - Constructor for class org.htrace.wrappers.TraceRunnable
TraceRunnable(Span, Runnable, String) - Constructor for class org.htrace.wrappers.TraceRunnable
TraceScope - Class in org.htrace
TraceTree - Class in org.htrace: Used to create the graph formed by spans.
TraceTree(Collection<Span>) - Constructor for class org.htrace.TraceTree: Create a new TraceTree
TrueIfTracingSampler - Class in org.htrace.impl: A Sampler that returns true if and only if tracing is on the current thread.

W

wrap(Callable<V>) - Static method in class org.htrace.Trace: Wrap the callable in a TraceCallable, if tracing.
wrap(Runnable) - Static method in class org.htrace.Trace: Wrap the runnable in a TraceRunnable, if tracing
wrap(String, Runnable) - Static method in class org.htrace.Trace: Wrap the runnable in a TraceRunnable, if tracing

A C D E F G H I L M N O P R S T W