Package io.pravega.common.tracing

Class TagLogger

java.lang.Object

io.pravega.common.tracing.TagLogger

All Implemented Interfaces:

org.slf4j.Logger

public class TagLogger
extends java.lang.Object
implements org.slf4j.Logger

Wrapper class for a Logger instance that exposes all its functionality, plus a set of convenience methods to properly log client requests ids for the end-to-end tracing mechanism.

Field Summary

Fields inherited from interface org.slf4j.Logger

ROOT_LOGGER_NAME

Constructor Summary

Constructors

Constructor	Description
TagLogger(org.slf4j.Logger log)

Method Summary

Modifier and Type	Method	Description
void	debug(long requestId, java.lang.String message, java.lang.Object... args)	Writes a debug-level log line on the provided logger consisting of a header tag (e.g., requestId) and the message passed (plus the arguments) in the case that the request id comes from a client request (i.e., not a default one).
void	debug(java.lang.String msg)
void	debug(java.lang.String format, java.lang.Object arg)
void	debug(java.lang.String format, java.lang.Object... arguments)
void	debug(java.lang.String format, java.lang.Object arg1, java.lang.Object arg2)
void	debug(java.lang.String msg, java.lang.Throwable t)
void	debug(org.slf4j.Marker marker, java.lang.String msg)
void	debug(org.slf4j.Marker marker, java.lang.String format, java.lang.Object arg)
void	debug(org.slf4j.Marker marker, java.lang.String format, java.lang.Object... arguments)
void	debug(org.slf4j.Marker marker, java.lang.String format, java.lang.Object arg1, java.lang.Object arg2)
void	debug(org.slf4j.Marker marker, java.lang.String msg, java.lang.Throwable t)
void	error(long requestId, java.lang.String message, java.lang.Object... args)	Writes an error-level log line on the provided logger consisting of a header tag (e.g., requestId) and the message passed (plus the arguments) in the case that the request id comes from a client request (i.e., not a default one).
void	error(java.lang.String msg)
void	error(java.lang.String format, java.lang.Object arg)
void	error(java.lang.String format, java.lang.Object... arguments)
void	error(java.lang.String format, java.lang.Object arg1, java.lang.Object arg2)
void	error(java.lang.String msg, java.lang.Throwable t)
void	error(org.slf4j.Marker marker, java.lang.String msg)
void	error(org.slf4j.Marker marker, java.lang.String format, java.lang.Object arg)
void	error(org.slf4j.Marker marker, java.lang.String format, java.lang.Object... arguments)
void	error(org.slf4j.Marker marker, java.lang.String format, java.lang.Object arg1, java.lang.Object arg2)
void	error(org.slf4j.Marker marker, java.lang.String msg, java.lang.Throwable t)
java.lang.String	getName()
void	info(long requestId, java.lang.String message, java.lang.Object... args)	Writes an info-level log line on the provided logger consisting of a header tag (e.g., requestId) and the message passed (plus the arguments) in the case that the request id comes from a client request (i.e., not a default one).
void	info(java.lang.String msg)
void	info(java.lang.String format, java.lang.Object arg)
void	info(java.lang.String format, java.lang.Object... arguments)
void	info(java.lang.String format, java.lang.Object arg1, java.lang.Object arg2)
void	info(java.lang.String msg, java.lang.Throwable t)
void	info(org.slf4j.Marker marker, java.lang.String msg)
void	info(org.slf4j.Marker marker, java.lang.String format, java.lang.Object arg)
void	info(org.slf4j.Marker marker, java.lang.String format, java.lang.Object... arguments)
void	info(org.slf4j.Marker marker, java.lang.String format, java.lang.Object arg1, java.lang.Object arg2)
void	info(org.slf4j.Marker marker, java.lang.String msg, java.lang.Throwable t)
boolean	isDebugEnabled()
boolean	isDebugEnabled(org.slf4j.Marker marker)
boolean	isErrorEnabled()
boolean	isErrorEnabled(org.slf4j.Marker marker)
boolean	isInfoEnabled()
boolean	isInfoEnabled(org.slf4j.Marker marker)
boolean	isTraceEnabled()
boolean	isTraceEnabled(org.slf4j.Marker marker)
boolean	isWarnEnabled()
boolean	isWarnEnabled(org.slf4j.Marker marker)
void	trace(long requestId, java.lang.String message, java.lang.Object... args)	Writes a trace-level log line on the provided logger consisting of a header tag (e.g., requestId) and the message passed (plus the arguments) in the case that the request id comes from a client request (i.e., not a default one).
void	trace(java.lang.String msg)
void	trace(java.lang.String format, java.lang.Object arg)
void	trace(java.lang.String format, java.lang.Object... arguments)
void	trace(java.lang.String format, java.lang.Object arg1, java.lang.Object arg2)
void	trace(java.lang.String msg, java.lang.Throwable t)
void	trace(org.slf4j.Marker marker, java.lang.String msg)
void	trace(org.slf4j.Marker marker, java.lang.String format, java.lang.Object arg)
void	trace(org.slf4j.Marker marker, java.lang.String format, java.lang.Object... argArray)
void	trace(org.slf4j.Marker marker, java.lang.String format, java.lang.Object arg1, java.lang.Object arg2)
void	trace(org.slf4j.Marker marker, java.lang.String msg, java.lang.Throwable t)
void	warn(long requestId, java.lang.String message, java.lang.Object... args)	Writes a warn-level log line on the provided logger consisting of a header tag (e.g., requestId) and the message passed (plus the arguments) in the case that the request id comes from a client request (i.e., not a default one).
void	warn(java.lang.String msg)
void	warn(java.lang.String format, java.lang.Object arg)
void	warn(java.lang.String format, java.lang.Object... arguments)
void	warn(java.lang.String format, java.lang.Object arg1, java.lang.Object arg2)
void	warn(java.lang.String msg, java.lang.Throwable t)
void	warn(org.slf4j.Marker marker, java.lang.String msg)
void	warn(org.slf4j.Marker marker, java.lang.String format, java.lang.Object arg)
void	warn(org.slf4j.Marker marker, java.lang.String format, java.lang.Object... arguments)
void	warn(org.slf4j.Marker marker, java.lang.String format, java.lang.Object arg1, java.lang.Object arg2)
void	warn(org.slf4j.Marker marker, java.lang.String msg, java.lang.Throwable t)

