scribe.modify.LogModifier.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

There is a newer version: 3.15.3

package scribe.modify

import scribe.{LogRecord, Priority}

/**
 * LogModifier is attached to `Logger` instances in order to manipulate `LogRecord`s, before they are handled by a
 * `LogHandler`.
 */
trait LogModifier {
  /**
    * Represents a unique identifier for this type of modifier. This is used when adding a LogModifier to a Logger to
    * replace by type.
    */
  def id: String

  /**
   * Multiple LogModifiers attached to the same `Logger` are automatically sorted by Priority.
   */
  def priority: Priority

  /**
   * Handles modification of a LogRecord
   *
   * @param record the record to modify
   * @return Some LogRecord that should continue to propagate or None if the logging action should be canceled
   */
  def apply(record: LogRecord): Option[LogRecord]

  def withId(id: String): LogModifier

  def alwaysApply: LogModifier = withId("")
}

object LogModifier {
  implicit final val LogModifierOrdering: Ordering[LogModifier] = Ordering.by(_.priority)
}