telemetry-api/aws.smithy.kotlin.runtime.telemetry.logging

Package-level declarations

Types

An abstract implementation of a logger. This class delegates the trace, debug, info, warn, and error methods to a centralized log method which accepts LogLevel as a parameter. By default, this class uses no-op implementations for all other members unless overridden in a subclass.

AbstractLoggerProvider

abstract class AbstractLoggerProvider : LoggerProvider

An abstract implementation of a logger provider. By default, this class uses no-op implementations for all members unless overridden in a subclass.

AbstractLogRecordBuilder

abstract class AbstractLogRecordBuilder : LogRecordBuilder

An abstract implementation of a log record builder. By default, this class uses no-op implementations for all members unless overridden in a subclass.

Logger

interface Logger

Internal logging facade

LoggerProvider

interface LoggerProvider

Entry point for creating Logger instances

LoggingContextElement

data class LoggingContextElement(val kvPairs: Map<String, Any>)

Coroutine scoped telemetry context used for carrying telemetry provider configuration

LogLevel

enum LogLevel : Enum<LogLevel>

LogRecordBuilder

interface LogRecordBuilder

Construct a logging record that can be emitted to an underlying logger.

MessageSupplier

typealias MessageSupplier = () -> String

Inherited properties

loggingContext

val <Error class: unknown class>.loggingContext: Map<String, Any>

Functions

withLogCtx

inline suspend fun <R> withLogCtx(vararg kvPairs: <Error class: unknown class><String, Any>, crossinline block: suspend () -> R): R

Execute block with key/value pairs set in the logging context. These will be automatically added to any log record executed via CoroutineContext.log.

Inherited functions

debug

fun Logger.debug(msg: String)

Add a log message if debug logging is enabled

inline fun <T> <Error class: unknown class>.debug(ex: Throwable? = null, noinline content: () -> String)

fun <Error class: unknown class>.debug(sourceComponent: String, ex: Throwable? = null, content: () -> String)

Logs a debug message using the current LoggerProvider configured in this CoroutineContext.

error

fun Logger.error(msg: String)

Add a log message if error logging is enabled

inline fun <T> <Error class: unknown class>.error(ex: Throwable? = null, noinline content: () -> String)

fun <Error class: unknown class>.error(sourceComponent: String, ex: Throwable? = null, content: () -> String)

Logs an error message using the current LoggerProvider configured in this CoroutineContext.

getLogger

inline fun <T> LoggerProvider.getLogger(): Logger

Get the logger for the class T

info

fun Logger.info(msg: String)

Add a log message if info logging is enabled

inline fun <T> <Error class: unknown class>.info(ex: Throwable? = null, noinline content: () -> String)

fun <Error class: unknown class>.info(sourceComponent: String, ex: Throwable? = null, content: () -> String)

Logs an info message using the current LoggerProvider configured in this CoroutineContext.

log

inline fun <T> <Error class: unknown class>.log(level: LogLevel, ex: Throwable? = null, noinline content: () -> String)

fun <Error class: unknown class>.log(level: LogLevel, sourceComponent: String, ex: Throwable? = null, content: () -> String)

Logs a message using the current LoggerProvider configured in this CoroutineContext.

logger

inline fun <T> <Error class: unknown class>.logger(): Logger

fun <Error class: unknown class>.logger(sourceComponent: String): Logger

Get a Logger instance using the current LoggerProvider configured in this CoroutineContext

trace

fun Logger.trace(msg: String)

Add a log message if trace logging is enabled

inline fun <T> <Error class: unknown class>.trace(ex: Throwable? = null, noinline content: () -> String)

fun <Error class: unknown class>.trace(sourceComponent: String, ex: Throwable? = null, content: () -> String)

Logs a trace message using the current LoggerProvider configured in this CoroutineContext.

warn

fun Logger.warn(msg: String)

Add a log message if warn logging is enabled

inline fun <T> <Error class: unknown class>.warn(ex: Throwable? = null, noinline content: () -> String)

fun <Error class: unknown class>.warn(sourceComponent: String, ex: Throwable? = null, content: () -> String)

Logs a warning message using the current LoggerProvider configured in this CoroutineContext.