Package com.amazonaws.xray

Class AWSXRay

java.lang.Object
com.amazonaws.xray.AWSXRay
public class AWSXRay extends Object
Static helper class which holds reference to a global client and provides a static interface for invoking methods on the client.

  • Constructor Details

    • AWSXRay

      public AWSXRay()

  • Method Details

    • 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(String name, Function<Segment,@Nullable R> function)

    • createSegment

      public static void createSegment(String name, Consumer<Segment> consumer)

    • createSegment

      public static <R> @Nullable R createSegment(String name, Supplier<R> supplier)

    • createSegment

      public static void createSegment(String name, Runnable runnable)

    • createSubsegment

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

    • createSubsegment

      public static void createSubsegment(String name, Consumer<Subsegment> consumer)

    • createSubsegment

      public static <R> @Nullable R createSubsegment(String name, Supplier<R> supplier)

    • createSubsegment

      public static void createSubsegment(String name, Runnable runnable)

    • beginSegmentWithSampling

      public static Segment beginSegmentWithSampling(String name)

    • beginSegment

      public static Segment beginSegment(String name)

    • beginSegment

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

    • beginDummySegment

      @Deprecated public static Segment beginDummySegment()
      Deprecated.
      Use AWSXRay.getGlobalRecorder().beginNoOpSegment() .

    • endSegment

      public static void endSegment()

    • beginSubsegment

      public static Subsegment beginSubsegment(String name)

    • beginSubsegmentWithoutSampling

      public static Subsegment beginSubsegmentWithoutSampling(String name)

    • endSubsegment

      public static void endSubsegment()

    • endSubsegment

      public static void endSubsegment(@Nullable Subsegment subsegment)

    • currentEntityId

      public @Nullable String currentEntityId()

    • currentTraceId

      public @Nullable TraceID currentTraceId()

    • currentFormattedId

      public static @Nullable String currentFormattedId()

    • getCurrentSegment

      public static @Nullable Segment getCurrentSegment()

    • getCurrentSegmentOptional

      public static Optional<Segment> getCurrentSegmentOptional()

    • getCurrentSubsegment

      public static @Nullable Subsegment getCurrentSubsegment()

    • getCurrentSubsegmentOptional

      public static 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)