2 * ============LICENSE_START=======================================================
3 * dcaegen2-collectors-veshv
4 * ================================================================================
5 * Copyright (C) 2018 NOKIA
6 * ================================================================================
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
18 * ============LICENSE_END=========================================================
20 package org.onap.dcae.collectors.veshv.utils.logging
22 import kotlin.reflect.KClass
23 import org.slf4j.LoggerFactory
26 typealias MappedDiagnosticContext = () -> Map<String, String>
28 @Suppress("TooManyFunctions", "SuboptimalLoggerUsage")
29 class Logger(logger: org.slf4j.Logger) {
30 constructor(clazz: KClass<out Any>) : this(LoggerFactory.getLogger(clazz.java))
31 constructor(name: String) : this(LoggerFactory.getLogger(name))
33 private val errorLogger = if (logger.isErrorEnabled) ErrorLevelLogger(logger) else OffLevelLogger
34 private val warnLogger = if (logger.isWarnEnabled) WarnLevelLogger(logger) else OffLevelLogger
35 private val infoLogger = if (logger.isInfoEnabled) InfoLevelLogger(logger) else OffLevelLogger
36 private val debugLogger = if (logger.isDebugEnabled) DebugLevelLogger(logger) else OffLevelLogger
37 private val traceLogger = if (logger.isTraceEnabled) TraceLevelLogger(logger) else OffLevelLogger
41 fun withError(block: AtLevelLogger.() -> Unit) = errorLogger.block()
43 fun withError(mdc: MappedDiagnosticContext, block: AtLevelLogger.() -> Unit) =
44 errorLogger.withMdc(mdc, block)
46 fun error(message: () -> String) = errorLogger.run {
50 fun error(mdc: MappedDiagnosticContext, message: () -> String) =
51 errorLogger.withMdc(mdc) { log(message()) }
53 fun error(mdc: MappedDiagnosticContext, marker: Marker, message: () -> String) =
54 errorLogger.withMdc(mdc) { log(marker, message()) }
58 fun withWarn(block: AtLevelLogger.() -> Unit) = warnLogger.block()
60 fun withWarn(mdc: MappedDiagnosticContext, block: AtLevelLogger.() -> Unit) =
61 warnLogger.withMdc(mdc, block)
63 fun warn(message: () -> String) = warnLogger.run {
67 fun warn(mdc: MappedDiagnosticContext, message: () -> String) =
68 warnLogger.withMdc(mdc) { log(message()) }
70 fun warn(mdc: MappedDiagnosticContext, marker: Marker, message: () -> String) =
71 warnLogger.withMdc(mdc) { log(marker, message()) }
75 fun withInfo(block: AtLevelLogger.() -> Unit) = infoLogger.block()
77 fun withInfo(mdc: MappedDiagnosticContext, block: AtLevelLogger.() -> Unit) =
78 infoLogger.withMdc(mdc, block)
80 fun info(message: () -> String) = infoLogger.run {
84 fun info(mdc: MappedDiagnosticContext, message: () -> String) =
85 infoLogger.withMdc(mdc) { log(message()) }
87 fun info(mdc: MappedDiagnosticContext, marker: Marker, message: () -> String) =
88 infoLogger.withMdc(mdc) { log(marker, message()) }
92 fun withDebug(block: AtLevelLogger.() -> Unit) = debugLogger.block()
94 fun withDebug(mdc: MappedDiagnosticContext, block: AtLevelLogger.() -> Unit) =
95 debugLogger.withMdc(mdc, block)
97 fun debug(message: () -> String) = debugLogger.run {
101 fun debug(mdc: MappedDiagnosticContext, message: () -> String) =
102 debugLogger.withMdc(mdc) { log(message()) }
104 fun debug(mdc: MappedDiagnosticContext, marker: Marker, message: () -> String) =
105 debugLogger.withMdc(mdc) { log(marker, message()) }
109 fun withTrace(block: AtLevelLogger.() -> Unit) = traceLogger.block()
111 fun withTrace(mdc: MappedDiagnosticContext, block: AtLevelLogger.() -> Unit) =
112 traceLogger.withMdc(mdc, block)
114 fun trace(message: () -> String) = traceLogger.run {
118 fun trace(mdc: MappedDiagnosticContext, message: () -> String) =
119 traceLogger.withMdc(mdc) { log(message()) }
121 fun trace(mdc: MappedDiagnosticContext, marker: Marker, message: () -> String) =
122 traceLogger.withMdc(mdc) { log(marker, message()) }
126 abstract class AtLevelLogger {
127 abstract fun log(message: String)
128 abstract fun log(message: String, t: Throwable)
129 abstract fun log(marker: Marker, message: String)
131 open val enabled: Boolean
134 inline fun withMdc(mdc: MappedDiagnosticContext, block: AtLevelLogger.() -> Unit) {
137 MDC.setContextMap(mdc())
145 protected fun withAdditionalMdc(mdc: Map<String, String>, block: () -> Unit) {
150 mdc.forEach(MDC::put)
153 mdc.keys.forEach(MDC::remove)
159 object OffLevelLogger : AtLevelLogger() {
160 override val enabled = false
162 override fun log(message: String) {
163 // do not log anything
166 override fun log(message: String, t: Throwable) {
167 // do not log anything
170 override fun log(marker: Marker, message: String) {
171 // do not log anything
175 @Suppress("SuboptimalLoggerUsage")
176 class ErrorLevelLogger(private val logger: org.slf4j.Logger) : AtLevelLogger() {
177 override fun log(message: String) {
178 logger.error(message)
181 override fun log(message: String, t: Throwable) {
182 logger.error(message, t)
185 override fun log(marker: Marker, message: String) =
186 withAdditionalMdc(marker.mdc) {
187 logger.error(marker.slf4jMarker, message)
191 @Suppress("SuboptimalLoggerUsage")
192 class WarnLevelLogger(private val logger: org.slf4j.Logger) : AtLevelLogger() {
193 override fun log(message: String) {
197 override fun log(message: String, t: Throwable) {
198 logger.warn(message, t)
201 override fun log(marker: Marker, message: String) =
202 withAdditionalMdc(marker.mdc) {
203 logger.warn(marker.slf4jMarker, message)
207 @Suppress("SuboptimalLoggerUsage")
208 class InfoLevelLogger(private val logger: org.slf4j.Logger) : AtLevelLogger() {
209 override fun log(message: String) {
213 override fun log(message: String, t: Throwable) {
214 logger.info(message, t)
217 override fun log(marker: Marker, message: String) =
218 withAdditionalMdc(marker.mdc) {
219 logger.info(marker.slf4jMarker, message)
223 @Suppress("SuboptimalLoggerUsage")
224 class DebugLevelLogger(private val logger: org.slf4j.Logger) : AtLevelLogger() {
225 override fun log(message: String) {
226 logger.debug(message)
229 override fun log(message: String, t: Throwable) {
230 logger.debug(message, t)
233 override fun log(marker: Marker, message: String) =
234 withAdditionalMdc(marker.mdc) {
235 logger.debug(marker.slf4jMarker, message)
239 @Suppress("SuboptimalLoggerUsage")
240 class TraceLevelLogger(private val logger: org.slf4j.Logger) : AtLevelLogger() {
241 override fun log(message: String) {
242 logger.trace(message)
245 override fun log(message: String, t: Throwable) {
246 logger.trace(message, t)
249 override fun log(marker: Marker, message: String) =
250 withAdditionalMdc(marker.mdc) {
251 logger.trace(marker.slf4jMarker, message)