software.amazon.lambda.powertools.tracing

Class TracingUtils

java.lang.Object

software.amazon.lambda.powertools.tracing.TracingUtils

public final class TracingUtils
extends java.lang.Object

A class of helper functions to add additional functionality and ease of use.

Constructor Summary

Constructors

Constructor and Description
TracingUtils()

Method Summary

Modifier and Type	Method and Description
static void	defaultObjectMapper(com.fasterxml.jackson.databind.ObjectMapper objectMapper) Sets the instance of ObjectMapper object which is used for serialising object response when @Tracing(captureMode=CaptureMode.RESPONSE).
static com.fasterxml.jackson.databind.ObjectMapper	objectMapper()
static void	putAnnotation(java.lang.String key, java.lang.Boolean value) Put an annotation to the current subsegment with a Boolean value.
static void	putAnnotation(java.lang.String key, java.lang.Number value) Put an annotation to the current subsegment with a Number value.
static void	putAnnotation(java.lang.String key, java.lang.String value) Put an annotation to the current subsegment with a String value.
static void	putMetadata(java.lang.String key, java.lang.Object value) Put additional metadata for the current subsegment.
static void	putMetadata(java.lang.String namespace, java.lang.String key, java.lang.Object value) Put additional metadata for the current subsegment.
static void	withEntitySubsegment(java.lang.String name, com.amazonaws.xray.entities.Entity entity, java.util.function.Consumer<com.amazonaws.xray.entities.Subsegment> subsegment) Adds a new subsegment around the passed consumer.
static void	withEntitySubsegment(java.lang.String namespace, java.lang.String name, com.amazonaws.xray.entities.Entity entity, java.util.function.Consumer<com.amazonaws.xray.entities.Subsegment> subsegment) Adds a new subsegment around the passed consumer.
static void	withSubsegment(java.lang.String name, java.util.function.Consumer<com.amazonaws.xray.entities.Subsegment> subsegment) Adds a new subsegment around the passed consumer.
static void	withSubsegment(java.lang.String namespace, java.lang.String name, java.util.function.Consumer<com.amazonaws.xray.entities.Subsegment> subsegment) Adds a new subsegment around the passed consumer.

Methods inherited from class java.lang.Object

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

Constructor Detail

TracingUtils

public TracingUtils()

Method Detail

putAnnotation

public static void putAnnotation(java.lang.String key,
                                 java.lang.String value)

Put an annotation to the current subsegment with a String value.

Parameters:

key - the key of the annotation

value - the value of the annotation

putAnnotation

public static void putAnnotation(java.lang.String key,
                                 java.lang.Number value)

Put an annotation to the current subsegment with a Number value.

Parameters:

key - the key of the annotation

value - the value of the annotation

putAnnotation

public static void putAnnotation(java.lang.String key,
                                 java.lang.Boolean value)

Put an annotation to the current subsegment with a Boolean value.

Parameters:

key - the key of the annotation

value - the value of the annotation

putMetadata

public static void putMetadata(java.lang.String key,
                               java.lang.Object value)

Put additional metadata for the current subsegment.

The namespace used will be the namespace of the current subsegment if it is set else it will follow the namespace process as described in Tracing

Parameters:

key - the key of the metadata

value - the value of the metadata

putMetadata

public static void putMetadata(java.lang.String namespace,
                               java.lang.String key,
                               java.lang.Object value)

Put additional metadata for the current subsegment.

Parameters:

namespace - the namespace of the metadata

key - the key of the metadata

value - the value of the metadata

withEntitySubsegment

public static void withEntitySubsegment(java.lang.String name,
                                        com.amazonaws.xray.entities.Entity entity,
                                        java.util.function.Consumer<com.amazonaws.xray.entities.Subsegment> subsegment)

Adds a new subsegment around the passed consumer. This also provides access to the newly created subsegment.

The namespace used follows the flow as described in Tracing

This method is intended for use with multi-threaded programming where the context is lost between threads.

Parameters:

name - the name of the subsegment

entity - the current x-ray context

subsegment - the x-ray subsegment for the wrapped consumer

withEntitySubsegment

public static void withEntitySubsegment(java.lang.String namespace,
                                        java.lang.String name,
                                        com.amazonaws.xray.entities.Entity entity,
                                        java.util.function.Consumer<com.amazonaws.xray.entities.Subsegment> subsegment)

Adds a new subsegment around the passed consumer. This also provides access to the newly created subsegment.

This method is intended for use with multi-threaded programming where the context is lost between threads.

Parameters:

namespace - the namespace of the subsegment

name - the name of the subsegment

entity - the current x-ray context

subsegment - the x-ray subsegment for the wrapped consumer

withSubsegment

public static void withSubsegment(java.lang.String name,
                                  java.util.function.Consumer<com.amazonaws.xray.entities.Subsegment> subsegment)

Adds a new subsegment around the passed consumer. This also provides access to the newly created subsegment.

The namespace used follows the flow as described in Tracing

Parameters:

name - the name of the subsegment

subsegment - the x-ray subsegment for the wrapped consumer

withSubsegment

public static void withSubsegment(java.lang.String namespace,
                                  java.lang.String name,
                                  java.util.function.Consumer<com.amazonaws.xray.entities.Subsegment> subsegment)

Adds a new subsegment around the passed consumer. This also provides access to the newly created subsegment.

Parameters:

namespace - the namespace for the subsegment

name - the name of the subsegment

subsegment - the x-ray subsegment for the wrapped consumer

defaultObjectMapper

public static void defaultObjectMapper(com.fasterxml.jackson.databind.ObjectMapper objectMapper)

Sets the instance of ObjectMapper object which is used for serialising object response when @Tracing(captureMode=CaptureMode.RESPONSE).

Parameters:

objectMapper - Custom implementation of object mapper to be used for serializing response

objectMapper

public static com.fasterxml.jackson.databind.ObjectMapper objectMapper()