Package com.couchbase.client.core.cnc

Interface LoggingEventConsumer.Logger

Enclosing class:
LoggingEventConsumer
@Internal
public static interface LoggingEventConsumer.Logger
Generic logger interface.

  • Method Summary

    Modifier and Type Method Description
    default void attachContext​(Map<String,​Object> context)
    Writes a diagnostics key/value pair.
    default void clearContext()
    Clears the diagnostics context for this thread.
    void debug​(String msg)
    Log a message at the DEBUG level.
    void debug​(String format, Object... arguments)
    Log a message at the DEBUG level according to the specified format and arguments.
    void debug​(String msg, Throwable t)
    Log an exception (throwable) at the DEBUG level with an accompanying message.
    void error​(String msg)
    Log a message at the ERROR level.
    void error​(String format, Object... arguments)
    Log a message at the ERROR level according to the specified format and arguments.
    void error​(String msg, Throwable t)
    Log an exception (throwable) at the ERROR level with an accompanying message.
    String getName()
    Return the name of this Logger instance.
    void info​(String msg)
    Log a message at the INFO level.
    void info​(String format, Object... arguments)
    Log a message at the INFO level according to the specified format and arguments.
    void info​(String msg, Throwable t)
    Log an exception (throwable) at the INFO level with an accompanying message.
    boolean isDebugEnabled()
    Is the logger instance enabled for the DEBUG level.
    boolean isErrorEnabled()
    Is the logger instance enabled for the ERROR level.
    boolean isInfoEnabled()
    Is the logger instance enabled for the INFO level.
    boolean isTraceEnabled()
    Is the logger instance enabled for the TRACE level.
    boolean isWarnEnabled()
    Is the logger instance enabled for the WARN level.
    void trace​(String msg)
    Log a message at the TRACE level.
    void trace​(String format, Object... arguments)
    Log a message at the TRACE level according to the specified format and arguments.
    void trace​(String msg, Throwable t)
    Log an exception (throwable) at the TRACE level with an accompanying message.
    void warn​(String msg)
    Log a message at the WARN level.
    void warn​(String format, Object... arguments)
    Log a message at the WARN level according to the specified format and arguments.
    void warn​(String msg, Throwable t)
    Log an exception (throwable) at the WARN level with an accompanying message.

  • Method Details

    • getName

      String getName()
      Return the name of this Logger instance.
      Returns:
      name of this logger instance

    • isTraceEnabled

      boolean isTraceEnabled()
      Is the logger instance enabled for the TRACE level.
      Returns:
      True if this Logger is enabled for the TRACE level, false otherwise.

    • trace

      void trace​(String msg)
      Log a message at the TRACE level.
      Parameters:
      msg - the message string to be logged

    • trace

      void trace​(String format, Object... arguments)
      Log a message at the TRACE level according to the specified format and arguments.

      This form avoids superfluous string concatenation when the logger is disabled for the TRACE level. However, this variant incurs the hidden (and relatively small) cost of creating an Object[] before invoking the method, even if this logger is disabled for TRACE.

      Parameters:
      format - the format string
      arguments - a list of 3 or more arguments

    • trace

      void trace​(String msg, Throwable t)
      Log an exception (throwable) at the TRACE level with an accompanying message.
      Parameters:
      msg - the message accompanying the exception
      t - the exception (throwable) to log

    • isDebugEnabled

      boolean isDebugEnabled()
      Is the logger instance enabled for the DEBUG level.
      Returns:
      True if this Logger is enabled for the DEBUG level, false otherwise.

    • debug

      void debug​(String msg)
      Log a message at the DEBUG level.
      Parameters:
      msg - the message string to be logged

    • debug

      void debug​(String format, Object... arguments)
      Log a message at the DEBUG level according to the specified format and arguments.

      This form avoids superfluous string concatenation when the logger is disabled for the DEBUG level. However, this variant incurs the hidden (and relatively small) cost of creating an Object[] before invoking the method, even if this logger is disabled for DEBUG.

      Parameters:
      format - the format string
      arguments - a list of 3 or more arguments

    • debug

      void debug​(String msg, Throwable t)
      Log an exception (throwable) at the DEBUG level with an accompanying message.
      Parameters:
      msg - the message accompanying the exception
      t - the exception (throwable) to log

    • isInfoEnabled

      boolean isInfoEnabled()
      Is the logger instance enabled for the INFO level.
      Returns:
      True if this Logger is enabled for the INFO level, false otherwise.

    • info

      void info​(String msg)
      Log a message at the INFO level.
      Parameters:
      msg - the message string to be logged

    • info

      void info​(String format, Object... arguments)
      Log a message at the INFO level according to the specified format and arguments.

      This form avoids superfluous string concatenation when the logger is disabled for the INFO level. However, this variant incurs the hidden (and relatively small) cost of creating an Object[] before invoking the method, even if this logger is disabled for INFO.

      Parameters:
      format - the format string
      arguments - a list of 3 or more arguments

    • info

      void info​(String msg, Throwable t)
      Log an exception (throwable) at the INFO level with an accompanying message.
      Parameters:
      msg - the message accompanying the exception
      t - the exception (throwable) to log

    • isWarnEnabled

      boolean isWarnEnabled()
      Is the logger instance enabled for the WARN level.
      Returns:
      True if this Logger is enabled for the WARN level, false otherwise.

    • warn

      void warn​(String msg)
      Log a message at the WARN level.
      Parameters:
      msg - the message string to be logged

    • warn

      void warn​(String format, Object... arguments)
      Log a message at the WARN level according to the specified format and arguments.

      This form avoids superfluous string concatenation when the logger is disabled for the WARN level. However, this variant incurs the hidden (and relatively small) cost of creating an Object[] before invoking the method, even if this logger is disabled for WARN.

      Parameters:
      format - the format string
      arguments - a list of 3 or more arguments

    • warn

      void warn​(String msg, Throwable t)
      Log an exception (throwable) at the WARN level with an accompanying message.
      Parameters:
      msg - the message accompanying the exception
      t - the exception (throwable) to log

    • isErrorEnabled

      boolean isErrorEnabled()
      Is the logger instance enabled for the ERROR level.
      Returns:
      True if this Logger is enabled for the ERROR level, false otherwise.

    • error

      void error​(String msg)
      Log a message at the ERROR level.
      Parameters:
      msg - the message string to be logged

    • error

      void error​(String format, Object... arguments)
      Log a message at the ERROR level according to the specified format and arguments.

      This form avoids superfluous string concatenation when the logger is disabled for the ERROR level. However, this variant incurs the hidden (and relatively small) cost of creating an Object[] before invoking the method, even if this logger is disabled for ERROR.

      Parameters:
      format - the format string
      arguments - a list of 3 or more arguments

    • error

      void error​(String msg, Throwable t)
      Log an exception (throwable) at the ERROR level with an accompanying message.
      Parameters:
      msg - the message accompanying the exception
      t - the exception (throwable) to log

    • attachContext

      default void attachContext​(Map<String,​Object> context)
      Writes a diagnostics key/value pair.

      note that this feature might not be supported by all implementations.

      Parameters:
      context - the context to attach

    • clearContext

      default void clearContext()
      Clears the diagnostics context for this thread.

      note that this feature might not be supported by all implementations.