Methods inherited from class java.lang.Object

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

Constructor Detail

TagLogger

public TagLogger(org.slf4j.Logger log)

Method Detail

getName

public java.lang.String getName()

Specified by:

getName in interface org.slf4j.Logger

isTraceEnabled

public boolean isTraceEnabled()

Specified by:

isTraceEnabled in interface org.slf4j.Logger

isTraceEnabled

public boolean isTraceEnabled(org.slf4j.Marker marker)

Specified by:

isTraceEnabled in interface org.slf4j.Logger

trace

public void trace(java.lang.String msg)

Specified by:

trace in interface org.slf4j.Logger

trace

public void trace(java.lang.String format,
                  java.lang.Object arg)

Specified by:

trace in interface org.slf4j.Logger

trace

public void trace(java.lang.String format,
                  java.lang.Object arg1,
                  java.lang.Object arg2)

Specified by:

trace in interface org.slf4j.Logger

trace

public void trace(java.lang.String format,
                  java.lang.Object... arguments)

Specified by:

trace in interface org.slf4j.Logger

trace

public void trace(java.lang.String msg,
                  java.lang.Throwable t)

Specified by:

trace in interface org.slf4j.Logger

trace

public void trace(org.slf4j.Marker marker,
                  java.lang.String msg)

Specified by:

trace in interface org.slf4j.Logger

trace

public void trace(org.slf4j.Marker marker,
                  java.lang.String format,
                  java.lang.Object arg)

Specified by:

trace in interface org.slf4j.Logger

trace

public void trace(org.slf4j.Marker marker,
                  java.lang.String format,
                  java.lang.Object arg1,
                  java.lang.Object arg2)

Specified by:

trace in interface org.slf4j.Logger

trace

public void trace(org.slf4j.Marker marker,
                  java.lang.String format,
                  java.lang.Object... argArray)

Specified by:

trace in interface org.slf4j.Logger

trace

public void trace(org.slf4j.Marker marker,
                  java.lang.String msg,
                  java.lang.Throwable t)

Specified by:

trace in interface org.slf4j.Logger

trace

public void trace(long requestId,
                  java.lang.String message,
                  java.lang.Object... args)

Writes a trace-level log line on the provided logger consisting of a header tag (e.g., requestId) and the message passed (plus the arguments) in the case that the request id comes from a client request (i.e., not a default one). Note that the message may include formatting anchors to be filled by subsequent arguments.

Parameters:

requestId - Tag used as header for the log line.

message - Message to log including formatting anchors.

args - Additional arguments to log expected to fill in the message's formatting anchors.

isDebugEnabled

public boolean isDebugEnabled()

Specified by:

