style: add utility for getting Logger instances

glasskube · Mar 26, 2023 · 0b74eba · 0b74eba
1 parent b2e5303
commit 0b74eba
Show file tree

Hide file tree

Showing 9 changed files with 22 additions and 20 deletions.
diff --git a/operator/src/main/kotlin/eu/glasskube/operator/ReleaseInfo.kt b/operator/src/main/kotlin/eu/glasskube/operator/ReleaseInfo.kt
@@ -1,6 +1,5 @@
 package eu.glasskube.operator
 
-import org.slf4j.LoggerFactory
 import org.springframework.beans.factory.annotation.Value
 import org.springframework.context.annotation.Configuration
 import org.springframework.context.annotation.PropertySource
@@ -28,6 +27,6 @@ data class ReleaseInfo(
     }
 
     companion object {
-        private val log = LoggerFactory.getLogger(ReleaseInfo::class.java)
+        private val log = logger()
     }
 }
diff --git a/operator/src/main/kotlin/eu/glasskube/operator/Utils.kt b/operator/src/main/kotlin/eu/glasskube/operator/Utils.kt
@@ -1,5 +1,7 @@
 package eu.glasskube.operator
 
+import org.slf4j.Logger
+import org.slf4j.LoggerFactory
 import java.util.Base64
 import java.util.Optional
 
@@ -23,3 +25,7 @@ fun String.encodeBase64() = Base64.getEncoder().encodeToString(this.encodeToByte
 fun <T> T.addTo(list: MutableCollection<T>): Boolean = list.add(this)
 
 fun <T> Optional<T>.orNull() = orElse(null)
+
+inline fun <reified T : Any> T.logger(): Logger = with(T::class) {
+    LoggerFactory.getLogger(if (isCompanion) java.enclosingClass else java)
+}
diff --git a/...ator/src/main/kotlin/eu/glasskube/operator/boot/InjectionAwareDependentResourceFactory.kt b/...ator/src/main/kotlin/eu/glasskube/operator/boot/InjectionAwareDependentResourceFactory.kt
@@ -1,11 +1,11 @@
 package eu.glasskube.operator.boot
 
+import eu.glasskube.operator.logger
 import io.javaoperatorsdk.operator.api.config.ControllerConfiguration
 import io.javaoperatorsdk.operator.api.config.dependent.DependentResourceConfigurationResolver
 import io.javaoperatorsdk.operator.api.config.dependent.DependentResourceSpec
 import io.javaoperatorsdk.operator.api.reconciler.dependent.DependentResource
 import io.javaoperatorsdk.operator.api.reconciler.dependent.DependentResourceFactory
-import org.slf4j.LoggerFactory
 import org.springframework.context.ApplicationContext
 import org.springframework.context.ApplicationContextAware
 import org.springframework.stereotype.Component
@@ -31,6 +31,6 @@ class InjectionAwareDependentResourceFactory :
     }
 
     companion object {
-        private val log = LoggerFactory.getLogger(InjectionAwareDependentResourceFactory::class.java)
+        private val log = logger()
     }
 }
diff --git a/operator/src/main/kotlin/eu/glasskube/operator/config/ConfigGenerator.kt b/operator/src/main/kotlin/eu/glasskube/operator/config/ConfigGenerator.kt
@@ -1,14 +1,12 @@
 package eu.glasskube.operator.config
 
+import eu.glasskube.operator.logger
 import io.fabric8.kubernetes.api.model.ConfigMap
 import io.fabric8.kubernetes.client.KubernetesClient
 import io.javaoperatorsdk.operator.api.reconciler.Context
 import io.javaoperatorsdk.operator.api.reconciler.ControllerConfiguration
 import io.javaoperatorsdk.operator.api.reconciler.Reconciler
 import io.javaoperatorsdk.operator.api.reconciler.UpdateControl
