Provider | Colotok Docs

Common Provider Configuration

All providers support the following configuration options:

Property	Description	Default
`level`	Minimum log level for this provider	`LogLevel.DEBUG`
`formatter`	Formatter to use	`DetailTextFormatter`
`metricsSpec`	How to collect metrics (`Inherit`, `Explicit`, `NoOp`)	`MetricsCollectorSpec.Inherit`
`enableInternalMetricsLogging`	Whether to log metrics as internal records (`LogRecord.Metrics`)	`false`

ConsoleProvider

ConsoleProvider write the log into console

....
.addProvider(ConsoleProvider(ConsoleProviderConfig().apply {
    level = LogLevel.DEBUG
    formatter = DetailTextFormatter
    colorize = true

    traceLevelColor = AnsiColor.WHITE
    debugLevelColor = AnsiColor.BLUE
    infoLevelColor = AnsiColor.GEEN
    warnLevelColor = AnsiColor.YELLOW
    errorLevelColor = AnsiColor.RED
}))

ConsoleProvider can colorize with ANSI-Color

FileProvider

FileProvider writes the log into a file asynchronously.

.addProvider(FileProvider(File("./test.log").toOkioPath()){
    level = LogLevel.TRACE
    formatter = DetailTextFormatter
    // use size base rotation
    rotation = SizeBaseRotation(size = 8192)
    
    // Metrics configuration
    enableInternalMetricsLogging = true
    metricsSpec = MetricsCollectorSpec.Inherit
})

FileProvider can rotate log files using rotation.

SizeBaseRotation

this rotation will rotate when log size over passed [size].

rotation = SizeBaseRotation(size = 8192)

DateBaseRotation

this rotation will rotate when log file spent over [period]

rotation = DateBaseRotation(period = 7.days)

StreamProvider

StreamProvider write the log into stream

val streamProvider: StreamProvider

....
.addProvider(StreamProvider{
    formatter = SimpleStructureFormatter
    outputStreamBuilder = { blackholeSink() }
}.apply { streamProvider = this })