com.azure.core.util.logging

Class ClientLogger

java.lang.Object

com.azure.core.util.logging.ClientLogger

public class ClientLogger
extends Object

This is a fluent logger helper class that wraps a pluggable Logger.

This logger logs formattable messages that use {} as the placeholder. When a throwable is the last argument of the format varargs and the logger is enabled for verbose, the stack trace for the throwable is logged.

A minimum logging level threshold is determined by the AZURE_LOG_LEVEL environment configuration. By default logging is disabled.

Log level hierarchy

1. Error
2. Warning
3. Info
4. Verbose

See Also:

Configuration

Constructor Summary

Constructors

Constructor and Description
ClientLogger(Class<?> clazz) Retrieves a logger for the passed class using the LoggerFactory.
ClientLogger(String className) Retrieves a logger for the passed class name using the LoggerFactory.

Method Summary

Modifier and Type	Method and Description
void	error(String format, Object... args) Logs a formattable message that uses {} as the placeholder at error log level.
void	info(String format, Object... args) Logs a formattable message that uses {} as the placeholder at informational log level.
RuntimeException	logExceptionAsError(RuntimeException runtimeException) Logs the RuntimeException at the error level and returns it to be thrown.
RuntimeException	logExceptionAsWarning(RuntimeException runtimeException) Logs the RuntimeException at the warning level and returns it to be thrown.
void	verbose(String format, Object... args) Logs a formattable message that uses {} as the placeholder at verbose log level.
void	warning(String format, Object... args) Logs a formattable message that uses {} as the placeholder at warning log level.

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientLogger

public ClientLogger(Class<?> clazz)

Retrieves a logger for the passed class using the LoggerFactory.

Parameters:

clazz - Class creating the logger.

ClientLogger

public ClientLogger(String className)

Retrieves a logger for the passed class name using the LoggerFactory.

Parameters:

className - Class name creating the logger.

Method Detail

verbose

public void verbose(String format,
                    Object... args)

Logs a formattable message that uses {} as the placeholder at verbose log level.

Code samples

Logging a message at verbose log level.

logger.verbose("A formattable message. Hello, {}", name);

Parameters:

format - The formattable message to log.

args - Arguments for the message. If an exception is being logged, the last argument should be the Throwable.

info

public void info(String format,
                 Object... args)

Logs a formattable message that uses {} as the placeholder at informational log level.

Code samples

Logging a message at informational log level.

logger.info("A formattable message. Hello, {}", name);

Parameters:

format - The formattable message to log

args - Arguments for the message. If an exception is being logged, the last argument should be the Throwable.

warning

public void warning(String format,
                    Object... args)

Logs a formattable message that uses {} as the placeholder at warning log level.

Code samples

Logging a message at warning log level.

Throwable exception = new IllegalArgumentException("An invalid argument was encountered.");
logger.warning("A formattable message. Hello, {}", name, exception);

Parameters:

format - The formattable message to log.

args - Arguments for the message. If an exception is being logged, the last argument should be the Throwable.

error

public void error(String format,
                  Object... args)

Logs a formattable message that uses {} as the placeholder at error log level.

Code samples

Logging an error with stack trace.

try {
    upload(resource);
} catch (IOException ex) {
    logger.error("A formattable message. Hello, {}", name, ex);
}

Parameters:

format - The formattable message to log.

args - Arguments for the message. If an exception is being logged, the last argument should be the Throwable.

logExceptionAsWarning

public RuntimeException logExceptionAsWarning(RuntimeException runtimeException)

Logs the RuntimeException at the warning level and returns it to be thrown.

Parameters:

runtimeException - RuntimeException to be logged and returned.

Returns:

The passed RuntimeException.

Throws:

NullPointerException - If runtimeException is null.

logExceptionAsError

public RuntimeException logExceptionAsError(RuntimeException runtimeException)

Logs the RuntimeException at the error level and returns it to be thrown.

Parameters:

runtimeException - RuntimeException to be logged and returned.

Returns:

The passed RuntimeException.

Throws:

NullPointerException - If runtimeException is null.