diff --git a/opendc-common/build.gradle.kts b/opendc-common/build.gradle.kts index e0524f3c1..e25a5b032 100644 --- a/opendc-common/build.gradle.kts +++ b/opendc-common/build.gradle.kts @@ -31,5 +31,9 @@ plugins { dependencies { api(libs.kotlinx.coroutines) + api(libs.log4j.core) + api(libs.log4j.slf4j) + api(libs.kotlin.logging) + testImplementation(projects.opendcSimulator.opendcSimulatorCore) } diff --git a/opendc-common/src/main/kotlin/org/opendc/common/logger/Logger.kt b/opendc-common/src/main/kotlin/org/opendc/common/logger/Logger.kt new file mode 100644 index 000000000..ee2f828a8 --- /dev/null +++ b/opendc-common/src/main/kotlin/org/opendc/common/logger/Logger.kt @@ -0,0 +1,131 @@ +/* + * Copyright (c) 2024 AtLarge Research + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ + +package org.opendc.common.logger + +import mu.KotlinLogging +import org.slf4j.Logger + +/** + * @return a slf4j logger named as the calling class simple name. + * Can also be used in the companion object to limit the instances of loggers. + * + * + * ```kotlin + * class Foo { + * val LOG by logger() // Same as: KotlinLogging.logger(name = "Foo") + * + * companion object { + * val LOG by logger() // Same as: KotlinLogging.logger(name = "Foo") + * val LOG by logger("smth") // Same as: KotlinLogging.logger(name = "smth") + * } + * } + * ``` + */ +public fun T.logger(name: String? = null): Lazy { + return lazy { + KotlinLogging.logger( + name + ?: runCatching { this::class.java.enclosingClass.simpleName } + .getOrNull() + ?: "unknown", + ) + } +} + +/** + * Logs [msg] with WARN level and returns null. + * ```kotlin + * // Replace + * LOG.warn() + * return null + * // With + * return LOG.warnAndNull() + */ +public fun Logger.warnAndNull(msg: String): Nothing? { + this.warn(msg) + return null +} + +/** + * Logs [msg] with ERROR level and returns null. + * ```kotlin + * // Replace + * LOG.error() + * return null + * // With + * return LOG.errAndNull() + */ +public fun Logger.errAndNull(msg: String): Nothing? { + this.error(msg) + return null +} + +/** + * Logs [msg] with *WARN* level and returns [obj]. + * + * + * ```kotlin + * // Replace + * if ( !in map) { + * LOG.warn("warn-message") + * return + * } else map[] + * // With + * map.getOrDefault(, LOG.withWarn(, "")) + * ``` + */ +public fun Logger.withWarn( + obj: T, + msg: String, +): T { + this.warn(msg) + return obj +} + +/** + * Logs [msg] with *ERROR* level and returns [obj]. + */ +public fun Logger.withErr( + obj: T, + msg: String, +): T { + this.error(msg) + return obj +} + +/** + * Logs [msg] with *INFO* level on a new line. + * ```console + * + * 09:28:08.830 [INFO] ScenariosSpec - + * | === Compute Export Config === + * | Host Fields (columns) : timestamp, + * ... + * // Instead of + * 09:28:08.830 [INFO] ScenariosSpec - | === Compute Export Config === + * | Host Fields (columns) : timestamp, + * ``` + */ +public fun Logger.infoNewLine(msg: String) { + info("\n" + msg) +} diff --git a/opendc-common/src/main/resources/log4j2.xml b/opendc-common/src/main/resources/log4j2.xml new file mode 100644 index 000000000..073893607 --- /dev/null +++ b/opendc-common/src/main/resources/log4j2.xml @@ -0,0 +1,43 @@ + + + + + + + + + + + + + + + + + + + + +