fix: improve logging (#62)

Frnd-me · web-flow · commit f084ad5500c5 · 2025-10-01T14:20:11.000+02:00
diff --git a/src/main/java/at/ac/uibk/dps/cirrina/cirrina/Cirrina.kt b/src/main/java/at/ac/uibk/dps/cirrina/cirrina/Cirrina.kt
@@ -86,9 +86,9 @@ class Cirrina {
             }
         }
     } catch (e: EnvironmentVariableError) {
-      logger.error("There is an error in the current configuration, because: '${e.message}'", e)
+      logger.error("There is an error in the current configuration", e)
     } catch (e: Exception) {
-      logger.error("There was an unknown in the runtime execution, because: '${e.message}'", e)
+      logger.error("There was an unknown in the runtime execution", e)
     }
   }
 
diff --git a/src/main/java/at/ac/uibk/dps/cirrina/execution/command/ActionAssignCommand.java b/src/main/java/at/ac/uibk/dps/cirrina/execution/command/ActionAssignCommand.java
@@ -65,7 +65,7 @@ public List<ActionCommand> execute() throws UnsupportedOperationException {
           )
         );
     } catch (IOException e) {
-      logger.error("Data assignment failed: {}", e.getMessage());
+      logger.error("Data assignment failed", e);
     }
 
     return commands;
diff --git a/src/main/java/at/ac/uibk/dps/cirrina/execution/command/ActionCreateCommand.java b/src/main/java/at/ac/uibk/dps/cirrina/execution/command/ActionCreateCommand.java
@@ -69,7 +69,7 @@ public List<ActionCommand> execute() throws UnsupportedOperationException {
           gauges.attributesForData("create", !isPersistent ? "local" : "persistent", size)
         );
     } catch (Exception e) {
-      logger.error("Data creation failed: {}", e.getMessage());
+      logger.error("Data creation failed", e);
     }
 
     return commands;
diff --git a/src/main/java/at/ac/uibk/dps/cirrina/execution/command/ActionInvokeCommand.java b/src/main/java/at/ac/uibk/dps/cirrina/execution/command/ActionInvokeCommand.java
@@ -64,9 +64,8 @@ public List<ActionCommand> execute() throws UnsupportedOperationException {
         .invoke(input, executionContext.scope().getId())
         .exceptionally(e -> {
           logger.error(
-            "Service invocation failed for service '{}': {}",
+            "Service invocation failed for service '{}'",
             serviceImplementation.getInformationString(),
-            e.getMessage(),
             e
           );
           return null;
@@ -143,9 +142,8 @@ private void assignServiceOutput(List<ContextVariable> output, Extent extent) {
               extent.trySet(outputReference.getReference(), outputVariable.value());
             } catch (Exception e) {
               logger.error(
-                "Failed to assign service output to variable '{}': {}",
+                "Failed to assign service output to variable '{}'",
                 outputReference.getReference(),
-                e.getMessage(),
                 e
               );
             }
diff --git a/src/main/java/at/ac/uibk/dps/cirrina/execution/command/ActionMatchCommand.java b/src/main/java/at/ac/uibk/dps/cirrina/execution/command/ActionMatchCommand.java
@@ -40,7 +40,7 @@ public List<ActionCommand> execute() throws UnsupportedOperationException {
         }
       }
     } catch (UnsupportedOperationException e) {
-      logger.error("Could not execute match action: {}", e.getMessage());
+      logger.error("Could not execute match action", e);
     }
 
     return commands;
diff --git a/src/main/java/at/ac/uibk/dps/cirrina/execution/object/context/NatsContext.kt b/src/main/java/at/ac/uibk/dps/cirrina/execution/object/context/NatsContext.kt
@@ -56,45 +56,34 @@ class NatsContext(
                       keyValue = getOrCreateBucket(conn)
                       connection = conn
                     } catch (e: Exception) {
-                      logger.error("Failed to setup bucket", e)
+                      logger.error("Failed to setup the persistent context bucket", e)
                     } finally {
                       connectedLatch.countDown()
                     }
                   }
-                  logger.info("(Re)connected to NATS for persistent context")
+                  logger.info("(Re)connected to the NATS server for persistent context")
                 }
 
                 ConnectionListener.Events.DISCONNECTED -> {
                   synchronized(lock) {
                     connection = null
                     keyValue = null
                   }
-                  logger.warn("NATS disconnected for persistent context")
+                  logger.warn("Disconnected from the NATS server for persistent context")
                 }
 
                 else -> {}
               }
             }
           }
         )
