discord4j.common

Class LogUtil

java.lang.Object

discord4j.common.LogUtil

public class LogUtil
extends Object

Utility to support logging details.

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_BUCKET_ID
static String	KEY_GATEWAY_ID
static String	KEY_GUILD_ID
static String	KEY_REQUEST_ID
static String	KEY_SHARD_ID

Constructor Summary

Constructors

Constructor and Description
LogUtil()

Method Summary

Modifier and Type	Method and Description
static Function<Context,Context>	clearContext()
static String	format(Context context, String msg) Format a message by unwrapping certain Context values as metadata, and if they exist, prepend them to the given message.
static String	formatValue(Object value, int maxLength) Format a given Object to a String, optionally limiting their length.
static void	traceDebug(Logger logger, Function<Boolean,String> messageFactory) Log a message depending on the enabled level for a given Logger.

Methods inherited from class java.lang.Object

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

Field Detail

KEY_BUCKET_ID

public static final String KEY_BUCKET_ID

See Also:

Constant Field Values

KEY_REQUEST_ID

public static final String KEY_REQUEST_ID

See Also:

Constant Field Values

KEY_GATEWAY_ID

public static final String KEY_GATEWAY_ID

See Also:

Constant Field Values

KEY_SHARD_ID

public static final String KEY_SHARD_ID

See Also:

Constant Field Values

KEY_GUILD_ID

public static final String KEY_GUILD_ID

See Also:

Constant Field Values

Constructor Detail

LogUtil

public LogUtil()

Method Detail

format

public static String format(Context context,
                            String msg)

Format a message by unwrapping certain Context values as metadata, and if they exist, prepend them to the given message.

Parameters:

context - a Reactor context to enrich the logging message

msg - the logging message

Returns:

a formatted log message

formatValue

public static String formatValue(@Nullable
                                 Object value,
                                 int maxLength)

Format a given Object to a String, optionally limiting their length.

Parameters:

value - the value to format

maxLength - maximum length of the formatted value if positive or impose no limit otherwise.

Returns:

a formatted value

traceDebug

public static void traceDebug(Logger logger,
                              Function<Boolean,String> messageFactory)

Log a message depending on the enabled level for a given Logger. The supplied message factory will be applied with true if the logger has trace level enabled, given by Logger.isTraceEnabled(), o false otherwise.

Parameters:

logger - the logger instance used for logging a message

messageFactory - a Function that takes true value if the given logger has trace level enabled, false otherwise, and produces a message to log.

clearContext

public static Function<Context,Context> clearContext()