org.sonar.api.utils.log

Interface Logger

public interface Logger

SonarQube plugins are not coupled with external logging libraries like SLF4J or Logback.

Example:

 public class MyClass {
   private static final Logger LOGGER = Loggers.get("logger_name");

   public void doSomething() {
     LOGGER.info("something valuable for production environment");
     LOGGER.warn("message with arguments {} and {}", "foo", 42);
   }
 }
 

Message arguments are defined with {}, but not with Formatter syntax.

INFO, WARN and ERROR levels are always enabled. They can't be disabled by users. DEBUG and TRACE levels are enabled on demand with the property sonar.log.level.

See LogTester for testing facilities.

Since:

5.1

Method Summary

Methods

Modifier and Type	Method and Description
void	debug(String msg) Logs a DEBUG message.
void	debug(String msg, Object... args)
void	debug(String pattern, Object arg)
void	debug(String msg, Object arg1, Object arg2)
void	error(String msg) Logs an ERROR level message.
void	error(String msg, Object... args)
void	error(String msg, Object arg)
void	error(String msg, Object arg1, Object arg2)
void	error(String msg, Throwable thrown)
void	info(String msg) Logs an INFO level message.
void	info(String msg, Object... args)
void	info(String msg, Object arg)
void	info(String msg, Object arg1, Object arg2)
boolean	isDebugEnabled()
boolean	isTraceEnabled()
boolean	setLevel(LoggerLevel level) Attempt to change logger level.
void	trace(String msg) Logs a TRACE message.
void	trace(String msg, Object... args)
void	trace(String pattern, Object arg)
void	trace(String msg, Object arg1, Object arg2)
void	warn(String msg) Logs a WARN level message.
void	warn(String msg, Object... args)
void	warn(String msg, Object arg)
void	warn(String msg, Object arg1, Object arg2)

Method Detail

isTraceEnabled

boolean isTraceEnabled()

trace

void trace(String msg)

Logs a TRACE message. TRACE messages must be valuable for diagnosing production problems. They must not be used for development debugging. They can significantly slow down performances. The standard use-case is logging of SQL and Elasticsearch requests.

trace

void trace(String pattern,
         @Nullable
         Object arg)

See Also:

trace(String)

trace

void trace(String msg,
         @Nullable
         Object arg1,
         @Nullable
         Object arg2)

See Also:

trace(String)

trace

void trace(String msg,
         Object... args)

See Also:

trace(String)

isDebugEnabled

boolean isDebugEnabled()

debug

void debug(String msg)

Logs a DEBUG message. Debug messages must be valuable for diagnosing production problems. They must not be used for development debugging.

debug

void debug(String pattern,
         @Nullable
         Object arg)

See Also:

debug(String)

debug

void debug(String msg,
         @Nullable
         Object arg1,
         @Nullable
         Object arg2)

See Also:

debug(String)

debug

void debug(String msg,
         Object... args)

See Also:

debug(String)

info

void info(String msg)

Logs an INFO level message.

info

void info(String msg,
        @Nullable
        Object arg)

See Also:

info(String)

info

void info(String msg,
        @Nullable
        Object arg1,
        @Nullable
        Object arg2)

See Also:

info(String)

info

void info(String msg,
        Object... args)

See Also:

info(String)

warn

void warn(String msg)

Logs a WARN level message.

warn

void warn(String msg,
        @Nullable
        Object arg)

See Also:

warn(String)

warn

void warn(String msg,
        @Nullable
        Object arg1,
        @Nullable
        Object arg2)

See Also:

warn(String)

warn

void warn(String msg,
        Object... args)

See Also:

warn(String)

error

void error(String msg)

Logs an ERROR level message.

error

void error(String msg,
         @Nullable
         Object arg)

See Also:

error(String)

error

void error(String msg,
         @Nullable
         Object arg1,
         @Nullable
         Object arg2)

See Also:

error(String)

error

void error(String msg,
         Object... args)

See Also:

error(String)

error

void error(String msg,
         Throwable thrown)

See Also:

error(String)

setLevel

boolean setLevel(LoggerLevel level)

Attempt to change logger level. Return true if it succeeded, false if the underlying logging facility does not allow to change level at runtime.

This method must not be used to enable DEBUG or TRACE logs in tests. Use LogTester.setLevel(LoggerLevel) instead.

The standard use-case is to customize logging of embedded 3rd-party libraries.