Package org.springframework.boot.logging.structured

Class ContextPairs

java.lang.Object

org.springframework.boot.logging.structured.ContextPairs

public class ContextPairs
extends Object

Helper that can be used to add JSON pairs from context data (typically the logger MDC) in the correct location (or drop them altogether).

Since:

3.5.0

Author:

Phillip Webb

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	ContextPairs.Pairs<T>	Callback used to add pairs.

Method Summary

Modifier and Type	Method	Description
<T> BiConsumer<T,BiConsumer<String,Object>>	flat(String delimeter, Consumer<ContextPairs.Pairs<T>> pairs)	Add pairs using flat naming.
<T> BiConsumer<T,BiConsumer<String,Object>>	flat(BinaryOperator<String> joiner, Consumer<ContextPairs.Pairs<T>> pairs)	Add pairs using flat naming.
<T> BiConsumer<T,BiConsumer<String,Object>>	nested(Consumer<ContextPairs.Pairs<T>> pairs)	Add pairs using nested naming (for example as used in ECS).

Methods inherited from class java.lang.Object

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

Method Details

flat

public <T> BiConsumer<T,BiConsumer<String,Object>> flat(String delimeter,
 Consumer<ContextPairs.Pairs<T>> pairs)

Add pairs using flat naming.

Type Parameters:

T - the item type

Parameters:

delimeter - the delimiter used if there is a prefix

pairs - callback to add all the pairs

Returns:

a BiConsumer for use with the JsonWriter

flat

public <T> BiConsumer<T,BiConsumer<String,Object>> flat(BinaryOperator<String> joiner,
 Consumer<ContextPairs.Pairs<T>> pairs)

Add pairs using flat naming.

Type Parameters:

T - the item type

Parameters:

joiner - the function used to join the prefix and name

pairs - callback to add all the pairs

Returns:

a BiConsumer for use with the JsonWriter

nested

public <T> BiConsumer<T,BiConsumer<String,Object>> nested(Consumer<ContextPairs.Pairs<T>> pairs)

Add pairs using nested naming (for example as used in ECS).

Type Parameters:

T - the item type

Parameters:

pairs - callback to add all the pairs

Returns:

a BiConsumer for use with the JsonWriter