isDebugEnabled in interface org.slf4j.Logger

isDebugEnabled

public boolean isDebugEnabled(org.slf4j.Marker marker)

Specified by:

isDebugEnabled in interface org.slf4j.Logger

debug

public void debug(java.lang.String msg)

Specified by:

debug in interface org.slf4j.Logger

debug

public void debug(java.lang.String format,
                  java.lang.Object arg)

Specified by:

debug in interface org.slf4j.Logger

debug

public void debug(java.lang.String format,
                  java.lang.Object arg1,
                  java.lang.Object arg2)

Specified by:

debug in interface org.slf4j.Logger

debug

public void debug(java.lang.String format,
                  java.lang.Object... arguments)

Specified by:

debug in interface org.slf4j.Logger

debug

public void debug(java.lang.String msg,
                  java.lang.Throwable t)

Specified by:

debug in interface org.slf4j.Logger

debug

public void debug(org.slf4j.Marker marker,
                  java.lang.String msg)

Specified by:

debug in interface org.slf4j.Logger

debug

public void debug(org.slf4j.Marker marker,
                  java.lang.String format,
                  java.lang.Object arg)

Specified by:

debug in interface org.slf4j.Logger

debug

public void debug(org.slf4j.Marker marker,
                  java.lang.String format,
                  java.lang.Object arg1,
                  java.lang.Object arg2)

Specified by:

debug in interface org.slf4j.Logger

debug

public void debug(org.slf4j.Marker marker,
                  java.lang.String format,
                  java.lang.Object... arguments)

Specified by:

debug in interface org.slf4j.Logger

debug

public void debug(org.slf4j.Marker marker,
                  java.lang.String msg,
                  java.lang.Throwable t)

Specified by:

debug in interface org.slf4j.Logger

debug

public void debug(long requestId,
                  java.lang.String message,
                  java.lang.Object... args)

Writes a debug-level log line on the provided logger consisting of a header tag (e.g., requestId) and the message passed (plus the arguments) in the case that the request id comes from a client request (i.e., not a default one). Note that the message may include formatting anchors to be filled by subsequent arguments.

Parameters:

requestId - Tag used as header for the log line.

message - Message to log including formatting anchors.

args - Additional arguments to log expected to fill in the message's formatting anchors.

isInfoEnabled

public boolean isInfoEnabled()

Specified by:

isInfoEnabled in interface org.slf4j.Logger

isInfoEnabled

public boolean isInfoEnabled(org.slf4j.Marker marker)

Specified by:

isInfoEnabled in interface org.slf4j.Logger

info

public void info(java.lang.String msg)

Specified by:

info in interface org.slf4j.Logger

info

public void info(java.lang.String format,
                 java.lang.Object arg)

Specified by:

info in interface org.slf4j.Logger

info

public void info(java.lang.String format,
                 java.lang.Object arg1,
                 java.lang.Object arg2)

Specified by:

info in interface org.slf4j.Logger

info

public void info(java.lang.String format,
                 java.lang.Object... arguments)

Specified by:

info in interface org.slf4j.Logger

info

public void info(java.lang.String msg,
                 java.lang.Throwable t)

Specified by:

info in interface org.slf4j.Logger

info

public void info(org.slf4j.Marker marker,
                 java.lang.String msg)

Specified by:

info in interface org.slf4j.Logger

info

public void info(org.slf4j.Marker marker,
                 java.lang.String format,
                 java.lang.Object arg)

Specified by:

info in interface org.slf4j.Logger

info

public void info(org.slf4j.Marker marker,
                 java.lang.String format,
                 java.lang.Object arg1,
                 java.lang.Object arg2)

Specified by:

info in interface org.slf4j.Logger

info

public void info(org.slf4j.Marker marker,
                 java.lang.String format,
                 java.lang.Object... arguments)

Specified by:

info in interface org.slf4j.Logger

info

public void info(org.slf4j.Marker marker,
                 java.lang.String msg,
                 java.lang.Throwable t)

Specified by:

info in interface org.slf4j.Logger

info

public void info(long requestId,
                 java.lang.String message,
                 java.lang.Object... args)

Writes an info-level log line on the provided logger consisting of a header tag (e.g., requestId) and the message passed (plus the arguments) in the case that the request id comes from a client request (i.e., not a default one). Note that the message may include formatting anchors to be filled by subsequent arguments.

Parameters:

requestId - Tag used as header for the log line.

message - Message to log including formatting anchors.

args - Additional arguments to log expected to fill in the message's formatting anchors.

isWarnEnabled

public boolean isWarnEnabled()

