• Home
• com.avast
• slog4s-api_2.13
• 0.6.5
• source code
• LogBuilder.scala

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

slog4s.LogBuilder.scala Maven / Gradle / Ivy

package slog4s

import cats.Applicative

/** A part of logging API for a specific logging level. This trait is used to
  * build a list of structured argument to be used for current logging
  * statement.
  * @tparam F
  */
trait LogBuilder[F[_]] {

  /** Log simple message with no exception.
    * @param msg
    *   message to be logged
    * @return
    */
  def log(msg: String)(implicit location: Location): F[Unit]

  /** Log simple message with an exception.
    * @param msg
    *   message to be logged
    * @param ex
    *   exception to be logged
    * @return
    */
  def log(ex: Throwable, msg: String)(implicit location: Location): F[Unit]

  /** Extends current logging statement with structured data.
    * @param key
    *   name of the argument
    * @param value
    *   value to be used as structured argument
    * @tparam T
    *   type of structured argument. It needs to implement [[LogEncoder]]
    *   typeclass.
    * @return
    *   a new [[LogBuilder]] instance containing provided structured argument
    */
  def withArg[T: LogEncoder](key: String, value: => T): LogBuilder[F]
}

object LogBuilder {
  def noop[F[_]](implicit F: Applicative[F]): LogBuilder[F] =
    new LogBuilder[F] {
      override def log(msg: String)(implicit location: Location): F[Unit] =
        F.unit
      override def log(ex: Throwable, msg: String)(implicit
          location: Location
      ): F[Unit] = F.unit
      override def withArg[T: LogEncoder](
          key: String,
          value: => T
      ): LogBuilder[F] = this
    }
}