Class Logging
- java.lang.Object
-
- org.apache.pekko.event.Logging
-
public class Logging extends java.lang.Object
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Logging.Debug
static class
Logging.Debug$
static class
Logging.Debug2
static class
Logging.Debug3
static class
Logging.DefaultLogger
static class
Logging.Error
static class
Logging.Error$
static class
Logging.Error2
static class
Logging.Error2$
static class
Logging.Error3
static class
Logging.Info
static class
Logging.Info$
static class
Logging.Info2
static class
Logging.Info3
static class
Logging.InitializeLogger
static class
Logging.InitializeLogger$
static interface
Logging.LogEvent
static class
Logging.LogEvent$
static class
Logging.LogEventException
static interface
Logging.LogEventWithCause
static interface
Logging.LogEventWithMarker
static class
Logging.LogExt$
static class
Logging.LoggerException
Artificial exception injected into Error events if no Throwable is supplied; used for getting a stack dump of error locations.static class
Logging.LoggerInitializationException
static class
Logging.LoggerInitialized
static class
Logging.LoggerInitialized$
static class
Logging.LogLevel
static class
Logging.LogLevel$
static class
Logging.StandardOutLogger
static interface
Logging.StdOutLogger
static class
Logging.StdOutLogger$
static class
Logging.Warning
static class
Logging.Warning$
static class
Logging.Warning2
static class
Logging.Warning3
static class
Logging.Warning4
-
Constructor Summary
Constructors Constructor Description Logging()
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static scala.collection.immutable.Seq<Logging.LogLevel>
AllLogLevels()
static DiagnosticLoggingAdapter
apply(Actor logSource)
Obtain LoggingAdapter with MDC support for the given actor.static <T> LoggingAdapter
apply(ActorSystem system, T logSource, LogSource<T> evidence$3)
Obtain LoggingAdapter for the given actor system and source object.static <T> LoggingAdapter
apply(LoggingBus bus, T logSource, LogSource<T> evidence$5)
Obtain LoggingAdapter for the given logging bus and source object.static java.lang.Class<? extends Logging.LogEvent>
classFor(Logging.LogLevel level)
Returns the event class associated with the given LogLevelstatic Logging.LogLevel
DebugLevel()
static scala.collection.immutable.Map<java.lang.String,java.lang.Object>
emptyMDC()
LoggingAdapter extension which adds MDC support.static Logging.LogLevel
ErrorLevel()
static DiagnosticLoggingAdapter
getLogger(Actor logSource)
Obtain LoggingAdapter with MDC support for the given actor.static LoggingAdapter
getLogger(ActorSystem system, java.lang.Object logSource)
Obtain LoggingAdapter for the given actor system and source object.static LoggingAdapter
getLogger(LoggingBus bus, java.lang.Object logSource)
Obtain LoggingAdapter for the given logging bus and source object.static Logging.LogLevel
InfoLevel()
static Logging.LogLevel
levelFor(java.lang.Class<? extends Logging.LogEvent> eventClass)
Returns the LogLevel associated with the given event class.static scala.Option<Logging.LogLevel>
levelFor(java.lang.String s)
static Logging.LoggerInitialized$
loggerInitialized()
static java.lang.String
messageClassName(java.lang.Object message)
static org.apache.pekko.event.Logging.Error.NoCause$
noCause()
static java.lang.String
simpleName(java.lang.Class<?> clazz)
static java.lang.String
simpleName(java.lang.Object obj)
static java.lang.String
stackTraceFor(java.lang.Throwable e)
static Logging.StandardOutLogger
StandardOutLogger()
static Logging.LogLevel
WarningLevel()
static DiagnosticMarkerBusLoggingAdapter
withMarker(Actor logSource)
static <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.static <T> MarkerLoggingAdapter
withMarker(LoggingBus bus, T logSource, LogSource<T> evidence$6)
Obtain LoggingAdapter for the given logging bus and source object.
-
-
-
Method Detail
-
simpleName
public static java.lang.String simpleName(java.lang.Object obj)
-
simpleName
public static java.lang.String simpleName(java.lang.Class<?> clazz)
-
messageClassName
public static java.lang.String messageClassName(java.lang.Object message)
-
ErrorLevel
public static final Logging.LogLevel ErrorLevel()
-
WarningLevel
public static final Logging.LogLevel WarningLevel()
-
InfoLevel
public static final Logging.LogLevel InfoLevel()
-
DebugLevel
public static final Logging.LogLevel DebugLevel()
-
levelFor
public static scala.Option<Logging.LogLevel> levelFor(java.lang.String s)
-
levelFor
public static Logging.LogLevel levelFor(java.lang.Class<? extends Logging.LogEvent> eventClass)
Returns the LogLevel associated with the given event class. Defaults to DebugLevel.
-
classFor
public static java.lang.Class<? extends Logging.LogEvent> classFor(Logging.LogLevel level)
Returns the event class associated with the given LogLevel
-
AllLogLevels
public static scala.collection.immutable.Seq<Logging.LogLevel> AllLogLevels()
-
apply
public static <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 useLogging(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 static <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 useLogging(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 static <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 thepekko.event.DefaultLoggingFilter
, and not thepekko.event.LoggingFilter
configured for the system (if different fromDefaultLoggingFilter
).
-
withMarker
public static <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 thepekko.event.DefaultLoggingFilter
, and not thepekko.event.LoggingFilter
configured for the system (if different fromDefaultLoggingFilter
).
-
apply
public static 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 static DiagnosticMarkerBusLoggingAdapter withMarker(Actor logSource)
-
getLogger
public static LoggingAdapter getLogger(ActorSystem system, java.lang.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 useLogging.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 static LoggingAdapter getLogger(LoggingBus bus, java.lang.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 thepekko.event.DefaultLoggingFilter
, and not thepekko.event.LoggingFilter
configured for the system (if different fromDefaultLoggingFilter
).
-
getLogger
public static 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 static org.apache.pekko.event.Logging.Error.NoCause$ noCause()
-
loggerInitialized
public static Logging.LoggerInitialized$ loggerInitialized()
-
StandardOutLogger
public static Logging.StandardOutLogger StandardOutLogger()
-
stackTraceFor
public static java.lang.String stackTraceFor(java.lang.Throwable e)
-
emptyMDC
public static scala.collection.immutable.Map<java.lang.String,java.lang.Object> emptyMDC()
LoggingAdapter extension which adds MDC support. Only recommended to be used within Actors as it isn't thread safe.
-
-