commonMain.io.klogging.config.Defaults.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of klogging-jvm
Kotlin logging library with structured logging and coroutines support
The newest version!
/*

   Copyright 2021-2024 Michael Strasser.

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       https://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.

*/

package io.klogging.config

import io.klogging.Level.INFO
import io.klogging.rendering.RENDER_ANSI
import io.klogging.rendering.RENDER_SIMPLE
import io.klogging.sending.STDERR
import io.klogging.sending.STDOUT

/** Simple sink configuration for rendering simple strings to the standard output stream. */
@Suppress("VARIABLE_NAME_INCORRECT_FORMAT")
public val STDOUT_SIMPLE: SinkConfiguration =
    SinkConfiguration(RENDER_SIMPLE, STDOUT)

/** Simple sink configuration for rendering simple strings to the standard error stream. */
@Suppress("VARIABLE_NAME_INCORRECT_FORMAT")
public val STDERR_SIMPLE: SinkConfiguration =
    SinkConfiguration(RENDER_SIMPLE, STDERR)

/**
 * Simple default configuration for logging to the standard output stream.
 *
 * - All loggers are included.
 * - All events at [INFO] or higher level are included.
 */
@Suppress("VARIABLE_NAME_INCORRECT_FORMAT")
public val DEFAULT_CONSOLE: KloggingConfiguration.() -> Unit = {
    sink("console", STDOUT_SIMPLE)
    logging { fromMinLevel(INFO) { toSink("console") } }
}

/**
 * Simple default configuration for logging to the standard error stream.
 *
 * - All loggers are included.
 * - All events at [INFO] or higher level are included.
 */
@Suppress("VARIABLE_NAME_INCORRECT_FORMAT")
public val DEFAULT_STDERR: KloggingConfiguration.() -> Unit = {
    sink("stderr", STDERR_SIMPLE)
    logging { fromMinLevel(INFO) { toSink("stderr") } }
}

/** Simple sink configuration for rendering ANSI-coloured strings to the standard output stream. */
@Suppress("VARIABLE_NAME_INCORRECT_FORMAT")
public val STDOUT_ANSI: SinkConfiguration =
    SinkConfiguration(RENDER_ANSI, STDOUT)

/** Simple sink configuration for rendering ANSI-coloured strings to the standard error stream. */
@Suppress("VARIABLE_NAME_INCORRECT_FORMAT")
public val STDERR_ANSI: SinkConfiguration =
    SinkConfiguration(RENDER_ANSI, STDERR)

/**
 * Simple default configuration for logging ANSI-coloured strings to the standard output stream.
 *
 * - All loggers are included.
 * - All events at [INFO] or higher level are included.
 */
@Suppress("VARIABLE_NAME_INCORRECT_FORMAT")
public val ANSI_CONSOLE: KloggingConfiguration.() -> Unit = {
    sink("console", STDOUT_ANSI)
    logging { fromMinLevel(INFO) { toSink("console") } }
}

/**
 * Simple default configuration for logging ANSI-coloured strings to the standard error stream.
 *
 * - All loggers are included.
 * - All events at [INFO] or higher level are included.
 */
@Suppress("VARIABLE_NAME_INCORRECT_FORMAT")
public val ANSI_STDERR: KloggingConfiguration.() -> Unit = {
    sink("stderr", STDERR_ANSI)
    logging { fromMinLevel(INFO) { toSink("stderr") } }
}