io.pravega.common

Class LoggerHelpers

java.lang.Object

io.pravega.common.LoggerHelpers

public final class LoggerHelpers
extends java.lang.Object

Extension methods for Logger class.

Constructor Summary

Constructors

Constructor and Description
LoggerHelpers()

Method Summary

Modifier and Type	Method and Description
static long	traceEnter(Logger log, java.lang.String method, java.lang.Object... args) Traces the fact that a method entry has occurred.
static long	traceEnterWithContext(Logger log, java.lang.String context, java.lang.String method, java.lang.Object... args) Traces the fact that a method entry has occurred.
static void	traceLeave(Logger log, java.lang.String method, long traceEnterId, java.lang.Object... args) Traces the fact that a method has exited normally.
static void	traceLeave(Logger log, java.lang.String context, java.lang.String method, long traceEnterId, java.lang.Object... args) Traces the fact that a method has exited normally.

Methods inherited from class java.lang.Object

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

Constructor Detail

LoggerHelpers

public LoggerHelpers()

Method Detail

traceEnter

public static long traceEnter(Logger log,
                              java.lang.String method,
                              java.lang.Object... args)

Traces the fact that a method entry has occurred.

Parameters:

log - The Logger to log to.

method - The name of the method.

args - The arguments to the method.

Returns:

A generated identifier that can be used to correlate this traceEnter with its corresponding traceLeave. This is usually generated from the current System time, and when used with traceLeave it can be used to log elapsed call times.

traceEnterWithContext

public static long traceEnterWithContext(Logger log,
                                         java.lang.String context,
                                         java.lang.String method,
                                         java.lang.Object... args)

Traces the fact that a method entry has occurred.

Parameters:

log - The Logger to log to.

context - Identifying context for the operation. For example, this can be used to differentiate between different instances of the same object.

method - The name of the method.

args - The arguments to the method.

Returns:

A generated identifier that can be used to correlate this traceEnter with its corresponding traceLeave. This is usually generated from the current System time, and when used with traceLeave it can be used to log elapsed call times.

traceLeave

public static void traceLeave(Logger log,
                              java.lang.String method,
                              long traceEnterId,
                              java.lang.Object... args)

Traces the fact that a method has exited normally.

Parameters:

log - The Logger to log to.

method - The name of the method.

traceEnterId - The correlation Id obtained from a traceEnter call.

args - Additional arguments to log.

traceLeave

public static void traceLeave(Logger log,
                              java.lang.String context,
                              java.lang.String method,
                              long traceEnterId,
                              java.lang.Object... args)

Traces the fact that a method has exited normally.

Parameters:

log - The Logger to log to.

context - Identifying context for the operation. For example, this can be used to differentiate between different instances of the same object.

method - The name of the method.

traceEnterId - The correlation Id obtained from a traceEnter call.

args - Additional arguments to log.