scribe.handler.LogHandler.scala Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of scribe_sjs1_3 Show documentation

scribe

The newest version!

package scribe.handler

import scribe.format.Formatter
import scribe.modify.{LevelFilter, LogModifier}
import scribe.output.format.OutputFormat
import scribe.writer.{ConsoleWriter, Writer}
import scribe.{Level, LogRecord}

/**
 * LogHandler is responsible for causing some side-effect with a `LogRecord`. This usually includes formatting the record
 * with a `Formatter` and writing it to a `Writer`, although some more creative implementations exist to do more advanced
 * actions. LogHandlers are added to `Logger` instances via `withHandler`, although it's usually sufficient to use the
 * `withHandler` method that takes a `Formatter` and `Writer` instead of defining a `LogHandler` manually.
 */
trait LogHandler {
  def log(record: LogRecord): Unit
}

object LogHandler {
  def apply(formatter: Formatter = Formatter.default,
            writer: Writer = ConsoleWriter,
            minimumLevel: Option[Level] = None,
            modifiers: List[LogModifier] = Nil,
            outputFormat: OutputFormat = OutputFormat.default,
            handle: LogHandle = SynchronousLogHandle): LogHandlerBuilder = {
    val mods = (minimumLevel.map(l => (LevelFilter >= l).alwaysApply).toList ::: modifiers).sortBy(_.priority)
    LogHandlerBuilder(formatter, writer, outputFormat, mods, handle)
  }

  def apply(minimumLevel: Level)(f: LogRecord => Unit): FunctionalLogHandler = {
    FunctionalLogHandler(f, List(LevelFilter >= minimumLevel))
  }
}