p

zio

logging

package logging

Linear Supertypes
LoggingPackagePlatformSpecific, FileLoggerLayers, LoggingPackageAllPlatforms, LoggerLayers, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. logging
  2. LoggingPackagePlatformSpecific
  3. FileLoggerLayers
  4. LoggingPackageAllPlatforms
  5. LoggerLayers
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Package Members

  1. package internal

Type Members

  1. final case class ConsoleLoggerConfig(format: LogFormat, filter: LogLevelByNameConfig) extends Product with Serializable
  2. final case class FileLoggerConfig(destination: Path, format: LogFormat, filter: LogLevelByNameConfig, charset: Charset = StandardCharsets.UTF_8, autoFlushBatchSize: Int = 1, bufferedIOSize: Option[Int] = None, rollingPolicy: Option[FileRollingPolicy] = None) extends Product with Serializable
  3. final case class FilteredLogger[Message, Output](logger: ZLogger[Message, Output], filter: LogFilter[Message]) extends ZLogger[Message, Option[Output]] with Product with Serializable
  4. 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")
  5. implicit final class LogAnnotationZIOSyntax[R, E, A] extends AnyRef
    Definition Classes
    LoggingPackageAllPlatforms
  6. final case class LogColor extends AnyVal with Product with Serializable
  7. final case class LogContext extends Product with Serializable

    A LogContext stores context associated with logging operations.

  8. sealed trait LogFilter[-Message] extends AnyRef

    A LogFilter represents function/conditions for log filtering

  9. sealed 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))
  10. sealed trait LogGroup[-Message, Out] extends AnyRef
  11. sealed trait LoggerNameExtractor extends AnyRef
  12. final case class MetricLogger(counter: Counter[Long], logLevelLabel: String) extends ZLogger[String, Unit] with Product with Serializable
  13. sealed trait ReconfigurableLogger[-Message, +Output, Config] extends ZLogger[Message, Output]
  14. implicit final class ZLoggerOps[-Message, +Output] extends AnyRef
    Definition Classes
    LoggingPackageAllPlatforms
  15. implicit final class ZLoggerZIOLayerOps[RIn, +E, ROut <: ZLogger[String, Any]] extends AnyRef
    Definition Classes
    LoggerLayers

