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

A

addKVAnnotation(String, String) - Method in class org.apache.htrace.core.MilliSpan

addKVAnnotation(String, String) - Method in interface org.apache.htrace.core.Span

Add a data annotation associated with this span

addKVAnnotation(String, String) - Method in class org.apache.htrace.core.TraceScope

addReceiver(SpanReceiver) - Method in class org.apache.htrace.core.TracerPool

Add a new span receiver.

addSampler(Sampler) - Method in class org.apache.htrace.core.Tracer

Add a new Sampler.

addTimelineAnnotation(String) - Method in class org.apache.htrace.core.MilliSpan

addTimelineAnnotation(String) - Method in interface org.apache.htrace.core.Span

Add a timeline annotation associated with this span

addTimelineAnnotation(String) - Method in class org.apache.htrace.core.TraceScope

ALWAYS - Static variable in class org.apache.htrace.core.Sampler

AlwaysSampler - Class in org.apache.htrace.core

A Sampler that always returns true.

AlwaysSampler(HTraceConfiguration) - Constructor for class org.apache.htrace.core.AlwaysSampler

awaitTermination(long, TimeUnit) - Method in class org.apache.htrace.core.TraceExecutorService

B

begin(long) - Method in class org.apache.htrace.core.MilliSpan.Builder

build() - Method in class org.apache.htrace.core.MilliSpan.Builder

build() - Method in class org.apache.htrace.core.Sampler.Builder

build() - Method in class org.apache.htrace.core.SpanReceiver.Builder

build() - Method in class org.apache.htrace.core.Tracer.Builder

C

call() - Method in class org.apache.htrace.core.TraceCallable

CAPACITY_DEFAULT - Static variable in class org.apache.htrace.core.LocalFileSpanReceiver

CAPACITY_KEY - Static variable in class org.apache.htrace.core.LocalFileSpanReceiver

child(String) - Method in class org.apache.htrace.core.MilliSpan

child(String) - Method in interface org.apache.htrace.core.Span

Deprecated.

Since 4.0.0. Use MilliSpan.Builder

classLoader(ClassLoader) - Method in class org.apache.htrace.core.Sampler.Builder

classLoader(ClassLoader) - Method in class org.apache.htrace.core.SpanReceiver.Builder

className(String) - Method in class org.apache.htrace.core.Sampler.Builder

className(String) - Method in class org.apache.htrace.core.SpanReceiver.Builder

close() - Method in class org.apache.htrace.core.LocalFileSpanReceiver

close() - Method in class org.apache.htrace.core.POJOSpanReceiver

close() - Method in class org.apache.htrace.core.StandardOutSpanReceiver

close() - Method in class org.apache.htrace.core.Tracer

close() - Method in class org.apache.htrace.core.TraceScope

Close this TraceScope, ending the trace span it is managing.

compareTo(SpanId) - Method in class org.apache.htrace.core.SpanId

conf(HTraceConfiguration) - Method in class org.apache.htrace.core.Tracer.Builder

CountSampler - Class in org.apache.htrace.core

Sampler that returns true every N calls.

CountSampler(HTraceConfiguration) - Constructor for class org.apache.htrace.core.CountSampler

currentTimeMillis() - Method in class org.apache.htrace.core.MilliSpan

curThreadTracer() - Static method in class org.apache.htrace.core.Tracer

D

description(String) - Method in class org.apache.htrace.core.MilliSpan.Builder

deserialize(JsonParser, DeserializationContext) - Method in class org.apache.htrace.core.MilliSpan.MilliSpanDeserializer

detach() - Method in class org.apache.htrace.core.TraceScope

Detach this TraceScope from the current thread.

E

EMPTY - Static variable in class org.apache.htrace.core.HTraceConfiguration

An empty HTrace configuration.

end(long) - Method in class org.apache.htrace.core.MilliSpan.Builder

equals(Object) - Method in class org.apache.htrace.core.SpanId

equals(Object) - Method in class org.apache.htrace.core.Tracer

Compare two tracer objects.

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

F

fromJson(String) - Static method in class org.apache.htrace.core.MilliSpan

