Package com.amazonaws.xray

Class AWSXRay

java.lang.Object

com.amazonaws.xray.AWSXRay

public class AWSXRay
extends java.lang.Object

Static helper class which holds reference to a global client and provides a static interface for invoking methods on the client.

Constructor Summary

Constructors

Constructor	Description
AWSXRay()

Method Summary

Modifier and Type	Method	Description
static Segment	beginDummySegment()	Deprecated. Use AWSXRay.getGlobalRecorder().beginNoOpSegment() .
static Segment	beginSegment(java.lang.String name)
static Segment	beginSegment(java.lang.String name, TraceID traceId, java.lang.String parentId)
static Segment	beginSegmentWithSampling(java.lang.String name)
static Subsegment	beginSubsegment(java.lang.String name)
static Subsegment	beginSubsegmentWithoutSampling(java.lang.String name)
static void	clearThreadLocal()	Deprecated. use clearTraceEntity() instead
static void	clearTraceEntity()
static void	createSegment(java.lang.String name, java.lang.Runnable runnable)
static void	createSegment(java.lang.String name, java.util.function.Consumer<Segment> consumer)
static <R> @Nullable R	createSegment(java.lang.String name, java.util.function.Function<Segment,@Nullable R> function)
static <R> @Nullable R	createSegment(java.lang.String name, java.util.function.Supplier<R> supplier)
static void	createSubsegment(java.lang.String name, java.lang.Runnable runnable)
static void	createSubsegment(java.lang.String name, java.util.function.Consumer<Subsegment> consumer)
static <R> @Nullable R	createSubsegment(java.lang.String name, java.util.function.Function<Subsegment,@Nullable R> function)
static <R> @Nullable R	createSubsegment(java.lang.String name, java.util.function.Supplier<R> supplier)
@Nullable java.lang.String	currentEntityId()
static @Nullable java.lang.String	currentFormattedId()
@Nullable TraceID	currentTraceId()
static void	endSegment()
static void	endSubsegment()
static void	endSubsegment(@Nullable Subsegment subsegment)
static @Nullable Segment	getCurrentSegment()
static java.util.Optional<Segment>	getCurrentSegmentOptional()
static @Nullable Subsegment	getCurrentSubsegment()
static java.util.Optional<Subsegment>	getCurrentSubsegmentOptional()
static AWSXRayRecorder	getGlobalRecorder()	Gets the global AWSXRayRecorder.
static @Nullable Entity	getThreadLocal()	Deprecated. use getTraceEntity() instead
static @Nullable Entity	getTraceEntity()
static void	injectThreadLocal(Entity entity)	Deprecated. use setTraceEntity(Entity entity) instead
static boolean	sendSegment(Segment segment)
static boolean	sendSubegment(Subsegment subsegment)	Deprecated. use sendSubsegment(Subsegment) instead
static boolean	sendSubsegment(Subsegment subsegment)
static void	setGlobalRecorder(AWSXRayRecorder globalRecorder)	Sets the global AWSXRayRecorder.
static void	setTraceEntity(@Nullable Entity entity)	Deprecated. Use Entity.run(Runnable) or methods in SegmentContextExecutors instead of directly setting the trace entity so it can be restored correctly.

Methods inherited from class java.lang.Object

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

Constructor Detail

AWSXRay

public AWSXRay()

Method Detail

getGlobalRecorder

public static AWSXRayRecorder getGlobalRecorder()

Gets the global AWSXRayRecorder. This is initialized using AWSXRayRecorderBuilder.defaultRecorder(). See setGlobalRecorder(AWSXRayRecorder).

Returns:

the global AWSXRayRecorder

setGlobalRecorder

public static void setGlobalRecorder(AWSXRayRecorder globalRecorder)

Sets the global AWSXRayRecorder. See getGlobalRecorder().

Parameters:

globalRecorder - the instance of AWSXRayRecorder to set as global

createSegment

public static <R> @Nullable R createSegment(java.lang.String name,
                                            java.util.function.Function<Segment,@Nullable R> function)

createSegment

public static void createSegment(java.lang.String name,
                                 java.util.function.Consumer<Segment> consumer)

createSegment

public static <R> @Nullable R createSegment(java.lang.String name,
                                            java.util.function.Supplier<R> supplier)

createSegment

public static void createSegment(java.lang.String name,
                                 java.lang.Runnable runnable)

createSubsegment

public static <R> @Nullable R createSubsegment(java.lang.String name,
                                               java.util.function.Function<Subsegment,@Nullable R> function)

createSubsegment

public static void createSubsegment(java.lang.String name,
                                    java.util.function.Consumer<Subsegment> consumer)

createSubsegment

public static <R> @Nullable R createSubsegment(java.lang.String name,
                                               java.util.function.Supplier<R> supplier)

createSubsegment

public static void createSubsegment(java.lang.String name,
                                    java.lang.Runnable runnable)

beginSegmentWithSampling

public static Segment beginSegmentWithSampling(java.lang.String name)

beginSegment

public static Segment beginSegment(java.lang.String name)

beginSegment

public static Segment beginSegment(java.lang.String name,
                                   TraceID traceId,
                                   java.lang.String parentId)

beginDummySegment

@Deprecated
public static Segment beginDummySegment()

Deprecated.

Use AWSXRay.getGlobalRecorder().beginNoOpSegment() .

endSegment

public static void endSegment()

beginSubsegment

public static Subsegment beginSubsegment(java.lang.String name)

beginSubsegmentWithoutSampling

public static Subsegment beginSubsegmentWithoutSampling(java.lang.String name)

endSubsegment

public static void endSubsegment()

endSubsegment

public static void endSubsegment(@Nullable Subsegment subsegment)

currentEntityId

public @Nullable java.lang.String currentEntityId()

currentTraceId

public @Nullable TraceID currentTraceId()

currentFormattedId

public static @Nullable java.lang.String currentFormattedId()

getCurrentSegment

public static @Nullable Segment getCurrentSegment()

getCurrentSegmentOptional

public static java.util.Optional<Segment> getCurrentSegmentOptional()

getCurrentSubsegment

public static @Nullable Subsegment getCurrentSubsegment()

getCurrentSubsegmentOptional

public static java.util.Optional<Subsegment> getCurrentSubsegmentOptional()

injectThreadLocal

@Deprecated
public static void injectThreadLocal(Entity entity)

Deprecated.

use setTraceEntity(Entity entity) instead

getThreadLocal

@Deprecated
public static @Nullable Entity getThreadLocal()

Deprecated.

use getTraceEntity() instead

clearThreadLocal

@Deprecated
public static void clearThreadLocal()

Deprecated.

use clearTraceEntity() instead

setTraceEntity

@Deprecated
public static void setTraceEntity(@Nullable Entity entity)

Deprecated.

Use Entity.run(Runnable) or methods in SegmentContextExecutors instead of directly setting the trace entity so it can be restored correctly.

getTraceEntity

public static @Nullable Entity getTraceEntity()

clearTraceEntity

public static void clearTraceEntity()

sendSegment

public static boolean sendSegment(Segment segment)

sendSubegment

@Deprecated
public static boolean sendSubegment(Subsegment subsegment)

Deprecated.

use sendSubsegment(Subsegment) instead

sendSubsegment

public static boolean sendSubsegment(Subsegment subsegment)