org.sonar.api.utils.log.Logger Maven / Gradle / Ivy
Show all versions of sonar-plugin-api Show documentation
/*
* Sonar Plugin API
* Copyright (C) 2009-2022 SonarSource SA
* mailto:info AT sonarsource DOT com
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 3 of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program; if not, write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
package org.sonar.api.utils.log;
import java.util.function.Supplier;
import javax.annotation.Nullable;
/**
* 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 {@link java.util.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 {@link org.sonar.api.utils.log.LogTester} for testing facilities.
* @since 5.1
*/
public interface Logger {
boolean isTraceEnabled();
/**
* 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.
*/
void trace(String msg);
/**
* Logs a TRACE message, which is only to be constructed if the logging level
* is such that the message will actually be logged.
*
* 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.
* @param msgSupplier A function, which when called, produces the desired log message
* @since 6.3
*/
default void trace(Supplier msgSupplier) {
if (isTraceEnabled()) {
trace(msgSupplier.get());
}
}
/**
* Logs an TRACE parameterized message according to the specified format and argument. Example:
* trace("Value is {}", value)
*
* 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.
*/
void trace(String pattern, @Nullable Object arg);
/**
* Logs an TRACE parameterized message according to the specified format and arguments. Example:
* trace("Values are {} and {}", value1, value2)
*
* 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.
*/
void trace(String msg, @Nullable Object arg1, @Nullable Object arg2);
/**
* Logs an TRACE parameterized message according to the specified format and arguments. Example:
* trace("Values are {} and {}", value1, value2)
*
* 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.
*
* This variant incurs the hidden cost of creating an Object[] before invoking the method.
* The variants taking one and two arguments exist solely in order to avoid this hidden cost. See
* {@link #trace(String, Object)} and {@link #trace(String, Object, Object)}
*/
void trace(String msg, Object... args);
boolean isDebugEnabled();
/**
* Logs a DEBUG message.
*
* DEBUG messages must
* be valuable for diagnosing production problems. They must not be used for development debugging.
*/
void debug(String msg);
/**
* Logs a DEBUG message which is only to be constructed if the logging level
* is such that the message will actually be logged.
*
* DEBUG messages must
* be valuable for diagnosing production problems. They must not be used for development debugging.
* @param msgSupplier A function, which when called, produces the desired log message
* @since 6.3
*/
default void debug(Supplier msgSupplier) {
if (isDebugEnabled()) {
debug(msgSupplier.get());
}
}
/**
* Logs an DEBUG parameterized message according to the specified format and argument. Example:
* debug("Value is {}", value)
*
* Debug messages must
* be valuable for diagnosing production problems. They must not be used for development debugging.
*/
void debug(String pattern, @Nullable Object arg);
/**
* Logs an DEBUG parameterized message according to the specified format and arguments. Example:
* debug("Values are {} and {}", value1, value2)
*
* Debug messages must
* be valuable for diagnosing production problems. They must not be used for development debugging.
*/
void debug(String msg, @Nullable Object arg1, @Nullable Object arg2);
/**
* Logs an DEBUG parameterized message according to the specified format and arguments. Example:
* debug("Values are {}, {} and {}", value1, value2, value3)
*
* Debug messages must
* be valuable for diagnosing production problems. They must not be used for development debugging.
* *
* This variant incurs the hidden cost of creating an Object[] before invoking the method.
* The variants taking one and two arguments exist solely in order to avoid this hidden cost. See
* {@link #debug(String, Object)} and {@link #debug(String, Object, Object)}
*/
void debug(String msg, Object... args);
/**
* Logs an INFO level message.
*/
void info(String msg);
/**
* Logs an INFO parameterized message according to the specified format and argument. Example:
* info("Value is {}", value)
*/
void info(String msg, @Nullable Object arg);
/**
* Logs an INFO parameterized message according to the specified format and arguments. Example:
* info("Values are {} and {}", value1, value2)
*/
void info(String msg, @Nullable Object arg1, @Nullable Object arg2);
/**
* Logs an INFO parameterized message according to the specified format and arguments. Example:
* info("Values are {}, {} and {}", value1, value2, value3)
*
* This variant incurs the hidden cost of creating an Object[] before invoking the method.
* The variants taking one and two arguments exist solely in order to avoid this hidden cost. See
* {@link #info(String, Object)} and {@link #info(String, Object, Object)}
*/
void info(String msg, Object... args);
/**
* Logs a WARN level message.
*/
void warn(String msg);
/**
* Logs an exception at the WARN level with an accompanying message.
*/
void warn(String msg, Throwable throwable);
/**
* Logs a WARN parameterized message according to the specified format and argument. Example:
* warn("Value is {}", value)
*/
void warn(String msg, @Nullable Object arg);
/**
* Logs a WARN parameterized message according to the specified format and arguments. Example:
* warn("Values are {} and {}", value1, value2)
*/
void warn(String msg, @Nullable Object arg1, @Nullable Object arg2);
/**
* Logs a WARN parameterized message according to the specified format and arguments. Example:
* warn("Values are {}, {} and {}", value1, value2, value3)
*
* This variant incurs the hidden cost of creating an Object[] before invoking the method.
* The variants taking one and two arguments exist solely in order to avoid this hidden cost. See
* {@link #warn(String, Object)} and {@link #warn(String, Object, Object)}
*/
void warn(String msg, Object... args);
/**
* Logs an ERROR level message.
*/
void error(String msg);
/**
* Logs an ERROR parameterized message according to the specified format and argument. Example:
* error("Value is {}", value)
*/
void error(String msg, @Nullable Object arg);
/**
* Logs a ERROR parameterized message according to the specified format and arguments. Example:
* error("Values are {} and {}", value1, value2)
*/
void error(String msg, @Nullable Object arg1, @Nullable Object arg2);
/**
* Logs a ERROR parameterized message according to the specified format and arguments. Example:
* error("Values are {}, {} and {}", value1, value2, value3)
*
* This variant incurs the hidden cost of creating an Object[] before invoking the method.
* The variants taking one and two arguments exist solely in order to avoid this hidden cost. See
* {@link #error(String, Object)} and {@link #error(String, Object, Object)}
*/
void error(String msg, Object... args);
/**
* Logs an exception at the ERROR level with an accompanying message.
*/
void error(String msg, Throwable thrown);
/**
* 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
* {@link org.sonar.api.utils.log.LogTester#setLevel(LoggerLevel)} instead.
*
* The standard use-case is to customize logging of embedded 3rd-party
* libraries.
*/
boolean setLevel(LoggerLevel level);
LoggerLevel getLevel();
}