fromKeyValuePairs(String...) - Static method in class org.apache.htrace.core.HTraceConfiguration

fromMap(Map<String, String>) - Static method in class org.apache.htrace.core.HTraceConfiguration

Create an HTrace configuration from a map.

fromRandom() - Static method in class org.apache.htrace.core.SpanId

fromString(String) - Static method in class org.apache.htrace.core.SpanId

G

get(String) - Method in class org.apache.htrace.core.HTraceConfiguration

get(String, String) - Method in class org.apache.htrace.core.HTraceConfiguration

get() - Method in class org.apache.htrace.core.TracerId

getAccumulatedMillis() - Method in class org.apache.htrace.core.MilliSpan

getAccumulatedMillis() - Method in interface org.apache.htrace.core.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.apache.htrace.core.HTraceConfiguration

getCurrentSpan() - Static method in class org.apache.htrace.core.Tracer

getCurrentSpanId() - Static method in class org.apache.htrace.core.Tracer

getDescription() - Method in class org.apache.htrace.core.MilliSpan

getDescription() - Method in interface org.apache.htrace.core.Span

Return a textual description of this span.

Will never be null.

getGlobalTracerPool() - Static method in class org.apache.htrace.core.TracerPool

Get the global tracer pool.

getHigh() - Method in class org.apache.htrace.core.SpanId

getId() - Method in class org.apache.htrace.core.SpanReceiver

Get an ID uniquely identifying this SpanReceiver.

getImpl() - Method in class org.apache.htrace.core.TraceCallable

getInt(String, int) - Method in class org.apache.htrace.core.HTraceConfiguration

getKVAnnotations() - Method in class org.apache.htrace.core.MilliSpan

getKVAnnotations() - Method in interface org.apache.htrace.core.Span

Get data associated with this span (read only)

Will never be null.

getLow() - Method in class org.apache.htrace.core.SpanId

getMessage() - Method in class org.apache.htrace.core.TimelineAnnotation

getName() - Method in class org.apache.htrace.core.TracerPool

Return the name of this TracerPool.

getParents() - Method in class org.apache.htrace.core.MilliSpan

getParents() - Method in interface org.apache.htrace.core.Span

Returns the parent IDs of the span.

The array will be empty if there are no parents.

getReceivers() - Method in class org.apache.htrace.core.TracerPool

Returns an array of all the current span receivers.

getRunnable() - Method in class org.apache.htrace.core.TraceRunnable

getSamplers() - Method in class org.apache.htrace.core.Tracer

Returns an array of all the current Samplers.

getSpan() - Method in class org.apache.htrace.core.TraceScope

Returns the span which this scope is managing.

getSpanId() - Method in class org.apache.htrace.core.MilliSpan

getSpanId() - Method in interface org.apache.htrace.core.Span

A pseudo-unique (random) number assigned to this span instance.

The spanId is immutable and cannot be changed.

getSpanId() - Method in class org.apache.htrace.core.TraceScope

Returns the span ID which this scope is managing.

getSpans() - Method in class org.apache.htrace.core.POJOSpanReceiver

getStartTimeMillis() - Method in class org.apache.htrace.core.MilliSpan

getStartTimeMillis() - Method in interface org.apache.htrace.core.Span

Get the start time, in milliseconds

getStopTimeMillis() - Method in class org.apache.htrace.core.MilliSpan

getStopTimeMillis() - Method in interface org.apache.htrace.core.Span

Get the stop time, in milliseconds

getTime() - Method in class org.apache.htrace.core.TimelineAnnotation

getTimelineAnnotations() - Method in class org.apache.htrace.core.MilliSpan

getTimelineAnnotations() - Method in interface org.apache.htrace.core.Span

Get any timeline annotations (read only)

Will never be null.

getTracerId() - Method in class org.apache.htrace.core.MilliSpan

getTracerId() - Method in interface org.apache.htrace.core.Span

Return a unique id for the process from which this Span originated.

Will never be null.

getTracerId() - Method in class org.apache.htrace.core.Tracer

getTracerPool() - Method in class org.apache.htrace.core.Tracer

