Package org.apache.pekko.event

Class Logging$

java.lang.Object

org.apache.pekko.event.Logging$

public class Logging$
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final Logging$	MODULE$	Static reference to the singleton instance of this Scala object.

Constructor Summary

Constructors

Constructor	Description
Logging$()

Method Summary

Modifier and Type	Method	Description
scala.collection.immutable.Seq<Logging.LogLevel>	AllLogLevels()
DiagnosticLoggingAdapter	apply(Actor logSource)	Obtain LoggingAdapter with MDC support for the given actor.
<T> LoggingAdapter	apply(ActorSystem system, T logSource, LogSource<T> evidence$3)	Obtain LoggingAdapter for the given actor system and source object.
<T> LoggingAdapter	apply(LoggingBus bus, T logSource, LogSource<T> evidence$5)	Obtain LoggingAdapter for the given logging bus and source object.
Class<? extends Logging.LogEvent>	classFor(Logging.LogLevel level)	Returns the event class associated with the given LogLevel
final Logging.LogLevel	DebugLevel()
scala.collection.immutable.Map<String,Object>	emptyMDC()	LoggingAdapter extension which adds MDC support.
final Logging.LogLevel	ErrorLevel()
DiagnosticLoggingAdapter	getLogger(Actor logSource)	Obtain LoggingAdapter with MDC support for the given actor.
LoggingAdapter	getLogger(ActorSystem system, Object logSource)	Obtain LoggingAdapter for the given actor system and source object.
LoggingAdapter	getLogger(LoggingBus bus, Object logSource)	Obtain LoggingAdapter for the given logging bus and source object.
final Logging.LogLevel	InfoLevel()
Logging.LogLevel	levelFor(Class<? extends Logging.LogEvent> eventClass)	Returns the LogLevel associated with the given event class.
scala.Option<Logging.LogLevel>	levelFor(String s)	Returns the LogLevel associated with the given string, valid inputs are upper or lowercase (not mixed) versions of: "error", "warning", "info" and "debug"
Logging.LoggerInitialized$	loggerInitialized()
String	messageClassName(Object message)
org.apache.pekko.event.Logging.Error.NoCause$	noCause()
String	simpleName(Class<?> clazz)
String	simpleName(Object obj)
String	stackTraceFor(Throwable e)
Logging.StandardOutLogger	StandardOutLogger()
final Logging.LogLevel	WarningLevel()
DiagnosticMarkerBusLoggingAdapter	withMarker(Actor logSource)
<T> MarkerLoggingAdapter	withMarker(ActorSystem system, T logSource, LogSource<T> evidence$4)	Obtain LoggingAdapter with additional "marker" support (which some logging frameworks are able to utilise) for the given actor system and source object.
<T> MarkerLoggingAdapter	withMarker(LoggingBus bus, T logSource, LogSource<T> evidence$6)	Obtain LoggingAdapter for the given logging bus and source object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

MODULE$

public static final Logging$ MODULE$

Static reference to the singleton instance of this Scala object.

Constructor Details

Logging$

public Logging$()

Method Details

simpleName

public String simpleName(Object obj)

simpleName

public String simpleName(Class<?> clazz)

messageClassName

public String messageClassName(Object message)

ErrorLevel

public final Logging.LogLevel ErrorLevel()

WarningLevel

public final Logging.LogLevel WarningLevel()

InfoLevel

public final Logging.LogLevel InfoLevel()

DebugLevel

public final Logging.LogLevel DebugLevel()

levelFor

public scala.Option<Logging.LogLevel> levelFor(String s)

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

levelFor

public Logging.LogLevel levelFor(Class<? extends Logging.LogEvent> eventClass)

Returns the LogLevel associated with the given event class. Defaults to DebugLevel.

classFor

public Class<? extends Logging.LogEvent> classFor(Logging.LogLevel level)

Returns the event class associated with the given LogLevel

AllLogLevels

public scala.collection.immutable.Seq<Logging.LogLevel> AllLogLevels()

apply

public <T> LoggingAdapter apply(ActorSystem system,
 T logSource,
 LogSource<T> evidence$3)

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 pekko.event.LogSource for details.

You can add your own rules quite easily, see pekko.event.LogSource.

withMarker

public <T> MarkerLoggingAdapter withMarker(ActorSystem system,
 T logSource,
 LogSource<T> evidence$4)

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 pekko.event.LogSource for details.

You can add your own rules quite easily, see pekko.event.LogSource.

apply

public <T> LoggingAdapter apply(LoggingBus bus,
 T logSource,
 LogSource<T> evidence$5)

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 pekko.event.LogSource for details.

You can add your own rules quite easily, see pekko.event.LogSource.

Note that this LoggingAdapter will use the pekko.event.DefaultLoggingFilter, and not the pekko.event.LoggingFilter configured for the system (if different from DefaultLoggingFilter).

withMarker

public <T> MarkerLoggingAdapter withMarker(LoggingBus bus,
 T logSource,
 LogSource<T> evidence$6)

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 pekko.event.LogSource for details.

You can add your own rules quite easily, see pekko.event.LogSource.

Note that this LoggingAdapter will use the pekko.event.DefaultLoggingFilter, and not the pekko.event.LoggingFilter configured for the system (if different from DefaultLoggingFilter).

apply

public DiagnosticLoggingAdapter apply(Actor logSource)

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

withMarker

public DiagnosticMarkerBusLoggingAdapter withMarker(Actor logSource)

getLogger

public LoggingAdapter getLogger(ActorSystem system,
 Object logSource)

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 pekko.event.LogSource for details.

getLogger

public LoggingAdapter getLogger(LoggingBus bus,
 Object logSource)

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 pekko.event.LogSource for details.

Note that this LoggingAdapter will use the pekko.event.DefaultLoggingFilter, and not the pekko.event.LoggingFilter configured for the system (if different from DefaultLoggingFilter).

getLogger

public DiagnosticLoggingAdapter getLogger(Actor logSource)

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

noCause

public org.apache.pekko.event.Logging.Error.NoCause$ noCause()

loggerInitialized

public Logging.LoggerInitialized$ loggerInitialized()

StandardOutLogger

public Logging.StandardOutLogger StandardOutLogger()

stackTraceFor

public String stackTraceFor(Throwable e)

emptyMDC

public scala.collection.immutable.Map<String,Object> emptyMDC()

LoggingAdapter extension which adds MDC support. Only recommended to be used within Actors as it isn't thread safe.