org.apache.hadoop.hbase.trace

Class TraceUtil

java.lang.Object

org.apache.hadoop.hbase.trace.TraceUtil

@InterfaceAudience.Private
public final class TraceUtil
extends Object

This wrapper class provides functions for accessing htrace 4+ functionality in a simplified way.

Field Summary

Fields

Modifier and Type	Field and Description
private static org.apache.htrace.core.HTraceConfiguration	conf
private static org.apache.htrace.core.Tracer	tracer

Constructor Summary

Constructors

Modifier	Constructor and Description
private	TraceUtil()

Method Summary

Modifier and Type	Method and Description
static void	addKVAnnotation(String key, String value) Wrapper method to add key-value pair to TraceInfo of actual span
static boolean	addReceiver(org.apache.htrace.core.SpanReceiver rcvr) Wrapper method to add receiver to actual tracerpool
static boolean	addSampler(org.apache.htrace.core.Sampler sampler) Wrapper method to add new sampler to the default tracer
static void	addTimelineAnnotation(String msg) Wrapper method to add timeline annotiation to current span with given message
static org.apache.htrace.core.TraceScope	createTrace(String description) Wrapper method to create new TraceScope with the given description
static org.apache.htrace.core.TraceScope	createTrace(String description, org.apache.htrace.core.Span span) Wrapper method to create new child TraceScope with the given description and parent scope's spanId
static void	initTracer(org.apache.hadoop.conf.Configuration c)
static boolean	removeReceiver(org.apache.htrace.core.SpanReceiver rcvr) Wrapper method to remove receiver from actual tracerpool
static Runnable	wrap(Runnable runnable, String description) Wrap runnable with current tracer and description

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

conf

private static org.apache.htrace.core.HTraceConfiguration conf

tracer

private static org.apache.htrace.core.Tracer tracer

Constructor Detail

TraceUtil

private TraceUtil()

Method Detail

initTracer

public static void initTracer(org.apache.hadoop.conf.Configuration c)

createTrace

public static org.apache.htrace.core.TraceScope createTrace(String description)

Wrapper method to create new TraceScope with the given description

Returns:

TraceScope or null when not tracing

createTrace

public static org.apache.htrace.core.TraceScope createTrace(String description,
                                                            org.apache.htrace.core.Span span)

Wrapper method to create new child TraceScope with the given description and parent scope's spanId

Parameters:

span - parent span

Returns:

TraceScope or null when not tracing

addSampler

public static boolean addSampler(org.apache.htrace.core.Sampler sampler)

Wrapper method to add new sampler to the default tracer

Returns:

true if added, false if it was already added

addKVAnnotation

public static void addKVAnnotation(String key,
                                   String value)

Wrapper method to add key-value pair to TraceInfo of actual span

addReceiver

public static boolean addReceiver(org.apache.htrace.core.SpanReceiver rcvr)

Wrapper method to add receiver to actual tracerpool

Returns:

true if successfull, false if it was already added

removeReceiver

public static boolean removeReceiver(org.apache.htrace.core.SpanReceiver rcvr)

Wrapper method to remove receiver from actual tracerpool

Returns:

true if removed, false if doesn't exist

addTimelineAnnotation

public static void addTimelineAnnotation(String msg)

Wrapper method to add timeline annotiation to current span with given message

wrap

public static Runnable wrap(Runnable runnable,
                            String description)

Wrap runnable with current tracer and description

Parameters:

runnable - to wrap

Returns:

wrapped runnable or original runnable when not tracing