package logging
- Alphabetic
- By Inheritance
- logging
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Type Members
-
final
case class
LogAnnotation[A](name: String, combine: (A, A) ⇒ A, render: (A) ⇒ String)(implicit evidence$1: Tag[A]) extends Product with Serializable
A
LogAnnotation
describes a particular type of statically-typed log annotation applied to log lines.A
LogAnnotation
describes a particular type of statically-typed log annotation applied to log lines. Log annotations combine in user-defined ways, which means they can have arbitrary structure. In the end, however, it must be possible to render each log annotation as a string.myEffect @@ UserId("jdoe")
- final case class LogColor extends AnyVal with Product with Serializable
-
final
case class
LogContext extends Product with Serializable
A
LogContext
stores context associated with logging operations. -
sealed
trait
LogFilter[-Message] extends AnyRef
A
LogFilter
represents function/conditions for log filtering -
trait
LogFormat extends AnyRef
A LogFormat represents a DSL to describe the format of text log messages.
A LogFormat represents a DSL to describe the format of text log messages.
import zio.logging.LogFormat._ timestamp.fixed(32) |-| level |-| label("message", quoted(line))
- trait LogGroup[-Message, Out] extends AnyRef
- trait LoggerNameExtractor extends AnyRef
Value Members
- def console(format: LogFormat, logFilter: LogFilter[String]): ZLayer[Any, Nothing, Unit]
- def console(format: LogFormat = LogFormat.colored, logLevel: LogLevel = LogLevel.Info): ZLayer[Any, Nothing, Unit]
- def consoleErr(format: LogFormat, logFilter: LogFilter[String]): ZLayer[Any, Nothing, Unit]
- def consoleErr(format: LogFormat = LogFormat.default, logLevel: LogLevel = LogLevel.Info): ZLayer[Any, Nothing, Unit]
- def consoleErrJson(format: LogFormat, logFilter: LogFilter[String]): ZLayer[Any, Nothing, Unit]
- def consoleErrJson(format: LogFormat = LogFormat.default, logLevel: LogLevel = LogLevel.Info): ZLayer[Any, Nothing, Unit]
- def consoleJson(format: LogFormat, logFilter: LogFilter[String]): ZLayer[Any, Nothing, Unit]
- def consoleJson(format: LogFormat = LogFormat.default, logLevel: LogLevel = LogLevel.Info): ZLayer[Any, Nothing, Unit]
- def file(destination: Path, format: LogFormat, logFilter: LogFilter[String], charset: Charset, autoFlushBatchSize: Int, bufferedIOSize: Option[Int]): ZLayer[Any, Nothing, Unit]
- def file(destination: Path, format: LogFormat = LogFormat.default, logLevel: LogLevel = LogLevel.Info, charset: Charset = StandardCharsets.UTF_8, autoFlushBatchSize: Int = 1, bufferedIOSize: Option[Int] = None): ZLayer[Any, Nothing, Unit]
- def fileAsync(destination: Path, format: LogFormat, logFilter: LogFilter[String], charset: Charset, autoFlushBatchSize: Int, bufferedIOSize: Option[Int]): ZLayer[Any, Nothing, Unit]
- def fileAsync(destination: Path, format: LogFormat = LogFormat.default, logLevel: LogLevel = LogLevel.Info, charset: Charset = StandardCharsets.UTF_8, autoFlushBatchSize: Int = 1, bufferedIOSize: Option[Int] = None): ZLayer[Any, Nothing, Unit]
- def fileAsyncJson(destination: Path, format: LogFormat, logFilter: LogFilter[String], charset: Charset, autoFlushBatchSize: Int, bufferedIOSize: Option[Int]): ZLayer[Any, Nothing, Unit]
- def fileAsyncJson(destination: Path, format: LogFormat = LogFormat.default, logLevel: LogLevel = LogLevel.Info, charset: Charset = StandardCharsets.UTF_8, autoFlushBatchSize: Int = 1, bufferedIOSize: Option[Int] = None): ZLayer[Any, Nothing, Unit]
- def fileJson(destination: Path, format: LogFormat, logFilter: LogFilter[String], charset: Charset, autoFlushBatchSize: Int, bufferedIOSize: Option[Int]): ZLayer[Any, Nothing, Unit]
- def fileJson(destination: Path, format: LogFormat = LogFormat.default, logLevel: LogLevel = LogLevel.Info, charset: Charset = StandardCharsets.UTF_8, autoFlushBatchSize: Int = 1, bufferedIOSize: Option[Int] = None): ZLayer[Any, Nothing, Unit]
-
val
logContext: FiberRef[LogContext]
The logContext fiber reference is used to store typed, structured log annotations, which can be utilized by backends to enrich log messages.
The logContext fiber reference is used to store typed, structured log annotations, which can be utilized by backends to enrich log messages.
Because logContext is an ordinary zio.FiberRef, it may be get, set, and updated like any other fiber reference. However, the idiomatic way to interact with logContext is by using zio.logging.LogAnnotation.
For example:
myResponseHandler(request) @@ UserId(request.userId)
This code would add the structured log annotation LogAnnotation.UserId to all log messages emitted by the
myResponseHandler(request)
effect. - val logMetrics: ZLayer[Any, Nothing, Unit]
- val removeDefaultLoggers: ZLayer[Any, Nothing, Unit]
- object LogAnnotation extends Serializable
- object LogColor extends Serializable
- object LogContext extends Serializable
- object LogFilter
- object LogFormat
- object LogGroup
- object LoggerNameExtractor