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.ThrowingCallable<R,T extends Throwable> A Callable that may also throw.
static interface	TraceUtil.ThrowingRunnable<T extends Throwable> A Runnable that may also throw.

Constructor Summary

Constructors

Modifier	Constructor and Description
private	TraceUtil()

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.
private static io.opentelemetry.api.trace.Span	createSpan(String name, io.opentelemetry.api.trace.SpanKind kind) Create a span with the given kind.
private static void	endSpan(CompletableFuture<?> future, io.opentelemetry.api.trace.Span span) Finish the span when the given future is completed.
static io.opentelemetry.api.trace.Tracer	getGlobalTracer()
static void	setError(io.opentelemetry.api.trace.Span span, Throwable error)
static <R,T extends Throwable> R	trace(TraceUtil.ThrowingCallable<R,T> callable, String spanName)
static <R,T extends Throwable> R	trace(TraceUtil.ThrowingCallable<R,T> callable, Supplier<io.opentelemetry.api.trace.Span> spanSupplier)
static <T extends Throwable> void	trace(TraceUtil.ThrowingRunnable<T> runnable, String spanName) Trace the execution of runnable.
static <T extends Throwable> void	trace(TraceUtil.ThrowingRunnable<T> runnable, Supplier<io.opentelemetry.api.trace.Span> spanSupplier) Trace the execution of runnable.
static <T> CompletableFuture<T>	tracedFuture(Supplier<CompletableFuture<T>> action, String spanName) Trace an asynchronous operation.
static <T> CompletableFuture<T>	tracedFuture(Supplier<CompletableFuture<T>> action, Supplier<io.opentelemetry.api.trace.Span> spanSupplier) Trace an asynchronous operation for a table.
static <T> List<CompletableFuture<T>>	tracedFutures(Supplier<List<CompletableFuture<T>>> action, Supplier<io.opentelemetry.api.trace.Span> spanSupplier) Trace an asynchronous operation, and finish the create Span when all the given futures are completed.
static Runnable	tracedRunnable(Runnable runnable, String spanName) Wrap the provided runnable in a Runnable that is traced.
static Runnable	tracedRunnable(Runnable runnable, Supplier<io.opentelemetry.api.trace.Span> spanSupplier) Wrap the provided runnable in a Runnable that is traced.

Methods inherited from class java.lang.Object

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

Constructor Detail

TraceUtil

private TraceUtil()

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.

createSpan

private static io.opentelemetry.api.trace.Span createSpan(String name,
                                                          io.opentelemetry.api.trace.SpanKind kind)

Create a span with the given kind. Notice that, OpenTelemetry only expects one SpanKind.CLIENT span and one SpanKind.SERVER span for a traced request, so use this with caution when you want to create spans with kind other than SpanKind.INTERNAL.

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,
                                                    Supplier<io.opentelemetry.api.trace.Span> spanSupplier)

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,
                                                           Supplier<io.opentelemetry.api.trace.Span> spanSupplier)

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)

endSpan

private static void endSpan(CompletableFuture<?> future,
                            io.opentelemetry.api.trace.Span span)

Finish the span when the given future is completed.

tracedRunnable

public static Runnable tracedRunnable(Runnable runnable,
                                      String spanName)

Wrap the provided runnable in a Runnable that is traced.

tracedRunnable

public static Runnable tracedRunnable(Runnable runnable,
                                      Supplier<io.opentelemetry.api.trace.Span> spanSupplier)

Wrap the provided runnable in a Runnable that is traced.

trace

public static <T extends Throwable> void trace(TraceUtil.ThrowingRunnable<T> runnable,
                                               String spanName)
                                        throws T extends Throwable

Trace the execution of runnable.

Throws:

T extends Throwable

trace

public static <T extends Throwable> void trace(TraceUtil.ThrowingRunnable<T> runnable,
                                               Supplier<io.opentelemetry.api.trace.Span> spanSupplier)
                                        throws T extends Throwable

Trace the execution of runnable.

Throws:

T extends Throwable

trace

public static <R,T extends Throwable> R trace(TraceUtil.ThrowingCallable<R,T> callable,
                                              String spanName)
                                       throws T extends Throwable

Throws:

T extends Throwable

trace

public static <R,T extends Throwable> R trace(TraceUtil.ThrowingCallable<R,T> callable,
                                              Supplier<io.opentelemetry.api.trace.Span> spanSupplier)
                                       throws T extends Throwable

Throws:

T extends Throwable