-        .errorListener(
-          object : ErrorListener {
-            override fun errorOccurred(conn: Connection?, error: String?) {
-              logger.error("NATS error: $error")
-            }
-
-            override fun exceptionOccurred(conn: Connection?, e: Exception?) {
-              logger.error("NATS exception", e)
-            }
-          }
-        )
         .build()
 
     try {
       Nats.connectAsynchronously(options, true)
-    } catch (e: InterruptedException) {
+    } catch (_: InterruptedException) {
       Thread.currentThread().interrupt()
-      logger.error("Interrupted while initiating NATS connection, will never connect", e)
+      logger.error("Interrupted while initiating NATS connection, will never connect")
     }
   }
 
@@ -103,7 +92,7 @@ class NatsContext(
     runCatching {
         conn.keyValueManagement().apply {
           if (!bucketNames.contains(bucketName)) {
-            logger.warn("Bucket '$bucketName' does not exist, creating it")
+            logger.warn("Persistent bucket '$bucketName' does not exist, creating it")
             create(KeyValueConfiguration.Builder().name(bucketName).build())
           }
         }
@@ -128,7 +117,8 @@ class NatsContext(
   override fun get(name: String): Any =
     synchronized(lock) {
       runCatching {
-          val kv = keyValue ?: throw IOException("Not connected to NATS for persistent context")
+          val kv =
+            keyValue ?: throw IOException("Not connected to the NATS server for persistent context")
           if (!kv.keys().contains(name)) {
             throw IOException("A variable with the name '$name' does not exist")
           }
@@ -151,7 +141,8 @@ class NatsContext(
   override fun create(name: String, value: Any?): Int =
     synchronized(lock) {
       runCatching {
-          val kv = keyValue ?: throw IOException("Not connected to NATS for persistent context")
+          val kv =
+            keyValue ?: throw IOException("Not connected to the NATS server for persistent context")
           if (kv.keys().contains(name)) {
             throw IOException("A variable with the name '$name' already exists")
           }
@@ -175,7 +166,8 @@ class NatsContext(
   override fun assign(name: String, value: Any?): Int =
     synchronized(lock) {
       runCatching {
-          val kv = keyValue ?: throw IOException("Not connected to NATS for persistent context")
+          val kv =
+            keyValue ?: throw IOException("Not connected to the NATS server for persistent context")
           if (!kv.keys().contains(name)) {
             throw IOException("A variable with the name '$name' does not exist")
           }
@@ -197,7 +189,8 @@ class NatsContext(
   override fun delete(name: String) {
     synchronized(lock) {
       runCatching {
-          val kv = keyValue ?: throw IOException("Not connected to NATS for persistent context")
+          val kv =
+            keyValue ?: throw IOException("Not connected to the NATS server for persistent context")
           if (!kv.keys().contains(name)) {
             throw IOException("A variable with the name '$name' does not exist")
           }
@@ -212,7 +205,8 @@ class NatsContext(
   override fun getAll(): List<ContextVariable> =
     synchronized(lock) {
       runCatching {
-          val kv = keyValue ?: throw IOException("Not connected to NATS for persistent context")
+          val kv =
+            keyValue ?: throw IOException("Not connected to the NATS server for persistent context")
           kv.keys().map { key ->
             val entry = kv.get(key)
             ContextVariable(entry.key, entry.value)
@@ -231,7 +225,7 @@ class NatsContext(
             conn.close()
           }
         }
-        .onFailure { e -> throw IOException("Failed to close NATS persistent context", e) }
+        .onFailure { e -> throw IOException("Failed to close the NATS persistent context", e) }
     }
   }
 
diff --git a/src/main/java/at/ac/uibk/dps/cirrina/execution/object/statemachine/StateMachine.java b/src/main/java/at/ac/uibk/dps/cirrina/execution/object/statemachine/StateMachine.java
@@ -780,7 +780,7 @@ public void run() {
 
       Thread.currentThread().interrupt();
     } catch (Exception e) {
-      logger.error("%s received a fatal error".formatted(stateMachineId.toString()), e);
+      logger.error("{} received a fatal error", stateMachineId.toString(), e);
     }
 
     logger.info("{} has stopped", stateMachineId.toString());

Original file line number	Diff line number	Diff line change
`@@ -86,9 +86,9 @@ class Cirrina {`
`86`	`86`	`}`
`87`	`87`	`}`
`88`	`88`	`} catch (e: EnvironmentVariableError) {`
`89`		`- logger.error("There is an error in the current configuration, because: '${e.message}'", e)`
	`89`	`+ logger.error("There is an error in the current configuration", e)`
`90`	`90`	`} catch (e: Exception) {`
`91`		`- logger.error("There was an unknown in the runtime execution, because: '${e.message}'", e)`
	`91`	`+ logger.error("There was an unknown in the runtime execution", e)`
`92`	`92`	`}`
`93`	`93`	`}`
`94`	`94`
Original file line number	Diff line number	Diff line change
`@@ -65,7 +65,7 @@ public List<ActionCommand> execute() throws UnsupportedOperationException {`
`65`	`65`	`)`
`66`	`66`	`);`
`67`	`67`	`} catch (IOException e) {`
`68`		`- logger.error("Data assignment failed: {}", e.getMessage());`
	`68`	`+ logger.error("Data assignment failed", e);`
`69`	`69`	`}`
`70`	`70`
`71`	`71`	`return commands;`
Original file line number	Diff line number	Diff line change
`@@ -69,7 +69,7 @@ public List<ActionCommand> execute() throws UnsupportedOperationException {`
`69`	`69`	`gauges.attributesForData("create", !isPersistent ? "local" : "persistent", size)`
`70`	`70`	`);`
`71`	`71`	`} catch (Exception e) {`
`72`		`- logger.error("Data creation failed: {}", e.getMessage());`
	`72`	`+ logger.error("Data creation failed", e);`
`73`	`73`	`}`
`74`	`74`
`75`	`75`	`return commands;`
Original file line number	Diff line number	Diff line change
`@@ -40,7 +40,7 @@ public List<ActionCommand> execute() throws UnsupportedOperationException {`
`40`	`40`	`}`
`41`	`41`	`}`
`42`	`42`	`} catch (UnsupportedOperationException e) {`
`43`		`- logger.error("Could not execute match action: {}", e.getMessage());`
	`43`	`+ logger.error("Could not execute match action", e);`
`44`	`44`	`}`
`45`	`45`
`46`	`46`	`return commands;`
Original file line number	Diff line number	Diff line change
`@@ -56,45 +56,34 @@ class NatsContext(`
`56`	`56`	`keyValue = getOrCreateBucket(conn)`
`57`	`57`	`connection = conn`
`58`	`58`	`} catch (e: Exception) {`
`59`		`- logger.error("Failed to setup bucket", e)`
	`59`	`+ logger.error("Failed to setup the persistent context bucket", e)`
`60`	`60`	`} finally {`
`61`	`61`	`connectedLatch.countDown()`
`62`	`62`	`}`
`63`	`63`	`}`
`64`		`- logger.info("(Re)connected to NATS for persistent context")`
	`64`	`+ logger.info("(Re)connected to the NATS server for persistent context")`
`65`	`65`	`}`
`66`	`66`
`67`	`67`	`ConnectionListener.Events.DISCONNECTED -> {`
`68`	`68`	`synchronized(lock) {`
`69`	`69`	`connection = null`
`70`	`70`	`keyValue = null`
`71`	`71`	`}`
`72`		`- logger.warn("NATS disconnected for persistent context")`
	`72`	`+ logger.warn("Disconnected from the NATS server for persistent context")`
`73`	`73`	`}`
`74`	`74`
`75`	`75`	`else -> {}`
`76`	`76`	`}`
`77`	`77`	`}`
`78`	`78`	`}`
`79`	`79`	`)`
`80`		`- .errorListener(`
`81`		`- object : ErrorListener {`
`82`		`- override fun errorOccurred(conn: Connection?, error: String?) {`
`83`		`- logger.error("NATS error: $error")`
`84`		`- }`
`85`		`-`
`86`		`- override fun exceptionOccurred(conn: Connection?, e: Exception?) {`
`87`		`- logger.error("NATS exception", e)`
`88`		`- }`
`89`		`- }`
`90`		`- )`
`91`	`80`	`.build()`
`92`	`81`
`93`	`82`	`try {`
`94`	`83`	`Nats.connectAsynchronously(options, true)`
`95`		`- } catch (e: InterruptedException) {`
	`84`	`+ } catch (_: InterruptedException) {`
`96`	`85`	`Thread.currentThread().interrupt()`
`97`		`- logger.error("Interrupted while initiating NATS connection, will never connect", e)`
	`86`	`+ logger.error("Interrupted while initiating NATS connection, will never connect")`
`98`	`87`	`}`
`99`	`88`	`}`
`100`	`89`
`@@ -103,7 +92,7 @@ class NatsContext(`
`103`	`92`	`runCatching {`
`104`	`93`	`conn.keyValueManagement().apply {`
`105`	`94`	`if (!bucketNames.contains(bucketName)) {`
`106`		`- logger.warn("Bucket '$bucketName' does not exist, creating it")`
	`95`	`+ logger.warn("Persistent bucket '$bucketName' does not exist, creating it")`
`107`	`96`	`create(KeyValueConfiguration.Builder().name(bucketName).build())`
`108`	`97`	`}`
`109`	`98`	`}`
`@@ -128,7 +117,8 @@ class NatsContext(`
`128`	`117`	`override fun get(name: String): Any =`
`129`	`118`	`synchronized(lock) {`
`130`	`119`	`runCatching {`
`131`		`- val kv = keyValue ?: throw IOException("Not connected to NATS for persistent context")`
	`120`	`+ val kv =`
	`121`	`+ keyValue ?: throw IOException("Not connected to the NATS server for persistent context")`
`132`	`122`	`if (!kv.keys().contains(name)) {`
`133`	`123`	`throw IOException("A variable with the name '$name' does not exist")`
`134`	`124`	`}`
`@@ -151,7 +141,8 @@ class NatsContext(`
`151`	`141`	`override fun create(name: String, value: Any?): Int =`
`152`	`142`	`synchronized(lock) {`
`153`	`143`	`runCatching {`
`154`		`- val kv = keyValue ?: throw IOException("Not connected to NATS for persistent context")`
	`144`	`+ val kv =`
	`145`	`+ keyValue ?: throw IOException("Not connected to the NATS server for persistent context")`
`155`	`146`	`if (kv.keys().contains(name)) {`
`156`	`147`	`throw IOException("A variable with the name '$name' already exists")`
`157`	`148`	`}`
`@@ -175,7 +166,8 @@ class NatsContext(`
`175`	`166`	`override fun assign(name: String, value: Any?): Int =`
`176`	`167`	`synchronized(lock) {`
`177`	`168`	`runCatching {`
`178`		`- val kv = keyValue ?: throw IOException("Not connected to NATS for persistent context")`
	`169`	`+ val kv =`
	`170`	`+ keyValue ?: throw IOException("Not connected to the NATS server for persistent context")`
`179`	`171`	`if (!kv.keys().contains(name)) {`
`180`	`172`	`throw IOException("A variable with the name '$name' does not exist")`
`181`	`173`	`}`
`@@ -197,7 +189,8 @@ class NatsContext(`
`197`	`189`	`override fun delete(name: String) {`
`198`	`190`	`synchronized(lock) {`
`199`	`191`	`runCatching {`
`200`		`- val kv = keyValue ?: throw IOException("Not connected to NATS for persistent context")`
	`192`	`+ val kv =`
	`193`	`+ keyValue ?: throw IOException("Not connected to the NATS server for persistent context")`
`201`	`194`	`if (!kv.keys().contains(name)) {`
`202`	`195`	`throw IOException("A variable with the name '$name' does not exist")`
`203`	`196`	`}`
`@@ -212,7 +205,8 @@ class NatsContext(`
`212`	`205`	`override fun getAll(): List<ContextVariable> =`
`213`	`206`	`synchronized(lock) {`
`214`	`207`	`runCatching {`
`215`		`- val kv = keyValue ?: throw IOException("Not connected to NATS for persistent context")`
	`208`	`+ val kv =`
	`209`	`+ keyValue ?: throw IOException("Not connected to the NATS server for persistent context")`
`216`	`210`	`kv.keys().map { key ->`
`217`	`211`	`val entry = kv.get(key)`
`218`	`212`	`ContextVariable(entry.key, entry.value)`
`@@ -231,7 +225,7 @@ class NatsContext(`
`231`	`225`	`conn.close()`
`232`	`226`	`}`
`233`	`227`	`}`
`234`		`- .onFailure { e -> throw IOException("Failed to close NATS persistent context", e) }`
	`228`	`+ .onFailure { e -> throw IOException("Failed to close the NATS persistent context", e) }`
`235`	`229`	`}`
`236`	`230`	`}`
`237`	`231`
Original file line number	Diff line number	Diff line change
`@@ -780,7 +780,7 @@ public void run() {`
`780`	`780`
`781`	`781`	`Thread.currentThread().interrupt();`
`782`	`782`	`} catch (Exception e) {`
`783`		`- logger.error("%s received a fatal error".formatted(stateMachineId.toString()), e);`
	`783`	`+ logger.error("{} received a fatal error", stateMachineId.toString(), e);`
`784`	`784`	`}`
`785`	`785`
`786`	`786`	`logger.info("{} has stopped", stateMachineId.toString());`