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 plug-able 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 logging the stack trace for the throwable will be included in the log message.

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
void	logAndThrow(RuntimeException runtimeException) This will log RuntimeException, if logging is enabled , and throw the runtime exception.
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 last argument is 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 last argument is 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

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

Parameters:

format - The formattable message to log

args - Arguments for the message, if an exception is being logged last argument is 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 last argument is the throwable.

logAndThrow

public void logAndThrow(RuntimeException runtimeException)

This will log RuntimeException, if logging is enabled , and throw the runtime exception.

Parameters:

runtimeException - to be thrown. It will do nothing if null is provided.

Throws:

RuntimeException - which is requested by this call.