-import org.slf4j.LoggerFactory
-
-private val log = LoggerFactory.getLogger(ConfigGenerator::class.java)
 
 @ControllerConfiguration(
     labelSelector = ConfigGenerator.LABEL_SELECTOR,
@@ -55,6 +53,7 @@ class ConfigGenerator(private val kubernetesClient: KubernetesClient, private va
     }
 
     companion object {
+        private val log = logger()
         const val NAME = "glasskube-settings"
         const val LABEL_SELECTOR = "glasskube.eu/settings"
     }

diff --git a/operator/src/main/kotlin/eu/glasskube/operator/gitea/GiteaReconciler.kt b/operator/src/main/kotlin/eu/glasskube/operator/gitea/GiteaReconciler.kt
@@ -18,6 +18,7 @@ import eu.glasskube.operator.gitea.dependent.GiteaSSHService
 import eu.glasskube.operator.gitea.dependent.GiteaSecret
 import eu.glasskube.operator.gitea.dependent.GiteaServiceMonitor
 import eu.glasskube.operator.gitea.dependent.GiteaVolume
+import eu.glasskube.operator.logger
 import eu.glasskube.operator.postgres.PostgresCluster
 import io.fabric8.kubernetes.api.model.ConfigMap
 import io.fabric8.kubernetes.api.model.Service
@@ -29,7 +30,6 @@ import io.javaoperatorsdk.operator.api.reconciler.EventSourceInitializer
 import io.javaoperatorsdk.operator.api.reconciler.Reconciler
 import io.javaoperatorsdk.operator.api.reconciler.UpdateControl
 import io.javaoperatorsdk.operator.api.reconciler.dependent.Dependent
-import org.slf4j.LoggerFactory
 
 @ControllerConfiguration(
     dependents = [
@@ -135,6 +135,6 @@ class GiteaReconciler : Reconciler<Gitea>, EventSourceInitializer<Gitea> {
         internal const val SERVICE_EVENT_SOURCE = "GiteaServiceEventSource"
         internal const val DEPLOYMENT_EVENT_SOURCE = "GiteaDeploymentEventSource"
 
-        private val log = LoggerFactory.getLogger(GiteaReconciler::class.java)
+        private val log = logger()
     }
 }
diff --git a/operator/src/main/kotlin/eu/glasskube/operator/gitea/dependent/GiteaIniConfigMap.kt b/operator/src/main/kotlin/eu/glasskube/operator/gitea/dependent/GiteaIniConfigMap.kt
@@ -9,13 +9,13 @@ import eu.glasskube.operator.gitea.dbClusterName
 import eu.glasskube.operator.gitea.iniConfigMapName
 import eu.glasskube.operator.gitea.redisName
 import eu.glasskube.operator.gitea.resourceLabels
+import eu.glasskube.operator.logger
 import io.fabric8.kubernetes.api.model.ConfigMap
 import io.javaoperatorsdk.operator.api.reconciler.Context
 import io.javaoperatorsdk.operator.api.reconciler.ResourceIDMatcherDiscriminator
 import io.javaoperatorsdk.operator.processing.dependent.kubernetes.CRUDKubernetesDependentResource
 import io.javaoperatorsdk.operator.processing.dependent.kubernetes.KubernetesDependent
 import io.javaoperatorsdk.operator.processing.event.ResourceID
-import org.slf4j.LoggerFactory
 
 @KubernetesDependent(
     labelSelector = GiteaReconciler.SELECTOR,
@@ -60,6 +60,6 @@ class GiteaIniConfigMap : CRUDKubernetesDependentResource<ConfigMap, Gitea>(Conf
     }
 
     companion object {
-        private val log = LoggerFactory.getLogger(GiteaIniConfigMap::class.java)
+        private val log = logger()
     }
 }
diff --git a/operator/src/main/kotlin/eu/glasskube/operator/httpecho/HttpEchoReconciler.kt b/operator/src/main/kotlin/eu/glasskube/operator/httpecho/HttpEchoReconciler.kt
@@ -4,6 +4,7 @@ import eu.glasskube.operator.api.reconciler.informerEventSource
 import eu.glasskube.operator.httpecho.dependent.HttpEchoDeployment
 import eu.glasskube.operator.httpecho.dependent.HttpEchoIngress
 import eu.glasskube.operator.httpecho.dependent.HttpEchoService
+import eu.glasskube.operator.logger
 import io.fabric8.kubernetes.api.model.Secret
 import io.javaoperatorsdk.operator.api.reconciler.Context
 import io.javaoperatorsdk.operator.api.reconciler.ControllerConfiguration
@@ -12,9 +13,6 @@ import io.javaoperatorsdk.operator.api.reconciler.EventSourceInitializer
 import io.javaoperatorsdk.operator.api.reconciler.Reconciler
 import io.javaoperatorsdk.operator.api.reconciler.UpdateControl
 import io.javaoperatorsdk.operator.api.reconciler.dependent.Dependent
-import org.slf4j.LoggerFactory
-
-private val LOG = LoggerFactory.getLogger(HttpEchoReconciler::class.java)
 
 @ControllerConfiguration(
     dependents = [
@@ -25,7 +23,7 @@ private val LOG = LoggerFactory.getLogger(HttpEchoReconciler::class.java)
 )
 class HttpEchoReconciler : Reconciler<HttpEcho>, EventSourceInitializer<HttpEcho> {
     override fun reconcile(resource: HttpEcho, context: Context<HttpEcho>): UpdateControl<HttpEcho> {
-        LOG.info("reconciling ${resource.crdName} ${resource.apiVersion}")
+        log.info("reconciling ${resource.crdName} ${resource.apiVersion}")
         resource.status = HttpEchoStatus("Echoing")
         return UpdateControl.patchStatus(resource)
     }
@@ -37,6 +35,7 @@ class HttpEchoReconciler : Reconciler<HttpEcho>, EventSourceInitializer<HttpEcho
     }
 
     companion object {
+        private val log = logger()
         const val LABEL = "glasskube.eu/HttpEcho"
         const val APP_NAME = "http-echo"
         const val SELECTOR = "app.kubernetes.io/managed-by=glasskube-operator,app=$APP_NAME"

diff --git a/operator/src/main/kotlin/eu/glasskube/operator/minio/MinioBucketReconciler.kt b/operator/src/main/kotlin/eu/glasskube/operator/minio/MinioBucketReconciler.kt
@@ -3,6 +3,7 @@ package eu.glasskube.operator.minio
 import eu.glasskube.kubernetes.client.patchOrUpdateStatus
 import eu.glasskube.operator.Labels
 import eu.glasskube.operator.decodeBase64
+import eu.glasskube.operator.logger
 import eu.glasskube.operator.minio.dependent.MinioBucketSecret
 import io.fabric8.kubernetes.api.model.Secret
 import io.fabric8.kubernetes.client.KubernetesClient
@@ -20,7 +21,6 @@ import io.minio.MinioClient
 import io.minio.RemoveBucketArgs
 import io.minio.admin.MinioAdminClient
 import io.minio.admin.UserInfo
-import org.slf4j.LoggerFactory
 import java.util.concurrent.TimeUnit
 
 @ControllerConfiguration(
@@ -161,6 +161,6 @@ class MinioBucketReconciler(
         const val SELECTOR =
             "${Labels.MANAGED_BY_GLASSKUBE},${Labels.NAME}=${MinioBucket.APP_NAME}"
 
-        private val log = LoggerFactory.getLogger(MinioBucketReconciler::class.java)
+        private val log = logger()
     }
 }
diff --git a/operator/src/main/kotlin/eu/glasskube/operator/secrets/SecretGenerator.kt b/operator/src/main/kotlin/eu/glasskube/operator/secrets/SecretGenerator.kt
@@ -1,16 +1,14 @@
 package eu.glasskube.operator.secrets
 
+import eu.glasskube.operator.logger
 import io.fabric8.kubernetes.api.model.Secret
 import io.javaoperatorsdk.operator.api.reconciler.Context
 import io.javaoperatorsdk.operator.api.reconciler.ControllerConfiguration
 import io.javaoperatorsdk.operator.api.reconciler.Reconciler
 import io.javaoperatorsdk.operator.api.reconciler.UpdateControl
 import org.apache.commons.lang3.RandomStringUtils
-import org.slf4j.LoggerFactory
 import java.util.Random
 
-private val log = LoggerFactory.getLogger(SecretGenerator::class.java)
-
 @ControllerConfiguration(
     labelSelector = SecretGenerator.LABEL_SELECTOR,
     generationAwareEventProcessing = false
@@ -43,6 +41,7 @@ class SecretGenerator(private val random: Random) : Reconciler<Secret> {
         RandomStringUtils.random(count, 0, 0, true, true, null, this)
 
     companion object {
+        private val log = logger()
         val LABEL = "glasskube.eu/generated" to "yes"
         const val LABEL_SELECTOR = "glasskube.eu/generated=yes"
         const val GENERATE_KEYS = "secrets.glasskube.eu/generateKeys"