Logging

Type Members

case class Debug(logSource: String, logClass: Class[_], message: Any = "") extends LogEvent with Product with Serializable

For DEBUG Logging
class Debug2 extends Debug
class Debug3 extends Debug2 with LogEventWithMarker
class DefaultLogger extends Actor with StdOutLogger with RequiresMessageQueue[LoggerMessageQueueSemantics]

Actor wrapper around the standard output logger.
Actor wrapper around the standard output logger. If akka.loggers is not set, it defaults to just this logger.
case class Error(cause: Throwable, logSource: String, logClass: Class[_], message: Any = "") extends LogEvent with Product with Serializable

For ERROR Logging
class Error2 extends Error
class Error3 extends Error2 with LogEventWithMarker
case class Info(logSource: String, logClass: Class[_], message: Any = "") extends LogEvent with Product with Serializable

For INFO Logging
class Info2 extends Info
class Info3 extends Info2 with LogEventWithMarker
final case class InitializeLogger(bus: LoggingBus) extends NoSerializationVerificationNeeded with Product with Serializable

Message which is sent to each default logger (i.e.
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.
sealed trait LogEvent extends NoSerializationVerificationNeeded

Base type of LogEvents
class LogEventException extends Throwable with NoStackTrace

Exception that wraps a LogEvent.
sealed trait LogEventWithMarker extends LogEvent

INTERNAL API, Marker interface for LogEvents containing Markers, which can be set for example on an slf4j logger
final case class LogLevel(asInt: Int) extends AnyVal with Product with Serializable

Marker trait for annotating LogLevel, which must be Int after erasure.
class LoggerException extends AkkaException

Artificial exception injected into Error events if no Throwable is supplied; used for getting a stack dump of error locations.
class LoggerInitializationException extends AkkaException

LoggerInitializationException is thrown to indicate that there was a problem initializing a logger
abstract class LoggerInitialized extends AnyRef

Response message each logger must send within 1 second after receiving the InitializeLogger request.
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.
type MDC = Map[String, Any]
class StandardOutLogger extends InternalActorRef with MinimalActorRef with StdOutLogger

Actor-less logging implementation for synchronous logging to standard output.
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.
trait StdOutLogger extends AnyRef
case class Warning(logSource: String, logClass: Class[_], message: Any = "") extends LogEvent with Product with Serializable

For WARNING Logging
class Warning2 extends Warning
class Warning3 extends Warning2 with LogEventWithMarker

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
val AllLogLevels: Seq[LogLevel]
object Debug extends Serializable
final val DebugLevel: LogLevel
object Error extends Serializable
final val ErrorLevel: LogLevel

Log level in numeric form, used when deciding whether a certain log statement should generate a log event.
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.
object Info extends Serializable
final val InfoLevel: LogLevel
object LogEvent
object LoggerInitialized extends LoggerInitialized with Product with Serializable
val StandardOutLogger: StandardOutLogger
object StdOutLogger
object Warning extends Serializable
final val WarningLevel: LogLevel
def apply(logSource: Actor): DiagnosticLoggingAdapter

Obtain LoggingAdapter with MDC support for the given actor.
Obtain LoggingAdapter with MDC support for the given actor. Don't use it outside its specific Actor as it isn't thread safe
def apply[T](bus: LoggingBus, logSource: T)(implicit arg0: LogSource[T]): LoggingAdapter

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).
def apply[T](system: ActorSystem, logSource: T)(implicit arg0: LogSource[T]): LoggingAdapter

Obtain LoggingAdapter for the given actor system and source object.
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.
final def asInstanceOf[T0]: T0

Definition Classes
Any
def classFor(level: LogLevel): Class[_ <: LogEvent]

Returns the event class associated with the given LogLevel
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@HotSpotIntrinsicCandidate() @throws( ... )
val emptyMDC: MDC
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
Annotations
@HotSpotIntrinsicCandidate()
def getLogger(logSource: Actor): DiagnosticLoggingAdapter

Obtain LoggingAdapter with MDC support for the given actor.
Obtain LoggingAdapter with MDC support for the given actor. Don't use it outside its specific Actor as it isn't thread safe
def getLogger(bus: LoggingBus, logSource: AnyRef): LoggingAdapter

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).
def getLogger(system: ActorSystem, logSource: AnyRef): LoggingAdapter

Obtain LoggingAdapter for the given actor system and source object.
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.
def hashCode(): Int

Definition Classes
AnyRef → Any
Annotations
@HotSpotIntrinsicCandidate()
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def levelFor(eventClass: Class[_ <: LogEvent]): LogLevel

Returns the LogLevel associated with the given event class.
Returns the LogLevel associated with the given event class. Defaults to DebugLevel.
def levelFor(s: String): Option[LogLevel]

Returns the LogLevel associated with the given string, valid inputs are upper or lowercase (not mixed) versions of: "error", "warning", "info" and "debug"
def loggerInitialized(): LoggerInitialized.type

Java API to create a LoggerInitialized message.
def messageClassName(message: Any): String

Class name representation of a message.
Class name representation of a message. ActorSelectionMessage representation includes class name of wrapped message.
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def noCause: NoCause.type
final def notify(): Unit

Definition Classes
AnyRef
Annotations
@HotSpotIntrinsicCandidate()
final def notifyAll(): Unit

