Package org.apache.flink.util

Class MdcUtils

java.lang.Object

org.apache.flink.util.MdcUtils

public class MdcUtils
extends Object

Utility class to manage common Flink attributes in MDC (only JobID ATM).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	MdcUtils.MdcCloseable	AutoCloseable that restores the MDC contents on close.

Field Summary

Fields

Modifier and Type	Field	Description
static String	JOB_ID

Constructor Summary

Constructors

Constructor	Description
MdcUtils()

Method Summary

Modifier and Type	Method	Description
static Map<String,String>	asContextData(JobID jobID)
static Executor	scopeToJob(JobID jobID, Executor executor)	Wrap the given Executor so that the given JobID is added before it executes any submitted commands and removed afterward.
static ExecutorService	scopeToJob(JobID jobID, ExecutorService delegate)	Wrap the given ExecutorService so that the given JobID is added before it executes any submitted commands and removed afterward.
static ScheduledExecutorService	scopeToJob(JobID jobID, ScheduledExecutorService ses)	Wrap the given ScheduledExecutorService so that the given JobID is added before it executes any submitted commands and removed afterward.
static MdcUtils.MdcCloseable	withContext(Map<String,String> context)	Replace MDC contents with the provided one and return a closeable object that can be used to restore the original MDC.
static <T> Callable<T>	wrapCallable(Map<String,String> contextData, Callable<T> command)	Wrap the given Callable so that the given data is added to MDC before its execution and removed afterward.
static Runnable	wrapRunnable(Map<String,String> contextData, Runnable command)	Wrap the given Runnable so that the given data is added to MDC before its execution and removed afterward.

Methods inherited from class java.lang.Object

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

Field Detail

JOB_ID

public static final String JOB_ID

See Also:

Constant Field Values

Constructor Detail

MdcUtils

public MdcUtils()

Method Detail

withContext

public static MdcUtils.MdcCloseable withContext(Map<String,String> context)

Replace MDC contents with the provided one and return a closeable object that can be used to restore the original MDC.

Parameters:

context - to put into MDC

wrapRunnable

public static Runnable wrapRunnable(Map<String,String> contextData,
                                    Runnable command)

Wrap the given Runnable so that the given data is added to MDC before its execution and removed afterward.

wrapCallable

public static <T> Callable<T> wrapCallable(Map<String,String> contextData,
                                           Callable<T> command)

Wrap the given Callable so that the given data is added to MDC before its execution and removed afterward.

scopeToJob

public static Executor scopeToJob(JobID jobID,
                                  Executor executor)

Wrap the given Executor so that the given JobID is added before it executes any submitted commands and removed afterward.

scopeToJob

public static ExecutorService scopeToJob(JobID jobID,
                                         ExecutorService delegate)

Wrap the given ExecutorService so that the given JobID is added before it executes any submitted commands and removed afterward.

scopeToJob

public static ScheduledExecutorService scopeToJob(JobID jobID,
                                                  ScheduledExecutorService ses)

Wrap the given ScheduledExecutorService so that the given JobID is added before it executes any submitted commands and removed afterward.

asContextData

public static Map<String,String> asContextData(JobID jobID)