Value Members

  1. def appendLoggerName(value: String): ZIOAspect[Nothing, Any, Nothing, Any, Nothing, Any]

    Append logger name aspect, by which it is possible to append a logger name to the current logger name.

    Append logger name aspect, by which it is possible to append a logger name to the current logger name. The new name is appended using a dot (.) as the delimiter.

    annotation key: zio.logging.loggerNameAnnotationKey

    Definition Classes
    LoggingPackageAllPlatforms
  2. def consoleErrJsonLogger(configPath: NonEmptyChunk[String] = loggerConfigPath): ZLayer[Any, Error, Unit]
    Definition Classes
    LoggerLayers
  3. def consoleErrJsonLogger(config: ConsoleLoggerConfig): ZLayer[Any, Nothing, Unit]
    Definition Classes
    LoggerLayers
  4. def consoleErrLogger(configPath: NonEmptyChunk[String] = loggerConfigPath): ZLayer[Any, Error, Unit]
    Definition Classes
    LoggerLayers
  5. def consoleErrLogger(config: ConsoleLoggerConfig): ZLayer[Any, Nothing, Unit]
    Definition Classes
    LoggerLayers
  6. def consoleJsonLogger(configPath: NonEmptyChunk[String] = loggerConfigPath): ZLayer[Any, Error, Unit]
    Definition Classes
    LoggerLayers
  7. def consoleJsonLogger(config: ConsoleLoggerConfig): ZLayer[Any, Nothing, Unit]
    Definition Classes
    LoggerLayers
  8. def consoleLogger(configPath: NonEmptyChunk[String] = loggerConfigPath): ZLayer[Any, Error, Unit]
    Definition Classes
    LoggerLayers
  9. def consoleLogger(config: ConsoleLoggerConfig): ZLayer[Any, Nothing, Unit]
    Definition Classes
    LoggerLayers
  10. def fileAsyncJsonLogger(configPath: NonEmptyChunk[String] = loggerConfigPath): ZLayer[Any, Error, Unit]
    Definition Classes
    FileLoggerLayers
  11. def fileAsyncJsonLogger(config: FileLoggerConfig): ZLayer[Any, Nothing, Unit]
    Definition Classes
    FileLoggerLayers
  12. def fileAsyncLogger(configPath: NonEmptyChunk[String] = loggerConfigPath): ZLayer[Any, Error, Unit]
    Definition Classes
    FileLoggerLayers
  13. def fileAsyncLogger(config: FileLoggerConfig): ZLayer[Any, Nothing, Unit]
    Definition Classes
    FileLoggerLayers
  14. def fileJsonLogger(configPath: NonEmptyChunk[String] = loggerConfigPath): ZLayer[Any, Error, Unit]
    Definition Classes
    FileLoggerLayers
  15. def fileJsonLogger(config: FileLoggerConfig): ZLayer[Any, Nothing, Unit]
    Definition Classes
    FileLoggerLayers
  16. def fileLogger(configPath: NonEmptyChunk[String] = loggerConfigPath): ZLayer[Any, Error, Unit]
    Definition Classes
    FileLoggerLayers
  17. def fileLogger(config: FileLoggerConfig): ZLayer[Any, Nothing, Unit]
    Definition Classes
    FileLoggerLayers
  18. 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.

    Definition Classes
    LoggingPackageAllPlatforms
  19. val logMetrics: ZLayer[Any, Nothing, Unit]
    Definition Classes
    LoggerLayers
  20. def logMetricsWith(name: String, logLevelLabel: String): ZLayer[Any, Nothing, Unit]
    Definition Classes
    LoggerLayers
  21. val loggerConfigPath: NonEmptyChunk[String]
    Definition Classes
    LoggingPackageAllPlatforms
  22. def loggerName(fn: (Option[String]) => String): ZIOAspect[Nothing, Any, Nothing, Any, Nothing, Any]

    Logger name aspect, by this aspect is possible to set logger name (in general, logger name is extracted from Trace)

    Logger name aspect, by this aspect is possible to set logger name (in general, logger name is extracted from Trace)

    annotation key: zio.logging.loggerNameAnnotationKey

    Definition Classes
    LoggingPackageAllPlatforms
  23. def loggerName(value: String): ZIOAspect[Nothing, Any, Nothing, Any, Nothing, Any]

    Logger name aspect, by this aspect is possible to set logger name (in general, logger name is extracted from Trace)

    Logger name aspect, by this aspect is possible to set logger name (in general, logger name is extracted from Trace)

    annotation key: zio.logging.loggerNameAnnotationKey

    Definition Classes
    LoggingPackageAllPlatforms
  24. val loggerNameAnnotationKey: String

    log aspect annotation key for logger name

    log aspect annotation key for logger name

    Definition Classes
    LoggingPackageAllPlatforms
  25. def makeConsoleErrJsonLogger(config: ConsoleLoggerConfig): ZIO[Any, Nothing, ZLogger[String, Any]]
    Definition Classes
    LoggerLayers
  26. def makeConsoleErrLogger(config: ConsoleLoggerConfig): ZIO[Any, Nothing, ZLogger[String, Any]]
    Definition Classes
    LoggerLayers
  27. def makeConsoleJsonLogger(config: ConsoleLoggerConfig): ZIO[Any, Nothing, ZLogger[String, Any]]
    Definition Classes
    LoggerLayers
  28. def makeConsoleLogger(config: ConsoleLoggerConfig): ZIO[Any, Nothing, ZLogger[String, Any]]
    Definition Classes
    LoggerLayers
  29. def makeFileAsyncJsonLogger(config: FileLoggerConfig): ZIO[Scope, Nothing, FilteredLogger[String, Any]]
    Definition Classes
    FileLoggerLayers
  30. def makeFileAsyncLogger(destination: Path, logger: ZLogger[String, String], charset: Charset, autoFlushBatchSize: Int, bufferedIOSize: Option[Int], rollingPolicy: Option[FileRollingPolicy]): ZIO[Scope, Nothing, ZLogger[String, Any]]
    Definition Classes
    FileLoggerLayers
  31. def makeFileAsyncLogger(config: FileLoggerConfig): ZIO[Scope, Nothing, FilteredLogger[String, Any]]
    Definition Classes
    FileLoggerLayers
  32. def makeFileJsonLogger(config: FileLoggerConfig): ZIO[Any, Nothing, FilteredLogger[String, Any]]
    Definition Classes
    FileLoggerLayers
  33. def makeFileLogger(destination: Path, logger: ZLogger[String, String], charset: Charset, autoFlushBatchSize: Int, bufferedIOSize: Option[Int], rollingPolicy: Option[FileRollingPolicy]): ZIO[Any, Nothing, ZLogger[String, Any]]
    Definition Classes
    FileLoggerLayers
  34. def makeFileLogger(config: FileLoggerConfig): ZIO[Any, Nothing, FilteredLogger[String, Any]]
    Definition Classes
    FileLoggerLayers
  35. def makeMetricLogger(counter: Counter[Long], logLevelLabel: String): ZIO[Any, Nothing, MetricLogger]
    Definition Classes
    LoggerLayers
  36. def makePrintStreamLogger(logger: ZLogger[String, String], stream: PrintStream): ZIO[Any, Nothing, ZLogger[String, Any]]
    Definition Classes
    LoggerLayers
  37. def makeSystemErrLogger(logger: ZLogger[String, String]): ZIO[Any, Nothing, ZLogger[String, Any]]
    Definition Classes
    LoggerLayers
  38. def makeSystemOutLogger(logger: ZLogger[String, String]): ZIO[Any, Nothing, ZLogger[String, Any]]
    Definition Classes
    LoggerLayers
  39. object ConsoleLoggerConfig extends Serializable
  40. object FileLoggerConfig extends Serializable
  41. object LogAnnotation extends Serializable
  42. object LogColor extends Serializable
  43. object LogContext extends Serializable
  44. object LogFilter
  45. object LogFormat
  46. object LogGroup
  47. object LoggerNameExtractor
  48. object ReconfigurableLogger

Inherited from LoggingPackagePlatformSpecific

Inherited from FileLoggerLayers

Inherited from LoggingPackageAllPlatforms

Inherited from LoggerLayers

Inherited from AnyRef

Inherited from Any

Ungrouped