org.apache.reef.util

Class ThreadLogger

java.lang.Object

org.apache.reef.util.ThreadLogger

public final class ThreadLogger
extends Object

Methods to log the currently active set of threads with their stack traces. This is useful to log abnormal process exit situations, for instance the Driver timeout in the tests.

Method Summary

Modifier and Type	Method and Description
static String	getFormattedDeadlockInfo(String prefix) Same as getFormattedDeadlockInfo(prefix, "\n\t", "\n\t\t").
static String	getFormattedDeadlockInfo(String prefix, String threadPrefix, String stackElementPrefix) Produces a String representation of threads that are deadlocked, including lock information.
static String	getFormattedThreadList(String prefix) Same as getFormattedThreadList(prefix, "\n\t", "\n\t\t").
static String	getFormattedThreadList(String prefix, String threadPrefix, String stackElementPrefix) Produces a String representation of the currently running threads.
static void	logThreads(Logger logger, Level level, String prefix) Same as logThreads(logger, level, prefix, "\n\t", "\n\t\t").
static void	logThreads(Logger logger, Level level, String prefix, String threadPrefix, String stackElementPrefix) Logs the currently active threads and their stack trace to the given Logger and Level.
static void	main(String[] args) An example how to use the above methods.

Methods inherited from class java.lang.Object

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

Method Detail

logThreads

public static void logThreads(Logger logger,
                              Level level,
                              String prefix)

Same as logThreads(logger, level, prefix, "\n\t", "\n\t\t").

logThreads

public static void logThreads(Logger logger,
                              Level level,
                              String prefix,
                              String threadPrefix,
                              String stackElementPrefix)

Logs the currently active threads and their stack trace to the given Logger and Level.

Parameters:

logger - the Logger instance to log to.

level - the Level to log into.

prefix - a prefix of the log message.

threadPrefix - logged before each thread, e.g. "\n\t" to create an indented list.

stackElementPrefix - logged before each stack trace element, e.g. "\n\t\t" to create an indented list.

getFormattedThreadList

public static String getFormattedThreadList(String prefix,
                                            String threadPrefix,
                                            String stackElementPrefix)

Produces a String representation of the currently running threads.

Parameters:

prefix - The prefix of the string returned.

threadPrefix - Printed before each thread, e.g. "\n\t" to create an indented list.

stackElementPrefix - Printed before each stack trace element, e.g. "\n\t\t" to create an indented list.

Returns:

a String representation of the currently running threads.

getFormattedThreadList

public static String getFormattedThreadList(String prefix)

Same as getFormattedThreadList(prefix, "\n\t", "\n\t\t").

getFormattedDeadlockInfo

public static String getFormattedDeadlockInfo(String prefix,
                                              String threadPrefix,
                                              String stackElementPrefix)

Produces a String representation of threads that are deadlocked, including lock information.

Parameters:

prefix - The prefix of the string returned.

threadPrefix - Printed before each thread, e.g. "\n\t" to create an indented list.

stackElementPrefix - Printed before each stack trace element, e.g. "\n\t\t" to create an indented list.

Returns:

a String representation of threads that are deadlocked, including lock information

getFormattedDeadlockInfo

public static String getFormattedDeadlockInfo(String prefix)

Same as getFormattedDeadlockInfo(prefix, "\n\t", "\n\t\t").

main

public static void main(String[] args)

An example how to use the above methods.

Parameters:

args - ignored.