Package com.couchbase.client.core.cnc
Interface LoggingEventConsumer.Logger
- Enclosing class:
LoggingEventConsumer
Generic logger interface.
-
Method Summary
Modifier and TypeMethodDescriptiondefault void
attachContext
(Map<String, Object> context) Writes a diagnostics key/value pair.default void
Clears the diagnostics context for this thread.void
Log a message at the DEBUG level.void
Log an exception (throwable) at the DEBUG level with an accompanying message.void
Log a message at the ERROR level.void
Log an exception (throwable) at the ERROR level with an accompanying message.getName()
Return the name of thisLogger
instance.void
Log a message at the INFO level.void
Log an exception (throwable) at the INFO level with an accompanying message.boolean
Is the logger instance enabled for the DEBUG level.boolean
Is the logger instance enabled for the ERROR level.boolean
Is the logger instance enabled for the INFO level.boolean
Is the logger instance enabled for the TRACE level.boolean
Is the logger instance enabled for the WARN level.void
Log a message at the TRACE level.void
Log an exception (throwable) at the TRACE level with an accompanying message.void
Log a message at the WARN level.void
Log an exception (throwable) at the WARN level with an accompanying message.
-
Method Details
-
getName
String getName()Return the name of thisLogger
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
Log a message at the TRACE level.- Parameters:
msg
- the message string to be logged
-
trace
Log an exception (throwable) at the TRACE level with an accompanying message.- Parameters:
msg
- the message accompanying the exceptiont
- 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
Log a message at the DEBUG level.- Parameters:
msg
- the message string to be logged
-
debug
Log an exception (throwable) at the DEBUG level with an accompanying message.- Parameters:
msg
- the message accompanying the exceptiont
- 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
Log a message at the INFO level.- Parameters:
msg
- the message string to be logged
-
info
Log an exception (throwable) at the INFO level with an accompanying message.- Parameters:
msg
- the message accompanying the exceptiont
- 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
Log a message at the WARN level.- Parameters:
msg
- the message string to be logged
-
warn
Log an exception (throwable) at the WARN level with an accompanying message.- Parameters:
msg
- the message accompanying the exceptiont
- 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
Log a message at the ERROR level.- Parameters:
msg
- the message string to be logged
-
error
Log an exception (throwable) at the ERROR level with an accompanying message.- Parameters:
msg
- the message accompanying the exceptiont
- the exception (throwable) to log
-
attachContext
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.
-