getTracers() - Method in class org.apache.htrace.core.TracerPool

Returns an array of all the current Tracers.

getUniqueLocalTraceFileName() - Static method in class org.apache.htrace.core.LocalFileSpanReceiver

H

hashCode() - Method in class org.apache.htrace.core.SpanId

hashCode() - Method in class org.apache.htrace.core.Tracer

Get the hash code of a Tracer object.

HTraceConfiguration - Class in org.apache.htrace.core

Wrapper which integrating applications should implement in order to provide tracing configuration.

HTraceConfiguration() - Constructor for class org.apache.htrace.core.HTraceConfiguration

I

INSTANCE - Static variable in class org.apache.htrace.core.AlwaysSampler

INSTANCE - Static variable in class org.apache.htrace.core.NeverSampler

INVALID - Static variable in class org.apache.htrace.core.SpanId

The invalid span ID, which is all zeroes.

invokeAll(Collection<? extends Callable<T>>) - Method in class org.apache.htrace.core.TraceExecutorService

invokeAll(Collection<? extends Callable<T>>, long, TimeUnit) - Method in class org.apache.htrace.core.TraceExecutorService

invokeAny(Collection<? extends Callable<T>>) - Method in class org.apache.htrace.core.TraceExecutorService

invokeAny(Collection<? extends Callable<T>>, long, TimeUnit) - Method in class org.apache.htrace.core.TraceExecutorService

isRunning() - Method in class org.apache.htrace.core.MilliSpan

isRunning() - Method in interface org.apache.htrace.core.Span

Has the span been started and not yet stopped?

isShutdown() - Method in class org.apache.htrace.core.TraceExecutorService

isTerminated() - Method in class org.apache.htrace.core.TraceExecutorService

isValid() - Method in class org.apache.htrace.core.SpanId

L

loadReceiverType(String, HTraceConfiguration, ClassLoader) - Method in class org.apache.htrace.core.TracerPool

Given a SpanReceiver class name, return the existing instance of that span receiver, if possible; otherwise, invoke the callable to create a new instance.

LocalFileSpanReceiver - Class in org.apache.htrace.core

Writes the spans it receives to a local file.

LocalFileSpanReceiver(HTraceConfiguration) - Constructor for class org.apache.htrace.core.LocalFileSpanReceiver

logErrors(boolean) - Method in class org.apache.htrace.core.SpanReceiver.Builder

Configure whether we should log errors during build().

M

MilliSpan - Class in org.apache.htrace.core

A Span implementation that stores its information in milliseconds since the epoch.

MilliSpan() - Constructor for class org.apache.htrace.core.MilliSpan

MilliSpan.Builder - Class in org.apache.htrace.core

The public interface for constructing a MilliSpan.

MilliSpan.Builder() - Constructor for class org.apache.htrace.core.MilliSpan.Builder

MilliSpan.MilliSpanDeserializer - Class in org.apache.htrace.core

MilliSpan.MilliSpanDeserializer() - Constructor for class org.apache.htrace.core.MilliSpan.MilliSpanDeserializer

N

name(String) - Method in class org.apache.htrace.core.Tracer.Builder

Deprecated.

Since 4.0.0. Use Constructor that takes a name argument instead.

NEVER - Static variable in class org.apache.htrace.core.Sampler

NeverSampler - Class in org.apache.htrace.core

A Sampler that never returns true.

NeverSampler(HTraceConfiguration) - Constructor for class org.apache.htrace.core.NeverSampler

newChildId() - Method in class org.apache.htrace.core.SpanId

newNullScope() - Method in class org.apache.htrace.core.Tracer

Return a null trace scope.

newScope(String, SpanId) - Method in class org.apache.htrace.core.Tracer

Create a new trace scope.

newScope(String) - Method in class org.apache.htrace.core.Tracer

Create a new trace scope.

newTraceExecutorService(ExecutorService, String) - Method in class org.apache.htrace.core.Tracer

next() - Method in class org.apache.htrace.core.AlwaysSampler

next() - Method in class org.apache.htrace.core.CountSampler

next() - Method in class org.apache.htrace.core.NeverSampler

