net.kawinski.logging

Class NkTraceIndent

java.lang.Object

net.kawinski.logging.NkTraceIndent

public final class NkTraceIndent
extends Object

Indents module for NkTrace. It exposes 'indent' variable to logger's context via ThreadLocal variables and MDC. To utilize the indenting feature, setup the logger's pattern to something like: - Logback example: %date [%thread] %5level %mdc{indent}%msg \(%file:%line\) %n - WildFly (color-pattern) example: %K{level}%d{HH:mm:ss,SSS} [%t] %5p %X{indent}%s%e{} a.t(%F:%L)%n - Log4j example: ??? - ??? example: ??? Defaults: - WildFly: %d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%e%n

Field Summary

Fields

Modifier and Type	Field and Description
static String	MDC_INDENT_KEY
static int	SPACES_PER_INDENT 3 is a prefix length of ">> " and "<< ".

Method Summary

Modifier and Type	Method and Description
static void	decrement()
static String	getCurrentIndent()
static String	getIndent(int indentCount)
static int	getIndentCount()
static void	increment()
static void	reset() Resets indentation value back to 0.

Methods inherited from class java.lang.Object

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

Field Detail

MDC_INDENT_KEY

public static final String MDC_INDENT_KEY

See Also:

Constant Field Values

SPACES_PER_INDENT

public static final int SPACES_PER_INDENT

3 is a prefix length of ">> " and "<< ". This way, inner logs align vertically to the traces which looks pretty

See Also:

Constant Field Values

Method Detail

reset

public static void reset()

Resets indentation value back to 0. Useful when reusing threads. A reused thread might not have decremented back to 0. This issue might arise if: - Not all increment/decrement is paired with finally{} block - But even then, killing a thread could leave the indentation unbalanced as finally{} blocks won't be called

increment

public static void increment()

decrement

public static void decrement()

getIndentCount

public static int getIndentCount()

getIndent

public static String getIndent(int indentCount)

getCurrentIndent

public static String getCurrentIndent()