org.apache.hadoop.hbase.trace

Class TraceUtil

java.lang.Object

org.apache.hadoop.hbase.trace.TraceUtil

@InterfaceAudience.Private
public final class TraceUtil
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	TraceUtil.IOExceptionCallable<V>

Field Summary

Fields

Modifier and Type	Field and Description
static io.opentelemetry.api.common.AttributeKey<String>	NAMESPACE_KEY
static io.opentelemetry.api.common.AttributeKey<List<String>>	REGION_NAMES_KEY
static io.opentelemetry.api.common.AttributeKey<String>	REMOTE_HOST_KEY
static io.opentelemetry.api.common.AttributeKey<Long>	REMOTE_PORT_KEY
static io.opentelemetry.api.common.AttributeKey<Boolean>	ROW_LOCK_READ_LOCK_KEY
static io.opentelemetry.api.common.AttributeKey<String>	RPC_METHOD_KEY
static io.opentelemetry.api.common.AttributeKey<String>	RPC_SERVICE_KEY
static io.opentelemetry.api.common.AttributeKey<String>	SERVER_NAME_KEY
static io.opentelemetry.api.common.AttributeKey<String>	TABLE_KEY
static io.opentelemetry.api.common.AttributeKey<String>	WAL_IMPL

Method Summary

Modifier and Type	Method and Description
static io.opentelemetry.api.trace.Span	createClientSpan(String name) Create a span with SpanKind.CLIENT.
static io.opentelemetry.api.trace.Span	createRemoteSpan(String name, io.opentelemetry.context.Context ctx) Create a span which parent is from remote, i.e, passed through rpc.
static io.opentelemetry.api.trace.Span	createSpan(String name) Create a SpanKind.INTERNAL span.
static io.opentelemetry.api.trace.Span	createTableSpan(String spanName, TableName tableName) Create a SpanKind.INTERNAL span and set table related attributes.
static io.opentelemetry.api.trace.Tracer	getGlobalTracer()
static void	setError(io.opentelemetry.api.trace.Span span, Throwable error)
static void	trace(Runnable action, String spanName)
static void	trace(Runnable action, Supplier<io.opentelemetry.api.trace.Span> creator)
static <T> T	trace(Supplier<T> action, String spanName)
static <T> T	trace(TraceUtil.IOExceptionCallable<T> callable, String spanName)
static <T> T	trace(TraceUtil.IOExceptionCallable<T> callable, Supplier<io.opentelemetry.api.trace.Span> creator)
static <T> CompletableFuture<T>	tracedFuture(Supplier<CompletableFuture<T>> action, String spanName) Trace an asynchronous operation.
static <T> CompletableFuture<T>	tracedFuture(Supplier<CompletableFuture<T>> action, String spanName, TableName tableName) Trace an asynchronous operation for a table.
static <T> List<CompletableFuture<T>>	tracedFutures(Supplier<List<CompletableFuture<T>>> action, String spanName, TableName tableName) Trace an asynchronous operation, and finish the create Span when all the given futures are completed.

Methods inherited from class java.lang.Object

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

Field Detail

NAMESPACE_KEY

public static final io.opentelemetry.api.common.AttributeKey<String> NAMESPACE_KEY

TABLE_KEY

public static final io.opentelemetry.api.common.AttributeKey<String> TABLE_KEY

REGION_NAMES_KEY

public static final io.opentelemetry.api.common.AttributeKey<List<String>> REGION_NAMES_KEY

RPC_SERVICE_KEY

public static final io.opentelemetry.api.common.AttributeKey<String> RPC_SERVICE_KEY

RPC_METHOD_KEY

public static final io.opentelemetry.api.common.AttributeKey<String> RPC_METHOD_KEY

SERVER_NAME_KEY

public static final io.opentelemetry.api.common.AttributeKey<String> SERVER_NAME_KEY

REMOTE_HOST_KEY

public static final io.opentelemetry.api.common.AttributeKey<String> REMOTE_HOST_KEY

REMOTE_PORT_KEY

public static final io.opentelemetry.api.common.AttributeKey<Long> REMOTE_PORT_KEY

ROW_LOCK_READ_LOCK_KEY

public static final io.opentelemetry.api.common.AttributeKey<Boolean> ROW_LOCK_READ_LOCK_KEY

WAL_IMPL

public static final io.opentelemetry.api.common.AttributeKey<String> WAL_IMPL

Method Detail

getGlobalTracer

public static io.opentelemetry.api.trace.Tracer getGlobalTracer()

createSpan

public static io.opentelemetry.api.trace.Span createSpan(String name)

Create a SpanKind.INTERNAL span.

createTableSpan

public static io.opentelemetry.api.trace.Span createTableSpan(String spanName,
                                                              TableName tableName)

Create a SpanKind.INTERNAL span and set table related attributes.

createRemoteSpan

public static io.opentelemetry.api.trace.Span createRemoteSpan(String name,
                                                               io.opentelemetry.context.Context ctx)

Create a span which parent is from remote, i.e, passed through rpc.

We will set the kind of the returned span to SpanKind.SERVER, as this should be the top most span at server side.

createClientSpan

public static io.opentelemetry.api.trace.Span createClientSpan(String name)

Create a span with SpanKind.CLIENT.

tracedFuture

public static <T> CompletableFuture<T> tracedFuture(Supplier<CompletableFuture<T>> action,
                                                    String spanName,
                                                    TableName tableName)

Trace an asynchronous operation for a table.

tracedFuture

public static <T> CompletableFuture<T> tracedFuture(Supplier<CompletableFuture<T>> action,
                                                    String spanName)

Trace an asynchronous operation.

tracedFutures

public static <T> List<CompletableFuture<T>> tracedFutures(Supplier<List<CompletableFuture<T>>> action,
                                                           String spanName,
                                                           TableName tableName)

Trace an asynchronous operation, and finish the create Span when all the given futures are completed.

setError

public static void setError(io.opentelemetry.api.trace.Span span,
                            Throwable error)

trace

public static void trace(Runnable action,
                         String spanName)

trace

public static void trace(Runnable action,
                         Supplier<io.opentelemetry.api.trace.Span> creator)

trace

public static <T> T trace(Supplier<T> action,
                          String spanName)

trace

public static <T> T trace(TraceUtil.IOExceptionCallable<T> callable,
                          String spanName)
                   throws IOException

Throws:

IOException

trace

public static <T> T trace(TraceUtil.IOExceptionCallable<T> callable,
                          Supplier<io.opentelemetry.api.trace.Span> creator)
                   throws IOException

Throws:

IOException