next() - Method in class org.apache.htrace.core.ProbabilitySampler

next() - Method in class org.apache.htrace.core.Sampler

O

org.apache.htrace.core - package org.apache.htrace.core

P

parents(SpanId[]) - Method in class org.apache.htrace.core.MilliSpan.Builder

parents(List<SpanId>) - Method in class org.apache.htrace.core.MilliSpan.Builder

PATH_KEY - Static variable in class org.apache.htrace.core.LocalFileSpanReceiver

POJOSpanReceiver - Class in org.apache.htrace.core

SpanReceiver for testing only that just collects the Span objects it receives.

POJOSpanReceiver(HTraceConfiguration) - Constructor for class org.apache.htrace.core.POJOSpanReceiver

ProbabilitySampler - Class in org.apache.htrace.core

Sampler that returns true a certain percentage of the time.

ProbabilitySampler(HTraceConfiguration) - Constructor for class org.apache.htrace.core.ProbabilitySampler

R

reattach() - Method in class org.apache.htrace.core.TraceScope

Attach this TraceScope to the current thread.

receiveSpan(Span) - Method in class org.apache.htrace.core.LocalFileSpanReceiver

receiveSpan(Span) - Method in class org.apache.htrace.core.POJOSpanReceiver

receiveSpan(Span) - Method in class org.apache.htrace.core.SpanReceiver

Called when a Span is stopped and can now be stored.

receiveSpan(Span) - Method in class org.apache.htrace.core.StandardOutSpanReceiver

removeAndCloseReceiver(SpanReceiver) - Method in class org.apache.htrace.core.TracerPool

Remove and close a span receiver.

removeReceiver(SpanReceiver) - Method in class org.apache.htrace.core.TracerPool

Remove a span receiver.

removeSampler(Sampler) - Method in class org.apache.htrace.core.Tracer

Remove a SpanReceiver.

reset() - Method in class org.apache.htrace.core.Sampler.Builder

reset() - Method in class org.apache.htrace.core.SpanReceiver.Builder

Set this builder back to defaults.

run() - Method in class org.apache.htrace.core.TraceRunnable

S

Sampler - Class in org.apache.htrace.core

Extremely simple callback to determine the frequency that an action should be performed.

Sampler() - Constructor for class org.apache.htrace.core.Sampler

Sampler.Builder - Class in org.apache.htrace.core

A Sampler builder.

Sampler.Builder(HTraceConfiguration) - Constructor for class org.apache.htrace.core.Sampler.Builder

SAMPLER_CLASSES_KEY - Static variable in class org.apache.htrace.core.Tracer

SAMPLER_FRACTION_CONF_KEY - Static variable in class org.apache.htrace.core.ProbabilitySampler

SAMPLER_FREQUENCY_CONF_KEY - Static variable in class org.apache.htrace.core.CountSampler

serialize(Span, JsonGenerator, SerializerProvider) - Method in class org.apache.htrace.core.Span.SpanSerializer

setParents(SpanId[]) - Method in class org.apache.htrace.core.MilliSpan

setParents(SpanId[]) - Method in interface org.apache.htrace.core.Span

Set the parents of this span.

Any existing parents will be cleared by this call.

setTracerId(String) - Method in class org.apache.htrace.core.MilliSpan

setTracerId(String) - Method in interface org.apache.htrace.core.Span

Set the process id of a span.

shutdown() - Method in class org.apache.htrace.core.TraceExecutorService

shutdownNow() - Method in class org.apache.htrace.core.TraceExecutorService

Span - Interface in org.apache.htrace.core

Base interface for gathering and reporting statistics about a block of execution.

Span.SpanSerializer - Class in org.apache.htrace.core

Span.SpanSerializer() - Constructor for class org.apache.htrace.core.Span.SpanSerializer

SPAN_RECEIVER_CLASSES_KEY - Static variable in class org.apache.htrace.core.Tracer

spanId(SpanId) - Method in class org.apache.htrace.core.MilliSpan.Builder

SpanId - Class in org.apache.htrace.core

Uniquely identifies an HTrace span.

