Addressing comments:

- Renaming tryInitLogFromEnvOr to initLogFromEnvOr - Adding Zenoh.initLogFromEnvOr("error") to all the examples
eclipse-zenoh · Sep 13, 2024 · 5b51f5f · 5b51f5f
1 parent 1f1baee
commit 5b51f5f
Show file tree

Hide file tree

Showing 11 changed files with 18 additions and 27 deletions.
diff --git a/examples/src/main/kotlin/io.zenoh/ZDelete.kt b/examples/src/main/kotlin/io.zenoh/ZDelete.kt
@@ -24,7 +24,7 @@ class ZDelete(private val emptyArgs: Boolean) : CliktCommand(
     override fun run() {
         val config = loadConfig(emptyArgs, configFile, connect, listen, noMulticastScouting, mode)
 
-        Zenoh.tryInitLogFromEnv()
+        Zenoh.initLogFromEnvOr("error")
 
         println("Opening session...")
         Zenoh.open(config).onSuccess { session ->

diff --git a/examples/src/main/kotlin/io.zenoh/ZGet.kt b/examples/src/main/kotlin/io.zenoh/ZGet.kt
@@ -32,7 +32,7 @@ class ZGet(private val emptyArgs: Boolean) : CliktCommand(
     override fun run() {
         val config = loadConfig(emptyArgs, configFile, connect, listen, noMulticastScouting, mode)
 
-        Zenoh.tryInitLogFromEnv()
+        Zenoh.initLogFromEnvOr("error")
 
         Zenoh.open(config).onSuccess { session ->
             session.use {

diff --git a/examples/src/main/kotlin/io.zenoh/ZPub.kt b/examples/src/main/kotlin/io.zenoh/ZPub.kt
@@ -25,7 +25,7 @@ class ZPub(private val emptyArgs: Boolean) : CliktCommand(
     override fun run() {
         val config = loadConfig(emptyArgs, configFile, connect, listen, noMulticastScouting, mode)
 
-        Zenoh.tryInitLogFromEnv()
+        Zenoh.initLogFromEnvOr("error")
 
         println("Opening session...")
         Zenoh.open(config).onSuccess { session ->

diff --git a/examples/src/main/kotlin/io.zenoh/ZPubThr.kt b/examples/src/main/kotlin/io.zenoh/ZPubThr.kt
@@ -32,6 +32,8 @@ class ZPubThr(private val emptyArgs: Boolean) : CliktCommand(
 ) {
 
     override fun run() {
+        Zenoh.initLogFromEnvOr("error")
+
         val data = ByteArray(payloadSize)
         for (i in 0..<payloadSize) {
             data[i] = (i % 10).toByte()

diff --git a/examples/src/main/kotlin/io.zenoh/ZPut.kt b/examples/src/main/kotlin/io.zenoh/ZPut.kt
@@ -26,7 +26,7 @@ class ZPut(private val emptyArgs: Boolean) : CliktCommand(
     override fun run() {
         val config = loadConfig(emptyArgs, configFile, connect, listen, noMulticastScouting, mode)
 
-        Zenoh.tryInitLogFromEnv()
+        Zenoh.initLogFromEnvOr("error")
 
         println("Opening Session...")
         Zenoh.open(config).onSuccess { session ->

diff --git a/examples/src/main/kotlin/io.zenoh/ZQueryable.kt b/examples/src/main/kotlin/io.zenoh/ZQueryable.kt
@@ -29,7 +29,7 @@ class ZQueryable(private val emptyArgs: Boolean) : CliktCommand(
     override fun run() {
         val config = loadConfig(emptyArgs, configFile, connect, listen, noMulticastScouting, mode)
 
-        Zenoh.tryInitLogFromEnv()
+        Zenoh.initLogFromEnvOr("error")
 
         Zenoh.open(config).onSuccess { session ->
             session.use {

diff --git a/examples/src/main/kotlin/io.zenoh/ZScout.kt b/examples/src/main/kotlin/io.zenoh/ZScout.kt
@@ -24,7 +24,7 @@ class ZScout : CliktCommand(
 ) {
     override fun run() {
 
-        Zenoh.tryInitLogFromEnv()
+        Zenoh.initLogFromEnvOr("error")
 
         println("Scouting...")
 

diff --git a/examples/src/main/kotlin/io.zenoh/ZSub.kt b/examples/src/main/kotlin/io.zenoh/ZSub.kt
@@ -27,7 +27,7 @@ class ZSub(private val emptyArgs: Boolean) : CliktCommand(
     override fun run() {
         val config = loadConfig(emptyArgs, configFile, connect, listen, noMulticastScouting, mode)
 
-        Zenoh.tryInitLogFromEnv()
+        Zenoh.initLogFromEnvOr("error")
 
         println("Opening session...")
         Zenoh.open(config).onSuccess { session ->

diff --git a/examples/src/main/kotlin/io.zenoh/ZSubThr.kt b/examples/src/main/kotlin/io.zenoh/ZSubThr.kt
@@ -72,6 +72,8 @@ class ZSubThr(private val emptyArgs: Boolean) : CliktCommand(
     override fun run() {
         val config = loadConfig(emptyArgs, configFile, connect, listen, noMulticastScouting, mode)
 
+        Zenoh.initLogFromEnvOr("error")
+
         "test/thr".intoKeyExpr().onSuccess { keyExpr ->
             keyExpr.use {
                 println("Opening Session")

diff --git a/zenoh-kotlin/src/commonMain/kotlin/io/zenoh/Logger.kt b/zenoh-kotlin/src/commonMain/kotlin/io/zenoh/Logger.kt
@@ -21,8 +21,8 @@ internal class Logger {
 
         internal const val LOG_ENV: String = "RUST_LOG"
 
-        fun start(logLevel: LogLevel) = runCatching {
-            startLogsViaJNI(logLevel.description)
+        fun start(logLevel: String) = runCatching {
+            startLogsViaJNI(logLevel)
         }
 
         /**
@@ -35,15 +35,3 @@ internal class Logger {
         private external fun startLogsViaJNI(logLevel: String)
     }
 }
-
-enum class LogLevel(internal val description: String) {
-    INFO("info"),
-    DEBUG("debug"),
-    WARN("warn"),
-    TRACE("trace"),
-    ERROR("error");
-
-    companion object  {
-        internal fun fromString(description: String): LogLevel = LogLevel.entries.first { it.description == description }
-    }
-}
diff --git a/zenoh-kotlin/src/commonMain/kotlin/io/zenoh/Zenoh.kt b/zenoh-kotlin/src/commonMain/kotlin/io/zenoh/Zenoh.kt
@@ -115,22 +115,21 @@ object Zenoh {
      */
     fun tryInitLogFromEnv(): Result<Unit> = runCatching {
         ZenohLoad
-        val logProp = System.getenv(LOG_ENV)
+        val logLevel = System.getenv(LOG_ENV)
             ?: return Result.failure(Exception("Failure during logs initialization: couldn't find environment variable '$LOG_ENV'."))
-        val logLevel = LogLevel.fromString(logProp)
         return Logger.start(logLevel)
     }
 
     /**
-     * Try starting the logs with the level specified under the [LOG_ENV] environment variable.
+     * Try starting the logs with the level specified under the [LOG_ENV] environment variable or by default [defaultLogLevel].
      *
+     * @param defaultLogLevel A string that must be either "info", "debug", "error", "trace", "warn".
      * @see Logger
      */
-    fun tryInitLogFromEnvOr(defaultLogLevel: LogLevel): Result<Unit> = runCatching {
+    fun initLogFromEnvOr(defaultLogLevel: String): Result<Unit> = runCatching {
         ZenohLoad
         val logLevelProp = System.getenv(LOG_ENV)
-        val logLevel = logLevelProp?.let { LogLevel.fromString(it) } ?: defaultLogLevel
-        Logger.start(logLevel)
+        logLevelProp?.let { Logger.start(it) } ?: Logger.start(defaultLogLevel)
     }
 }