com.lightbend.cinnamon.slf4j.mdc

Interface LogCorrelation

All Known Implementing Classes:

AutomaticCorrelationId, Slf4jMdcTraceId

public interface LogCorrelation

Insert identifiers into the MDC for log correlation.

Method Summary

Modifier and Type	Method and Description
boolean	allScopes() Whether to check and insert correlation identifiers for all context scopes.
java.lang.String	key() MDC key used for this log correlation.
boolean	normalize() Should the key name for this correlation identifier be normalized in MDC?
java.lang.String	value() Access or generate the correlation identifier for the current MDC scope.

Method Detail

allScopes

boolean allScopes()

Whether to check and insert correlation identifiers for all context scopes.

Otherwise the default is to only insert at entry points, such as incoming HTTP requests.

Returns:

whether to check log correlation for all context scopes

key

java.lang.String key()

MDC key used for this log correlation.

Returns:

MDC key for this correlation

value

java.lang.String value()

Access or generate the correlation identifier for the current MDC scope.

Returns:

MDC value for this correlation

normalize

boolean normalize()

Should the key name for this correlation identifier be normalized in MDC?

For example, if MDC contains the key "correlation-id", but the key() is configured as "Correlation-ID", enabling this setting will make Cinnamon scan the MDC keys and normalize incorrect casing when it occurs.

Returns:

true if the correlation identifier key name should be normalised