software.amazon.lambda.powertools.logging

Class LoggingUtils

java.lang.Object

software.amazon.lambda.powertools.logging.LoggingUtils

public final class LoggingUtils
extends java.lang.Object

A class of helper functions to add additional functionality to Logging. Logging

Method Summary

Modifier and Type	Method and Description
static void	appendKey(java.lang.String key, java.lang.String value) Appends an additional key and value to each log entry made.
static void	appendKeys(java.util.Map<java.lang.String,java.lang.String> customKeys) Appends additional key and value to each log entry made.
static void	defaultObjectMapper(com.fasterxml.jackson.databind.ObjectMapper objectMapper) Sets the instance of ObjectMapper object which is used for serialising event when @Logging(logEvent = true).
static com.fasterxml.jackson.databind.ObjectMapper	objectMapper()
static void	removeKey(java.lang.String customKey) Remove an additional key from log entry.
static void	removeKeys(java.lang.String... keys) Removes additional keys from log entry.
static void	setCorrelationId(java.lang.String value) Sets correlation id attribute on the logs.

Methods inherited from class java.lang.Object

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

Method Detail

appendKey

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

Appends an additional key and value to each log entry made. Duplicate values for the same key will be replaced with the latest.

Parameters:

key - The name of the key to be logged

value - The value to be logged

appendKeys

public static void appendKeys(java.util.Map<java.lang.String,java.lang.String> customKeys)

Appends additional key and value to each log entry made. Duplicate values for the same key will be replaced with the latest.

Parameters:

customKeys - Map of custom keys values to be appended to logs

removeKey

public static void removeKey(java.lang.String customKey)

Remove an additional key from log entry.

Parameters:

customKey - The name of the key to be logged

removeKeys

public static void removeKeys(java.lang.String... keys)

Removes additional keys from log entry.

Parameters:

keys - Map of custom keys values to be appended to logs

setCorrelationId

public static void setCorrelationId(java.lang.String value)

Sets correlation id attribute on the logs.

Parameters:

value - The value of the correlation id

defaultObjectMapper

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

Sets the instance of ObjectMapper object which is used for serialising event when @Logging(logEvent = true).

Parameters:

objectMapper - Custom implementation of object mapper to be used for logging serialised event

objectMapper

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