trait ToMarkers[T] extends AnyRef

This is a type class used to convert given types to Markers.

Markers are very useful for structured logging, because they can be converted into key/value pairs without altering the structure of a message or keeping the ordering in arguments (especially since an exception must be at the end of the tail).

The API does not define type class instances in this layer, but the logstash package provides many useful mappings to Markers.

case class Person(name: String, age: Int)
implicit val personToMarkers: ToMarkers[Person] = ToMarkers { person =>
  val personObj = bobj("name" -> person.name)
  Markers(personObj)
}
T

the type to convert to Markers

Source
ToMarkers.scala
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ToMarkers
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def toMarkers(instance: T): Markers

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from ToMarkers[T] toany2stringadd[ToMarkers[T]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (ToMarkers[T], B)
    Implicit
    This member is added by an implicit conversion from ToMarkers[T] toArrowAssoc[ToMarkers[T]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  8. def ensuring(cond: (ToMarkers[T]) => Boolean, msg: => Any): ToMarkers[T]
    Implicit
    This member is added by an implicit conversion from ToMarkers[T] toEnsuring[ToMarkers[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (ToMarkers[T]) => Boolean): ToMarkers[T]
    Implicit
    This member is added by an implicit conversion from ToMarkers[T] toEnsuring[ToMarkers[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: => Any): ToMarkers[T]
    Implicit
    This member is added by an implicit conversion from ToMarkers[T] toEnsuring[ToMarkers[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): ToMarkers[T]
    Implicit
    This member is added by an implicit conversion from ToMarkers[T] toEnsuring[ToMarkers[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  14. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from ToMarkers[T] toStringFormat[ToMarkers[T]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  15. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  21. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  22. def toString(): String
    Definition Classes
    AnyRef → Any
  23. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  24. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  25. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated
  2. def [B](y: B): (ToMarkers[T], B)
    Implicit
    This member is added by an implicit conversion from ToMarkers[T] toArrowAssoc[ToMarkers[T]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromToMarkers[T] to any2stringadd[ToMarkers[T]]

Inherited by implicit conversion StringFormat fromToMarkers[T] to StringFormat[ToMarkers[T]]

Inherited by implicit conversion Ensuring fromToMarkers[T] to Ensuring[ToMarkers[T]]

Inherited by implicit conversion ArrowAssoc fromToMarkers[T] to ArrowAssoc[ToMarkers[T]]

Ungrouped