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 format-able 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
ClientLogger	asError() Sets the logger to the error logging level.
ClientLogger	asInfo() Sets the logger to the info logging level.
ClientLogger	asVerbose() Sets the logger to the verbose logging level.
ClientLogger	asWarning() Sets the logger to the warning logging level.
void	log(String format, Object... args) Logs a format-able message that uses {} as the placeholder.

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

asVerbose

public ClientLogger asVerbose()

Sets the logger to the verbose logging level.

Returns:

Updated ClientLogger if verbose is enabled.

asInfo

public ClientLogger asInfo()

Sets the logger to the info logging level.

Returns:

Updated ClientLogger if info is enabled.

asWarning

public ClientLogger asWarning()

Sets the logger to the warning logging level.

Returns:

Updated ClientLogger if warn is enabled.

asError

public ClientLogger asError()

Sets the logger to the error logging level.

Returns:

Updated ClientLogger if error is enabled..

log

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

Logs a format-able message that uses {} as the placeholder.

Code Samples

Logging a message with the default log level

 ClientLogger logger = new ClientLogger(Example.class);
 logger.log("A message");
 

Logging a format-able warning

 ClientLogger logger = new ClientLogger(Example.class);
 logger.asWarning().log("A format-able message. Hello, {}", name);
 

Logging an error with stack trace

 ClientLogger logger = new ClientLogger(Example.class);
 try {
    upload(resource);
 } catch (Throwable ex) {
    logger.asError().log("Failed to upload {}", resource.name(), ex);
 }
 

Parameters:

format - Format-able message.

args - Arguments for the message, if an exception is being logged last argument is the throwable.