o

akka.event

Logging

object 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
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Logging
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

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

    For DEBUG Logging

  2. class Debug2 extends Debug
  3. class Debug3 extends Debug2 with LogEventWithMarker
  4. 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.

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

    For ERROR Logging

  6. class Error2 extends Error
  7. class Error3 extends Error2 with LogEventWithMarker
  8. case class Info(logSource: String, logClass: Class[_], message: Any = "") extends LogEvent with Product with Serializable

    For INFO Logging

  9. class Info2 extends Info
  10. class Info3 extends Info2 with LogEventWithMarker
  11. 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.

  12. sealed trait LogEvent extends NoSerializationVerificationNeeded

    Base type of LogEvents

  13. class LogEventException extends Throwable with NoStackTrace

    Exception that wraps a LogEvent.

  14. trait LogEventWithCause extends AnyRef
  15. sealed trait LogEventWithMarker extends LogEvent

    INTERNAL API, Marker interface for LogEvents containing Markers, which can be set for example on an slf4j logger

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

    Marker trait for annotating LogLevel, which must be Int after erasure.

  17. class LoggerException extends AkkaException

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

  18. class LoggerInitializationException extends AkkaException

    LoggerInitializationException is thrown to indicate that there was a problem initializing a logger

  19. 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.

  20. type MDC = Map[String, Any]
  21. 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.

  22. trait StdOutLogger extends AnyRef
  23. case class Warning(logSource: String, logClass: Class[_], message: Any = "") extends LogEvent with Product with Serializable

    For WARNING Logging

  24. class Warning2 extends Warning
  25. class Warning3 extends Warning2 with LogEventWithMarker
  26. class Warning4 extends Warning2 with LogEventWithMarker with LogEventWithCause

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. val AllLogLevels: Seq[LogLevel]
  5. final val DebugLevel: LogLevel
  6. 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.

  7. final val InfoLevel: LogLevel
  8. val StandardOutLogger: StandardOutLogger
  9. final val WarningLevel: LogLevel
  10. 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

  11. 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).

  12. 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.

  13. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  14. def classFor(level: LogLevel): Class[_ <: LogEvent]

    Returns the event class associated with the given LogLevel

  15. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate() @throws( ... )
  16. val emptyMDC: MDC
  17. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  19. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  20. 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

  21. 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).

  22. 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.

  23. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  24. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  25. 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.

  26. 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"

  27. def loggerInitialized(): LoggerInitialized.type

    Java API to create a LoggerInitialized message.

  28. 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.

  29. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  30. def noCause: NoCause.type
  31. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  32. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  33. 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

  34. 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

  35. def stackTraceFor(e: Throwable): String

    Returns the StackTrace for the given Throwable as a String

  36. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  37. def toString(): String
    Definition Classes
    AnyRef → Any
  38. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  39. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  40. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  41. 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

  42. 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).

  43. 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.

  44. object Debug extends Serializable
  45. object Error extends Serializable
  46. object Info extends Serializable
  47. object LogEvent
  48. object LoggerInitialized extends LoggerInitialized with Product with Serializable
  49. object StdOutLogger
  50. object Warning extends Serializable

Deprecated Value Members

  1. 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.

  2. 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.

Inherited from AnyRef

Inherited from Any

Ungrouped