io.servicetalk.opentracing.log4j2

Class ServiceTalkTracingThreadContextMap

Object

ServiceTalkThreadContextMap

ServiceTalkTracingThreadContextMap

All Implemented Interfaces:

CleanableThreadContextMap, ReadOnlyThreadContextMap, ThreadContextMap, 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() Create a new ThreadContextMap Note: this is intended to be used via service loading and not instantiated directly.

Method Summary

Modifier and Type	Method and Description
boolean	containsKey(String key)
String	get(String key)
Map<String,String>	getCopy()
protected Map<String,String>	getCopyOrNull()
Map<String,String>	getImmutableMapOrNull()
StringMap	getReadOnlyContextData()
boolean	isEmpty()

Methods inherited from class ServiceTalkThreadContextMap

clear, put, putAll, remove, removeAll

Methods inherited from class Object

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

Constructor Detail

ServiceTalkTracingThreadContextMap

public ServiceTalkTracingThreadContextMap()

Create a new ThreadContextMap Note: this is intended to be used via service loading and not instantiated directly.

Method Detail

get

@Nullable
public String get(String key)

Specified by:

get in interface ReadOnlyThreadContextMap

Specified by:

get in interface ThreadContextMap

Overrides:

get in class ServiceTalkThreadContextMap

containsKey

public boolean containsKey(String key)

Specified by:

containsKey in interface ReadOnlyThreadContextMap

Specified by:

containsKey in interface ThreadContextMap

Overrides:

containsKey in class ServiceTalkThreadContextMap

getCopy

public Map<String,String> getCopy()

Specified by:

getCopy in interface ReadOnlyThreadContextMap

Specified by:

getCopy in interface ThreadContextMap

Overrides:

getCopy in class ServiceTalkThreadContextMap

getImmutableMapOrNull

@Nullable
public Map<String,String> getImmutableMapOrNull()

Specified by:

getImmutableMapOrNull in interface ReadOnlyThreadContextMap

Specified by:

getImmutableMapOrNull in interface ThreadContextMap

Overrides:

getImmutableMapOrNull in class ServiceTalkThreadContextMap

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface ReadOnlyThreadContextMap

Specified by:

isEmpty in interface ThreadContextMap

Overrides:

isEmpty in class ServiceTalkThreadContextMap

getReadOnlyContextData

public StringMap getReadOnlyContextData()

Specified by:

getReadOnlyContextData in interface ReadOnlyThreadContextMap

Specified by:

getReadOnlyContextData in interface ThreadContextMap2

Overrides:

getReadOnlyContextData in class ServiceTalkThreadContextMap

getCopyOrNull

@Nullable
protected Map<String,String> getCopyOrNull()

Overrides:

getCopyOrNull in class ServiceTalkThreadContextMap