Specified by:

isWarnEnabled in interface org.slf4j.Logger

isWarnEnabled

public boolean isWarnEnabled(org.slf4j.Marker marker)

Specified by:

isWarnEnabled in interface org.slf4j.Logger

warn

public void warn(java.lang.String msg)

Specified by:

warn in interface org.slf4j.Logger

warn

public void warn(java.lang.String format,
                 java.lang.Object arg)

Specified by:

warn in interface org.slf4j.Logger

warn

public void warn(java.lang.String format,
                 java.lang.Object... arguments)

Specified by:

warn in interface org.slf4j.Logger

warn

public void warn(java.lang.String format,
                 java.lang.Object arg1,
                 java.lang.Object arg2)

Specified by:

warn in interface org.slf4j.Logger

warn

public void warn(java.lang.String msg,
                 java.lang.Throwable t)

Specified by:

warn in interface org.slf4j.Logger

warn

public void warn(org.slf4j.Marker marker,
                 java.lang.String msg)

Specified by:

warn in interface org.slf4j.Logger

warn

public void warn(org.slf4j.Marker marker,
                 java.lang.String format,
                 java.lang.Object arg)

Specified by:

warn in interface org.slf4j.Logger

warn

public void warn(org.slf4j.Marker marker,
                 java.lang.String format,
                 java.lang.Object arg1,
                 java.lang.Object arg2)

Specified by:

warn in interface org.slf4j.Logger

warn

public void warn(org.slf4j.Marker marker,
                 java.lang.String format,
                 java.lang.Object... arguments)

Specified by:

warn in interface org.slf4j.Logger

warn

public void warn(org.slf4j.Marker marker,
                 java.lang.String msg,
                 java.lang.Throwable t)

Specified by:

warn in interface org.slf4j.Logger

warn

public void warn(long requestId,
                 java.lang.String message,
                 java.lang.Object... args)

Writes a warn-level log line on the provided logger consisting of a header tag (e.g., requestId) and the message passed (plus the arguments) in the case that the request id comes from a client request (i.e., not a default one). Note that the message may include formatting anchors to be filled by subsequent arguments.

Parameters:

requestId - Tag used as header for the log line.

message - Message to log including formatting anchors.

args - Additional arguments to log expected to fill in the message's formatting anchors.

isErrorEnabled

public boolean isErrorEnabled()

Specified by:

isErrorEnabled in interface org.slf4j.Logger

isErrorEnabled

public boolean isErrorEnabled(org.slf4j.Marker marker)

Specified by:

isErrorEnabled in interface org.slf4j.Logger

error

public void error(java.lang.String msg)

Specified by:

error in interface org.slf4j.Logger

error

public void error(java.lang.String format,
                  java.lang.Object arg)

Specified by:

error in interface org.slf4j.Logger

error

public void error(java.lang.String format,
                  java.lang.Object arg1,
                  java.lang.Object arg2)

Specified by:

error in interface org.slf4j.Logger

error

public void error(java.lang.String format,
                  java.lang.Object... arguments)

Specified by:

error in interface org.slf4j.Logger

error

public void error(java.lang.String msg,
                  java.lang.Throwable t)

Specified by:

error in interface org.slf4j.Logger

error

public void error(org.slf4j.Marker marker,
                  java.lang.String msg)

Specified by:

error in interface org.slf4j.Logger

error

public void error(org.slf4j.Marker marker,
                  java.lang.String format,
                  java.lang.Object arg)

Specified by:

error in interface org.slf4j.Logger

error

public void error(org.slf4j.Marker marker,
                  java.lang.String format,
                  java.lang.Object arg1,
                  java.lang.Object arg2)

Specified by:

error in interface org.slf4j.Logger

error

public void error(org.slf4j.Marker marker,
                  java.lang.String format,
                  java.lang.Object... arguments)

Specified by:

error in interface org.slf4j.Logger

error

public void error(org.slf4j.Marker marker,
                  java.lang.String msg,
                  java.lang.Throwable t)

Specified by:

error in interface org.slf4j.Logger

error

public void error(long requestId,
                  java.lang.String message,
                  java.lang.Object... args)

Writes an error-level log line on the provided logger consisting of a header tag (e.g., requestId) and the message passed (plus the arguments) in the case that the request id comes from a client request (i.e., not a default one). Note that the message may include formatting anchors to be filled by subsequent arguments.

Parameters:

requestId - Tag used as header for the log line.

message - Message to log including formatting anchors.

args - Additional arguments to log expected to fill in the message's formatting anchors.