software.amazon.lambda.powertools.tracing

Annotation Type Tracing

@Retention(value=RUNTIME)
 @Target(value=METHOD)
public @interface Tracing

Tracing is used to signal that the annotated method should be extended with the Powertools tracing functionality.

Tracing provides functionality to reduce the overhead of performing common tracing tasks.

Tracing should be used with the handleRequest method of a class which implements either com.amazonaws.services.lambda.runtime.RequestHandler or com.amazonaws.services.lambda.runtime.RequestStreamHandler.

By default Tracing will capture responses and add them to a sub segment named after the method.

To disable this functionality you can specify @Tracing( captureResponse = false)

By default Tracing will capture errors and add them to a sub segment named after the method.

To disable this functionality you can specify @Tracing( captureError = false)

e

All traces have a namespace set. If @Tracing( namespace = "ExampleService") is set this takes precedent over any value set in the environment variable POWER_TOOLS_SERVICE_NAME. If both are undefined then the value will default to service_undefined

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	captureError Deprecated. As of release 1.2.0, replaced by captureMode() in order to support different modes and support via environment variables
CaptureMode	captureMode
boolean	captureResponse Deprecated. As of release 1.2.0, replaced by captureMode() in order to support different modes and support via environment variables
java.lang.String	namespace
java.lang.String	segmentName

Element Detail

namespace

public abstract java.lang.String namespace

Default:

""

captureResponse

@Deprecated
public abstract boolean captureResponse

Deprecated. As of release 1.2.0, replaced by captureMode() in order to support different modes and support via environment variables

Default:

true

captureError

@Deprecated
public abstract boolean captureError

Deprecated. As of release 1.2.0, replaced by captureMode() in order to support different modes and support via environment variables

Default:

true

segmentName

public abstract java.lang.String segmentName

Default:

""

captureMode

public abstract CaptureMode captureMode

Default:

software.amazon.lambda.powertools.tracing.CaptureMode.ENVIRONMENT_VAR