Logging
Main entry point for Akka logging: log levels and message types (aka channels) defined for the main transport medium, the main event bus. The recommended use is to obtain an implementation of the Logging trait with suitable and efficient methods for generating log events:
val log = Logging(<bus>, <source object>)
...
log.info("hello world!")
The source object is used in two fashions: its Class[_]
will be part of
all log events produced by this logger, plus a string representation is
generated which may contain per-instance information, see apply
or create
below.
Loggers are attached to the level-specific channels Error
,
Warning
, Info
and Debug
as
appropriate for the configured (or set) log level. If you want to implement
your own, make sure to handle these four event types plus the InitializeLogger
message which is sent before actually attaching it to the logging bus.
Logging is configured by setting (some of) the following:
akka {
loggers = ["akka.slf4j.Slf4jLogger"] # for example
loglevel = "INFO" # used when normal logging ("loggers") has been started
stdout-loglevel = "WARN" # used during application start-up until normal logging is available
}
- Source:
- Logging.scala
Type members
Classlikes
For DEBUG Logging
For DEBUG Logging
- Companion:
- object
- Source:
- Logging.scala
- Source:
- Logging.scala
Actor wrapper around the standard output logger. If
akka.loggers
is not set, it defaults to just this
logger.
Actor wrapper around the standard output logger. If
akka.loggers
is not set, it defaults to just this
logger.
- Source:
- Logging.scala
For ERROR Logging
For ERROR Logging
- Companion:
- object
- Source:
- Logging.scala
For INFO Logging
For INFO Logging
- Companion:
- object
- Source:
- Logging.scala
- Source:
- Logging.scala
Message which is sent to each default logger (i.e. from configuration file) after its creation but before attaching it to the logging bus. The logger actor must handle this message, it can be used e.g. to register for more channels. When done, the logger must respond with a LoggerInitialized message. This is necessary to ensure that additional subscriptions are in effect when the logging system finished starting.
Message which is sent to each default logger (i.e. from configuration file) after its creation but before attaching it to the logging bus. The logger actor must handle this message, it can be used e.g. to register for more channels. When done, the logger must respond with a LoggerInitialized message. This is necessary to ensure that additional subscriptions are in effect when the logging system finished starting.
- Source:
- Logging.scala
INTERNAL API, Marker interface for LogEvents containing Markers, which can be set for example on an slf4j logger
INTERNAL API, Marker interface for LogEvents containing Markers, which can be set for example on an slf4j logger
- Source:
- Logging.scala
Marker trait for annotating LogLevel, which must be Int after erasure.
Marker trait for annotating LogLevel, which must be Int after erasure.
- Source:
- Logging.scala
Artificial exception injected into Error events if no Throwable is supplied; used for getting a stack dump of error locations.
Artificial exception injected into Error events if no Throwable is supplied; used for getting a stack dump of error locations.
- Source:
- Logging.scala
LoggerInitializationException is thrown to indicate that there was a problem initializing a logger
LoggerInitializationException is thrown to indicate that there was a problem initializing a logger
- Source:
- Logging.scala
Response message each logger must send within 1 second after receiving the InitializeLogger request. If initialization takes longer, send the reply as soon as subscriptions are set-up.
Response message each logger must send within 1 second after receiving the InitializeLogger request. If initialization takes longer, send the reply as soon as subscriptions are set-up.
- Companion:
- object
- Source:
- Logging.scala
Actor-less logging implementation for synchronous logging to standard
output. This logger is always attached first in order to be able to log
failures during application start-up, even before normal logging is
started. Its log level can be defined by configuration setting
akka.stdout-loglevel
.
Actor-less logging implementation for synchronous logging to standard
output. This logger is always attached first in order to be able to log
failures during application start-up, even before normal logging is
started. Its log level can be defined by configuration setting
akka.stdout-loglevel
.
- Source:
- Logging.scala
For WARNING Logging
For WARNING Logging
- Companion:
- object
- Source:
- Logging.scala
- Source:
- Logging.scala
- Source:
- Logging.scala
Types
Value members
Concrete methods
Obtain LoggingAdapter for the given actor system and source object. This will use the system’s event stream and include the system’s address in the log source string.
Obtain LoggingAdapter for the given actor system and source object. This will use the system’s event stream and include the system’s address in the log source string.
Do not use this if you want to supply a log category string (like
“com.example.app.whatever”) unaltered, supply system.eventStream
in this
case or use
Logging(system, this.getClass)
The source is used to identify the source of this logging channel and must have a corresponding implicit LogSource[T] instance in scope; by default these are provided for Class[_], Actor, ActorRef and String types. See the companion object of akka.event.LogSource for details.
You can add your own rules quite easily, see akka.event.LogSource.
- Source:
- Logging.scala
Obtain LoggingAdapter for the given logging bus and source object.
Obtain LoggingAdapter for the given logging bus and source object.
The source is used to identify the source of this logging channel and must have a corresponding implicit LogSource[T] instance in scope; by default these are provided for Class[_], Actor, ActorRef and String types. See the companion object of akka.event.LogSource for details.
You can add your own rules quite easily, see akka.event.LogSource.
Note that this LoggingAdapter
will use the akka.event.DefaultLoggingFilter,
and not the akka.event.LoggingFilter configured for the system
(if different from DefaultLoggingFilter
).
- Source:
- Logging.scala
Obtain LoggingAdapter with MDC support for the given actor. Don't use it outside its specific Actor as it isn't thread safe
Obtain LoggingAdapter with MDC support for the given actor. Don't use it outside its specific Actor as it isn't thread safe
- Source:
- Logging.scala
Returns the event class associated with the given LogLevel
Returns the event class associated with the given LogLevel
- Source:
- Logging.scala
Obtain LoggingAdapter for the given actor system and source object. This will use the system’s event stream and include the system’s address in the log source string.
Obtain LoggingAdapter for the given actor system and source object. This will use the system’s event stream and include the system’s address in the log source string.
Do not use this if you want to supply a log category string (like
“com.example.app.whatever”) unaltered, supply system.eventStream
in this
case or use
Logging.getLogger(system, this.getClass());
The source is used to identify the source of this logging channel and must have a corresponding implicit LogSource[T] instance in scope; by default these are provided for Class[_], Actor, ActorRef and String types. See the companion object of akka.event.LogSource for details.
- Source:
- Logging.scala
Obtain LoggingAdapter for the given logging bus and source object.
Obtain LoggingAdapter for the given logging bus and source object.
The source is used to identify the source of this logging channel and must have a corresponding implicit LogSource[T] instance in scope; by default these are provided for Class[_], Actor, ActorRef and String types. See the companion object of akka.event.LogSource for details.
Note that this LoggingAdapter
will use the akka.event.DefaultLoggingFilter,
and not the akka.event.LoggingFilter configured for the system
(if different from DefaultLoggingFilter
).
- Source:
- Logging.scala
Obtain LoggingAdapter with MDC support for the given actor. Don't use it outside its specific Actor as it isn't thread safe
Obtain LoggingAdapter with MDC support for the given actor. Don't use it outside its specific Actor as it isn't thread safe
- Source:
- Logging.scala
Returns the LogLevel associated with the given string, valid inputs are upper or lowercase (not mixed) versions of: "error", "warning", "info" and "debug"
Returns the LogLevel associated with the given string, valid inputs are upper or lowercase (not mixed) versions of: "error", "warning", "info" and "debug"
- Source:
- Logging.scala
Returns the LogLevel associated with the given event class. Defaults to DebugLevel.
Returns the LogLevel associated with the given event class. Defaults to DebugLevel.
- Source:
- Logging.scala
Java API to create a LoggerInitialized message.
Java API to create a LoggerInitialized message.
- Source:
- Logging.scala
Class name representation of a message.
ActorSelectionMessage
representation includes class name of
wrapped message.
Class name representation of a message.
ActorSelectionMessage
representation includes class name of
wrapped message.
- Source:
- Logging.scala
Returns a 'safe' getSimpleName for the provided object's Class
Returns a 'safe' getSimpleName for the provided object's Class
- Returns:
the simple name of the given object's Class
- Source:
- Logging.scala
Returns a 'safe' getSimpleName for the provided Class
Returns a 'safe' getSimpleName for the provided Class
- Returns:
the simple name of the given Class
- Source:
- Logging.scala
Returns the StackTrace for the given Throwable as a String
Returns the StackTrace for the given Throwable as a String
- Source:
- Logging.scala
Obtain LoggingAdapter with additional "marker" support (which some logging frameworks are able to utilise) for the given actor system and source object. This will use the system’s event stream and include the system’s address in the log source string.
Obtain LoggingAdapter with additional "marker" support (which some logging frameworks are able to utilise) for the given actor system and source object. This will use the system’s event stream and include the system’s address in the log source string.
Do not use this if you want to supply a log category string (like
“com.example.app.whatever”) unaltered, supply system.eventStream
in this
case or use
Logging(system, this.getClass)
The source is used to identify the source of this logging channel and must have a corresponding implicit LogSource[T] instance in scope; by default these are provided for Class[_], Actor, ActorRef and String types. See the companion object of akka.event.LogSource for details.
You can add your own rules quite easily, see akka.event.LogSource.
- Source:
- Logging.scala
Obtain LoggingAdapter for the given logging bus and source object.
Obtain LoggingAdapter for the given logging bus and source object.
The source is used to identify the source of this logging channel and must have a corresponding implicit LogSource[T] instance in scope; by default these are provided for Class[_], Actor, ActorRef and String types. See the companion object of akka.event.LogSource for details.
You can add your own rules quite easily, see akka.event.LogSource.
Note that this LoggingAdapter
will use the akka.event.DefaultLoggingFilter,
and not the akka.event.LoggingFilter configured for the system
(if different from DefaultLoggingFilter
).
- Source:
- Logging.scala
Obtain LoggingAdapter with marker and MDC support for the given actor. Don't use it outside its specific Actor as it isn't thread safe
Obtain LoggingAdapter with marker and MDC support for the given actor. Don't use it outside its specific Actor as it isn't thread safe
- Source:
- Logging.scala
Concrete fields
Log level in numeric form, used when deciding whether a certain log statement should generate a log event. Predefined levels are ErrorLevel (1) to DebugLevel (4). In case you want to add more levels, loggers need to be subscribed to their event bus channels manually.
Log level in numeric form, used when deciding whether a certain log statement should generate a log event. Predefined levels are ErrorLevel (1) to DebugLevel (4). In case you want to add more levels, loggers need to be subscribed to their event bus channels manually.
- Source:
- Logging.scala