SpanId(long, long) - Constructor for class org.apache.htrace.core.SpanId

SpanReceiver - Class in org.apache.htrace.core

The collector within a process that is the destination of Spans when a trace is running.

SpanReceiver() - Constructor for class org.apache.htrace.core.SpanReceiver

SpanReceiver.Builder - Class in org.apache.htrace.core

A SpanReceiver builder.

SpanReceiver.Builder(HTraceConfiguration) - Constructor for class org.apache.htrace.core.SpanReceiver.Builder

StandardOutSpanReceiver - Class in org.apache.htrace.core

Used for testing.

StandardOutSpanReceiver(HTraceConfiguration) - Constructor for class org.apache.htrace.core.StandardOutSpanReceiver

stop() - Method in class org.apache.htrace.core.MilliSpan

stop() - Method in interface org.apache.htrace.core.Span

The block has completed, stop the clock

submit(Callable<T>) - Method in class org.apache.htrace.core.TraceExecutorService

submit(Runnable, T) - Method in class org.apache.htrace.core.TraceExecutorService

submit(Runnable) - Method in class org.apache.htrace.core.TraceExecutorService

T

threshold - Variable in class org.apache.htrace.core.ProbabilitySampler

timeline(List<TimelineAnnotation>) - Method in class org.apache.htrace.core.MilliSpan.Builder

TimelineAnnotation - Class in org.apache.htrace.core

TimelineAnnotation(long, String) - Constructor for class org.apache.htrace.core.TimelineAnnotation

toJson() - Method in class org.apache.htrace.core.MilliSpan

toJson() - Method in interface org.apache.htrace.core.Span

Serialize to Json

toString() - Method in class org.apache.htrace.core.MilliSpan

toString() - Method in interface org.apache.htrace.core.Span

toString() - Method in class org.apache.htrace.core.SpanId

toString() - Method in class org.apache.htrace.core.TimelineAnnotation

toString() - Method in class org.apache.htrace.core.Tracer

toString() - Method in class org.apache.htrace.core.TracerPool

toString() - Method in class org.apache.htrace.core.TraceScope

TraceCallable<V> - Class in org.apache.htrace.core

Wrap a Callable with a Span that survives a change in threads.

TraceExecutorService - Class in org.apache.htrace.core

traceInfo(Map<String, String>) - Method in class org.apache.htrace.core.MilliSpan.Builder

Tracer - Class in org.apache.htrace.core

Use a Tracer instance inside a 'process' to collect and distribute its trace Spans.

Tracer.Builder - Class in org.apache.htrace.core

Tracer.Builder() - Constructor for class org.apache.htrace.core.Tracer.Builder

Deprecated.

Since 4.0.0. Use Constructor that takes a name argument instead

Tracer.Builder(String) - Constructor for class org.apache.htrace.core.Tracer.Builder

TRACER_ID_KEY - Static variable in class org.apache.htrace.core.TracerId

The configuration key to use for process id

tracerId(String) - Method in class org.apache.htrace.core.MilliSpan.Builder

TracerId - Class in org.apache.htrace.core

The HTrace tracer ID.

HTrace tracer IDs are created from format strings.

TracerId(HTraceConfiguration, String) - Constructor for class org.apache.htrace.core.TracerId

tracerPool(TracerPool) - Method in class org.apache.htrace.core.Tracer.Builder

TracerPool - Class in org.apache.htrace.core

A pool of Tracer objects.

TracerPool(String) - Constructor for class org.apache.htrace.core.TracerPool

TraceRunnable - Class in org.apache.htrace.core

Wrap a Runnable with a Span that survives a change in threads.

TraceRunnable(Tracer, TraceScope, Runnable, String) - Constructor for class org.apache.htrace.core.TraceRunnable

TraceScope - Class in org.apache.htrace.core

Create a new TraceScope at major transitions.

W

wrap(Callable<V>, String) - Method in class org.apache.htrace.core.Tracer

Wrap the callable in a TraceCallable, if tracing.

wrap(Runnable, String) - Method in class org.apache.htrace.core.Tracer

Wrap the runnable in a TraceRunnable, if tracing

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