package logging
The package for the logging API.
- Alphabetic
- By Inheritance
- logging
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Type Members
-
trait
ActorLogging
extends Actor
This trait should be included in Akka Actors to enable logging.
This trait should be included in Akka Actors to enable logging. Click the visibility All button to see protected members that are defined here. You might also want to un-click the Actor button.
-
trait
AltActorLogging
extends Actor
This trait should be included in Akka Actors to enable logging in cases where the Akka logger is also being used.
This trait should be included in Akka Actors to enable logging in cases where the Akka logger is also being used. It uses the name altLog instead of log to avoid this name conflict. Click the visibility All button to see protected members that are defined here. You might also want to un-click the Actor button.
-
sealed
trait
AnyId
extends AnyRef
The trait for logging ids.
The trait for logging ids. It can be either a RequestId io a specific request or NoId when there is no associated request.
-
trait
ClassLogging
extends AnyRef
This trait should be included in Scala (non-actor) classes to enable logging.
This trait should be included in Scala (non-actor) classes to enable logging. Click the visibility All button to see protected members that are defined here.
-
class
FileAppender
extends LogAppender
An appender that writes log messages to files.
-
trait
LogAppender
extends AnyRef
Trait for log appender classes.
-
trait
LogAppenderBuilder
extends AnyRef
Trait for log appender companion objects.
-
class
Logger
extends AnyRef
This class provides the methods needed for logging.
This class provides the methods needed for logging. It is accessed by including one of the traits ClassSupport or ActorSupport.
-
case class
LoggingSystem
(system: ActorSystem, serviceName: String, serviceVersion: String, host: String, appenderBuilders: Seq[LogAppenderBuilder] = Seq(StdOutAppender, FileAppender)) extends ClassLogging with Product with Serializable
- system
the actor system.
- serviceName
name of the service (to log).
- serviceVersion
version of the service (to log).
- host
host name (to log).
- appenderBuilders
optional sequence of log appenders to use. Default is to use built-in stdout and file appenders.
-
case class
RequestId
(trackingId: String = UUID.randomUUID().toString, spanId: String = "", level: Option[Level] = None) extends AnyId with Product with Serializable
The logging id of a specific request.
The logging id of a specific request.
- trackingId
the global unique id of the request. Optional: A new unique id will be created if this is not specified.
- spanId
a sub-id used when a a service is called multiple times for the same global request. Optional: defaults to 0.
- level
a field for controlling per request log levels. Optional, defaults to no per request control.
-
class
RichException
extends Exception
The common parent of all rich exceptions.
-
type
RichMsg = Any
The type for rich messages.
The type for rich messages. This can be a String or Map[String,String] See the project README file for other options.
-
case class
SourceLocation
(fileName: String, packageName: String, className: String, line: Int) extends Product with Serializable
A position in a Scala source file.
A position in a Scala source file.
- fileName
the name of the file.
- packageName
the package.
- className
the name of the enclosing class.
- line
a line number.
-
class
StdOutAppender
extends LogAppender
A log appender that write common log messages to stdout.
-
trait
Timing
extends AnyRef
Include this trait in classes you want to time.
Value Members
-
val
noException: Exception
Marker to indicate no exception is present
-
def
richToString(m: RichMsg): String
Convert a rich message to a printable string.
Convert a rich message to a printable string.
- m
the rich message.
- returns
a string that shows the message contents.
- implicit macro def sourceLocation: () ⇒ SourceLocation
- def sourceLocationMacro(c: Context): scala.reflect.macros.whitebox.Context.Expr[() ⇒ SourceLocation]
-
object
FileAppender
extends LogAppenderBuilder
Companion object for FileAppender class.
- object LoggingLevels
-
object
RichException
extends Serializable
This companion object for the RichException class.
This companion object for the RichException class. You might want to turn off Throwable methods.
-
object
StdOutAppender
extends LogAppenderBuilder
Companion object for the StdOutAppender class.
-
object
noId
extends AnyId with Product with Serializable
The id value used in logging calls when there is no associated request.