io.servicetalk.opentracing.log4j2

Class ServiceTalkTracingThreadContextMap

java.lang.Object

io.servicetalk.log4j2.mdc.utils.ServiceTalkThreadContextMap

io.servicetalk.opentracing.log4j2.ServiceTalkTracingThreadContextMap

All Implemented Interfaces:

org.apache.logging.log4j.spi.CleanableThreadContextMap, org.apache.logging.log4j.spi.ReadOnlyThreadContextMap, org.apache.logging.log4j.spi.ThreadContextMap, org.apache.logging.log4j.spi.ThreadContextMap2

public final class ServiceTalkTracingThreadContextMap
extends ServiceTalkThreadContextMap

A ThreadContext that provides storage for MDC based upon AsyncContext that also includes tracing information in accessors via AsyncContextInMemoryScopeManager. Due to the read only nature of making the tracing information available the ThreadContext map-like interface spirit is not strictly followed. This is due to the fact that modifier methods (e.g. ServiceTalkThreadContextMap.put(String, String), ServiceTalkThreadContextMap.clear()) will not have any impact on this class returning tracing information from the accessor methods (e.g. get(String)). The motivation for this behavior is to avoid a tight coupling between changes to the tracing storage having to be replicated in this MDC storage container. The mechanics to orchestrate this add non-negligible complexity/overhead and so this class provides a trade-off to make the tracing information available in MDC.

Constructor Summary

Constructors

Constructor and Description
ServiceTalkTracingThreadContextMap()

Method Summary

Modifier and Type	Method and Description
boolean	containsKey(java.lang.String key)
java.lang.String	get(java.lang.String key)
protected java.util.Map<java.lang.String,java.lang.String>	getCopy(java.util.Map<java.lang.String,java.lang.String> storage) Get a copy of this ThreadContextMap given the underlying Map storage.
protected java.util.Map<java.lang.String,java.lang.String>	getImmutableMapOrNull(java.util.Map<java.lang.String,java.lang.String> storage) Provide the implementation for ServiceTalkThreadContextMap.getImmutableMapOrNull() given then underlying Map storage.
protected org.apache.logging.log4j.util.StringMap	getReadOnlyContextData(java.util.Map<java.lang.String,java.lang.String> storage) Create a new read-only StringMap.
boolean	isEmpty()

Methods inherited from class io.servicetalk.log4j2.mdc.utils.ServiceTalkThreadContextMap

clear, getCopy, getImmutableMapOrNull, getReadOnlyContextData, put, putAll, remove, removeAll

Methods inherited from class java.lang.Object

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

Constructor Detail

ServiceTalkTracingThreadContextMap

public ServiceTalkTracingThreadContextMap()

Method Detail

get

@Nullable
public java.lang.String get(java.lang.String key)

Specified by:

get in interface org.apache.logging.log4j.spi.ReadOnlyThreadContextMap

Specified by:

get in interface org.apache.logging.log4j.spi.ThreadContextMap

Overrides:

get in class ServiceTalkThreadContextMap

containsKey

public boolean containsKey(java.lang.String key)

Specified by:

containsKey in interface org.apache.logging.log4j.spi.ReadOnlyThreadContextMap

Specified by:

containsKey in interface org.apache.logging.log4j.spi.ThreadContextMap

Overrides:

containsKey in class ServiceTalkThreadContextMap

getCopy

protected java.util.Map<java.lang.String,java.lang.String> getCopy(java.util.Map<java.lang.String,java.lang.String> storage)

Description copied from class: ServiceTalkThreadContextMap

Get a copy of this ThreadContextMap given the underlying Map storage.

Overrides:

getCopy in class ServiceTalkThreadContextMap

Parameters:

storage - the underlying Map storage.

Returns:

a copy of this ThreadContextMap.

getImmutableMapOrNull

@Nullable
protected java.util.Map<java.lang.String,java.lang.String> getImmutableMapOrNull(java.util.Map<java.lang.String,java.lang.String> storage)

Description copied from class: ServiceTalkThreadContextMap

Provide the implementation for ServiceTalkThreadContextMap.getImmutableMapOrNull() given then underlying Map storage.

Overrides:

getImmutableMapOrNull in class ServiceTalkThreadContextMap

Parameters:

storage - the underlying Map storage.

Returns:

An immutable Map or null if empty.

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface org.apache.logging.log4j.spi.ReadOnlyThreadContextMap

Specified by:

isEmpty in interface org.apache.logging.log4j.spi.ThreadContextMap

Overrides:

isEmpty in class ServiceTalkThreadContextMap

getReadOnlyContextData

protected org.apache.logging.log4j.util.StringMap getReadOnlyContextData(java.util.Map<java.lang.String,java.lang.String> storage)

Description copied from class: ServiceTalkThreadContextMap

Create a new read-only StringMap.

Overrides:

getReadOnlyContextData in class ServiceTalkThreadContextMap

Parameters:

storage - The underlying storage for this ThreadContextMap.

Returns:

a new read-only StringMap.