Definition Classes
AnyRef
Annotations
@HotSpotIntrinsicCandidate()
def simpleName(clazz: Class[_]): String

Returns a 'safe' getSimpleName for the provided Class
Returns a 'safe' getSimpleName for the provided Class
returns
the simple name of the given Class
def simpleName(obj: AnyRef): String

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
def stackTraceFor(e: Throwable): String

Returns the StackTrace for the given Throwable as a String
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
def withMarker(logSource: Actor): DiagnosticMarkerBusLoggingAdapter

Obtain LoggingAdapter with marker and MDC support for the given actor.
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
def withMarker[T](bus: LoggingBus, logSource: T)(implicit arg0: LogSource[T]): MarkerLoggingAdapter

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).
def withMarker[T](system: ActorSystem, logSource: T)(implicit arg0: LogSource[T]): MarkerLoggingAdapter

Obtain LoggingAdapter with additional "marker" support (which some logging frameworks are able to utilise) for the given actor system and source object.
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.

Deprecated Value Members

def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
Deprecated
(Since version ) see corresponding Javadoc for more information.
def getLogger(logSource: UntypedActor): DiagnosticLoggingAdapter

Obtain LoggingAdapter with MDC support for the given actor.
Obtain LoggingAdapter with MDC support for the given actor. Don't use it outside its specific Actor as it isn't thread safe

Annotations
@deprecated
Deprecated
(Since version 2.5.0) Use AbstractActor instead of UntypedActor.

Related Doc: package event

object Logging

Type Members

case class Debug(logSource: String, logClass: Class[_], message: Any = "") extends LogEvent with Product with Serializable

class Debug2 extends Debug

class Debug3 extends Debug2 with LogEventWithMarker

class DefaultLogger extends Actor with StdOutLogger with RequiresMessageQueue[LoggerMessageQueueSemantics]

case class Error(cause: Throwable, logSource: String, logClass: Class[_], message: Any = "") extends LogEvent with Product with Serializable

class Error2 extends Error

class Error3 extends Error2 with LogEventWithMarker

case class Info(logSource: String, logClass: Class[_], message: Any = "") extends LogEvent with Product with Serializable

class Info2 extends Info

class Info3 extends Info2 with LogEventWithMarker

final case class InitializeLogger(bus: LoggingBus) extends NoSerializationVerificationNeeded with Product with Serializable

sealed trait LogEvent extends NoSerializationVerificationNeeded

class LogEventException extends Throwable with NoStackTrace

sealed trait LogEventWithMarker extends LogEvent

final case class LogLevel(asInt: Int) extends AnyVal with Product with Serializable

class LoggerException extends AkkaException

class LoggerInitializationException extends AkkaException

abstract class LoggerInitialized extends AnyRef

type MDC = Map[String, Any]

class StandardOutLogger extends InternalActorRef with MinimalActorRef with StdOutLogger

trait StdOutLogger extends AnyRef

case class Warning(logSource: String, logClass: Class[_], message: Any = "") extends LogEvent with Product with Serializable

class Warning2 extends Warning

class Warning3 extends Warning2 with LogEventWithMarker

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

val AllLogLevels: Seq[LogLevel]

object Debug extends Serializable

final val DebugLevel: LogLevel

object Error extends Serializable

final val ErrorLevel: LogLevel

object Info extends Serializable

final val InfoLevel: LogLevel

object LogEvent

object LoggerInitialized extends LoggerInitialized with Product with Serializable

val StandardOutLogger: StandardOutLogger

object StdOutLogger

object Warning extends Serializable

final val WarningLevel: LogLevel

def apply(logSource: Actor): DiagnosticLoggingAdapter

def apply[T](bus: LoggingBus, logSource: T)(implicit arg0: LogSource[T]): LoggingAdapter

def apply[T](system: ActorSystem, logSource: T)(implicit arg0: LogSource[T]): LoggingAdapter

final def asInstanceOf[T0]: T0

def classFor(level: LogLevel): Class[_ <: LogEvent]

def clone(): AnyRef

val emptyMDC: MDC

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

final def getClass(): Class[_]

def getLogger(logSource: Actor): DiagnosticLoggingAdapter

def getLogger(bus: LoggingBus, logSource: AnyRef): LoggingAdapter

def getLogger(system: ActorSystem, logSource: AnyRef): LoggingAdapter

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

def levelFor(eventClass: Class[_ <: LogEvent]): LogLevel

def levelFor(s: String): Option[LogLevel]

def loggerInitialized(): LoggerInitialized.type

def messageClassName(message: Any): String

final def ne(arg0: AnyRef): Boolean

def noCause: NoCause.type

final def notify(): Unit

final def notifyAll(): Unit

def simpleName(clazz: Class[_]): String

def simpleName(obj: AnyRef): String

def stackTraceFor(e: Throwable): String

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

def withMarker(logSource: Actor): DiagnosticMarkerBusLoggingAdapter

def withMarker[T](bus: LoggingBus, logSource: T)(implicit arg0: LogSource[T]): MarkerLoggingAdapter

def withMarker[T](system: ActorSystem, logSource: T)(implicit arg0: LogSource[T]): MarkerLoggingAdapter

Deprecated Value Members