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
}

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Logging
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Learn more about member selection
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 DefaultLogger extends Actor with StdOutLogger

    Actor wrapper around the standard output logger.

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

    For ERROR Logging

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

    For INFO Logging

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

    Message which is sent to each default logger (i.

  6. sealed trait LogEvent extends NoSerializationVerificationNeeded

    Base type of LogEvents

  7. class LogEventException extends Throwable with NoStackTrace

    Exception that wraps a LogEvent.

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

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

  9. class LoggerException extends AkkaException

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

  10. class LoggerInitializationException extends AkkaException

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

  11. abstract class LoggerInitialized extends AnyRef

    Response message each logger must send within 1 second after receiving the InitializeLogger request.

  12. class StandardOutLogger extends InternalActorRef with MinimalActorRef with StdOutLogger

    Actor-less logging implementation for synchronous logging to standard output.

  13. trait StdOutLogger extends AnyRef

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

    For WARNING Logging

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

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

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

    Definition Classes
    Any
  6. val AllLogLevels: Seq[LogLevel]

  7. final val DebugLevel: LogLevel

  8. object Error extends Serializable

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

  10. final val InfoLevel: LogLevel

  11. object LoggerInitialized extends LoggerInitialized with Product with Serializable

  12. val StandardOutLogger: StandardOutLogger

  13. final val WarningLevel: LogLevel

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

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

  16. final def asInstanceOf[T0]: T0

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

    Returns the event class associated with the given LogLevel

  18. def clone(): AnyRef

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

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

    Definition Classes
    AnyRef → Any
  21. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  22. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  23. 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.

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

  25. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  26. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  27. 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.

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

  29. def loggerInitialized(): LoggerInitialized.type

    Java API to create a LoggerInitialized message.

  30. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  31. def noCause: NoCause.type

  32. final def notify(): Unit

    Definition Classes
    AnyRef
  33. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  34. 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

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

    obj
    returns

    the simple name of the given object's Class

  36. def stackTraceFor(e: Throwable): String

    Returns the StackTrace for the given Throwable as a String

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

    Definition Classes
    AnyRef
  38. def toString(): String

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

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped