Merge branch 'dev' into ms/#53-upgrate-to-scala3

# Conflicts:
#	src/main/scala/edu/ie3/simona/config/OutputConfig.scala

Author: staudtMarius

CHANGELOG.md

@@ -71,6 +71,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Add conversion utils between `ComparableQuantity` and `Squants` [#1313](https://github.com/ie3-institute/simona/issues/1313)
 - Implementing auto-merge for dependabot PRs [#1339](https://github.com/ie3-institute/simona/issues/1339)
 - Introduce operatingPoints also to `ThermalGrid` [#1338](https://github.com/ie3-institute/simona/issues/1338)
+- Added configuration for console log level [#1364](https://github.com/ie3-institute/simona/issues/1364)
 
 ### Changed
 - Adapted to changed data source in PSDM [#435](https://github.com/ie3-institute/simona/issues/435)

docs/readthedocs/config.md

@@ -181,6 +181,24 @@ simona.output.thermal.individualConfigs = [
 Further model classes which can be used to load the outcome of a system simulation are described in [PSDM](https://powersystemdatamodel.readthedocs.io/en/latest/models/models.html#result).
 Data sources and data sinks are explained in the [I/O-capabilities](https://powersystemdatamodel.readthedocs.io/en/latest/io/basiciousage.html) section of the PSDM.
 
+## Logging level configuration
+
+To specify which log statements should be logged in the `simona.log` file and which log statements should be printed to
+the console, SIMONA offers the user two configuration options.
+
+The first options sets the default log level for the log file as well as the console.
+
+```
+simona.output.log.level = "INFO"
+```
+
+If the console should use a different log level, this level must be selected in the following example.
+
+```
+simona.output.log.consoleLevel = "DEBUG"
+```
+
+
 ## Runtime configuration 
 
 Specification of the runtime of subgrids and voltage levels:

input/samples/vn_simona/vn_simona.conf

@@ -101,6 +101,7 @@ simona.output.thermal = {
 }
 
 simona.output.log.level = "INFO"
+simona.output.log.consoleLevel = "INFO"
 
 ##################################################################
 # Runtime Configuration // todo refactor as this naming is misleading and partly unneeded

src/main/resources/logback.xml

@@ -6,19 +6,6 @@
   -->
 
 <configuration>
-    <timestamp key="bySecond" datePattern="yyyyMMdd'T'HHmmss"/>
-    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
-        <!-- encoders are assigned the type
-             ch.qos.logback.classic.encoder.PatternLayoutEncoder by default -->
-        <encoder>
-            <pattern>%highlight%d{HH:mm:ss.SSS} %-5level %logger{36} - %msg%n</pattern>
-        </encoder>
-        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
-            <level>INFO</level>
-        </filter>
-    </appender>
     <!-- File appender is configured and added by edu.ie3.simona.logging.logback.LogbackConfiguration -->
-    <root level="debug">
-        <appender-ref ref="STDOUT"/>
-    </root>
+    <!-- Console appender is configured and added by edu.ie3.simona.logging.logback.LogbackConfiguration -->
 </configuration>

src/main/scala/edu/ie3/simona/config/ConfigFailFast.scala

@@ -766,6 +766,13 @@ object ConfigFailFast extends LazyLogging {
       throw new InvalidConfigParameterException(
         s"Invalid log level \"${subConfig.level}\". Valid log levels: ${validLogLevels.mkString(", ")}"
       )
+
+    subConfig.consoleLevel.foreach { level =>
+      if (!validLogLevels.contains(level))
+        throw new InvalidConfigParameterException(
+          s"Invalid console log level \"$level\". Valid log levels: ${validLogLevels.mkString(", ")}"
+        )
+    }
   }
 
   /** Checks resolution of power flow calculation

src/main/scala/edu/ie3/simona/config/OutputConfig.scala

@@ -124,10 +124,14 @@ object OutputConfig {
 
   /** The configuration for the logger.
     * @param level
-    *   Of the logger.
+    *   Of the logger (default: INFO).
+    * @param consoleLevel
+    *   Option for a separate console log level (default: None -> uses file
+    *   level).
     */
   final case class Log(
-      level: String = "INFO"
+      level: String = "INFO",
+      consoleLevel: Option[String] = None,
   ) derives ConfigConvert
 
   /** Configuration for output sink.

src/main/scala/edu/ie3/simona/logging/logback/LogbackConfiguration.scala

@@ -10,15 +10,20 @@ import ch.qos.logback.classic.LoggerContext
 import ch.qos.logback.classic.encoder.PatternLayoutEncoder
 import ch.qos.logback.classic.filter.ThresholdFilter
 import ch.qos.logback.classic.spi.ILoggingEvent
-import ch.qos.logback.core.FileAppender
+import ch.qos.logback.core.{ConsoleAppender, FileAppender}
 import com.typesafe.scalalogging.LazyLogging
 import org.slf4j.LoggerFactory
 
 import java.nio.file.Path
 
 object LogbackConfiguration extends LazyLogging {
 
-  def default(logLevel: String)(logPath: Path): Unit = {
+  def default(logLevel: String, console: Option[String] = None)(
+      logPath: Path
+  ): Unit = {
+    // if no config log level is given, we use the log level of the file
+    val consoleLogLevel = console.getOrElse(logLevel)
+
     LoggerFactory.getILoggerFactory match {
       case loggerContext: LoggerContext =>
         val rootLogger = loggerContext.getLogger("root")
@@ -35,30 +40,26 @@ object LogbackConfiguration extends LazyLogging {
           )
         )
 
+        rootLogger.addAppender(
+          createConsoleAppender(consoleLogLevel, loggerContext)
+        )
+
       case factory =>
         logger.error(
           s"Cannot configure simulation run logger! Invalid factory: $factory"
         )
     }
   }
 
-  /** Creates a FileAppender that logs to given path
+  /** Creates a FileAppender that logs to given path.
     */
   private def createFileAppender(
       logPath: Path,
       logLevel: String,
       appenderName: String,
       loggerContext: LoggerContext,
   ): FileAppender[ILoggingEvent] = {
-
-    val layoutEncoder = new PatternLayoutEncoder
-    layoutEncoder.setPattern("%d{HH:mm:ss.SSS} %-5level %logger{36} - %msg%n")
-    layoutEncoder.setContext(loggerContext)
-    layoutEncoder.start()
-
-    val filter = new ThresholdFilter()
-    filter.setLevel(logLevel)
-    filter.start()
+    val (layoutEncoder, filter) = configure(logLevel, loggerContext)
 
     val fileAppender = new FileAppender[ILoggingEvent]
     fileAppender.setFile(logPath.toString)
@@ -71,4 +72,43 @@ object LogbackConfiguration extends LazyLogging {
     fileAppender
   }
 
+  /** Creates a ConsoleAppender that logs to the console.
+    */
+  private def createConsoleAppender(
+      logLevel: String,
+      loggerContext: LoggerContext,
+  ): ConsoleAppender[ILoggingEvent] = {
+    val (layoutEncoder, filter) = configure(logLevel, loggerContext)
+
+    val consoleAppender = new ConsoleAppender[ILoggingEvent]
+    consoleAppender.setEncoder(layoutEncoder)
+    consoleAppender.setContext(loggerContext)
+    consoleAppender.setName("STDOUT")
+    consoleAppender.addFilter(filter)
+    consoleAppender.start()
+    consoleAppender
+  }
+
+  /** Basic configuration for an appender.
+    * @param logLevel
+    *   The log level to use.
+    * @param loggerContext
+    *   The context of the logger.
+    */
+  private def configure(
+      logLevel: String,
+      loggerContext: LoggerContext,
+  ): (PatternLayoutEncoder, ThresholdFilter) = {
+    val layoutEncoder = new PatternLayoutEncoder
+    layoutEncoder.setPattern("%d{HH:mm:ss.SSS} %-5level %logger{36} - %msg%n")
+    layoutEncoder.setContext(loggerContext)
+    layoutEncoder.start()
+
+    val filter = new ThresholdFilter()
+    filter.setLevel(logLevel)
+    filter.start()
+
+    (layoutEncoder, filter)
+  }
+
 }

src/main/scala/edu/ie3/simona/sim/setup/SetupHelper.scala

@@ -242,6 +242,8 @@ trait SetupHelper extends LazyLogging {
     val modelsToWrite =
       SetupHelper.allResultEntitiesToWrite(simonaConfig.simona.output)
 
+    val simonaLogConfig = simonaConfig.simona.output.log
+
     ResultFileHierarchy(
       simonaConfig.simona.output.base.dir,
       simonaConfig.simona.simulationName,
@@ -252,8 +254,8 @@ trait SetupHelper extends LazyLogging {
           simonaConfig.simona.simulationName,
         ),
       ),
-      configureLogger =
-        LogbackConfiguration.default(simonaConfig.simona.output.log.level),
+      configureLogger = LogbackConfiguration
+        .default(simonaLogConfig.level, simonaLogConfig.consoleLevel),
       config = Some((typeSafeConfig, simonaConfig)),
       addTimeStampToOutputDir =
         simonaConfig.simona.output.base.addTimestampToOutputDir,

src/test/scala/edu/ie3/simona/event/listener/ResultEventListenerSpec.scala

@@ -22,6 +22,7 @@ import edu.ie3.simona.event.ResultEvent.{
 }
 import edu.ie3.simona.io.result.ResultSinkType.Csv
 import edu.ie3.simona.io.result.{ResultEntitySink, ResultSinkType}
+import edu.ie3.simona.logging.logback.LogbackConfiguration
 import edu.ie3.simona.test.common.result.PowerFlowResultData
 import edu.ie3.simona.test.common.{IOTestCommons, UnitSpec}
 import edu.ie3.simona.util.ResultFileHierarchy
@@ -35,6 +36,7 @@ import org.apache.pekko.actor.testkit.typed.scaladsl.{
 import org.apache.pekko.testkit.TestKit.awaitCond
 
 import java.io.{File, FileInputStream}
+import java.nio.file.Path
 import java.util.UUID
 import java.util.zip.GZIPInputStream
 import scala.concurrent.ExecutionContext.Implicits.global
@@ -84,6 +86,7 @@ class ResultEventListenerSpec
         classes,
         resultSinkType,
       ),
+      configureLogger = LogbackConfiguration.default("INFO", Some("ERROR"))(_),
     )
   }
 

src/test/scala/edu/ie3/simona/integration/RunSimonaStandaloneIT.scala

@@ -55,6 +55,12 @@ class RunSimonaStandaloneIT
             "simona.time.endDateTime",
             ConfigValueFactory.fromAnyRef("2011-01-01T02:00:00Z"),
           )
+          .withFallback(
+            ConfigFactory.parseString("""
+                |simona.output.log.level = "INFO"
+                |simona.output.log.consoleLevel = "ERROR"
+                |""".stripMargin)
+          )
           .withFallback(
             ConfigFactory
               .parseString("""

src/test/scala/edu/ie3/simona/io/file/ResultFileHierarchySpec.scala

@@ -8,9 +8,9 @@ package edu.ie3.simona.io.file
 
 import java.io.File
 import java.nio.file.{Files, Path}
-
 import edu.ie3.datamodel.models.result.system.PvResult
 import edu.ie3.simona.io.result.ResultSinkType
+import edu.ie3.simona.logging.logback.LogbackConfiguration
 import edu.ie3.simona.test.common.{IOTestCommons, UnitSpec}
 import edu.ie3.simona.util.ResultFileHierarchy
 import edu.ie3.simona.util.ResultFileHierarchy.ResultEntityPathConfig
@@ -49,6 +49,8 @@ class ResultFileHierarchySpec
             Set(classOf[PvResult]),
             ResultSinkType.Csv("csv", "pref", "suff"),
           ),
+          configureLogger =
+            LogbackConfiguration.default("INFO", Some("ERROR"))(_),
         )
 
       validOutputFileHierarchy.tmpDir.toString shouldBe validOutputFileHierarchy.runOutputDir.toString + fileSeparator + "tmp"
@@ -75,6 +77,8 @@ class ResultFileHierarchySpec
             Set(classOf[PvResult]),
             ResultSinkType.Csv("csv", "pref", "suff"),
           ),
+          configureLogger =
+            LogbackConfiguration.default("INFO", Some("ERROR"))(_),
         )
 
       // check for existence of run output dir

src/test/scala/edu/ie3/simona/io/result/ResultEntityKafkaSpec.scala

@@ -12,6 +12,7 @@ import edu.ie3.simona.event.ResultEvent.PowerFlowResultEvent
 import edu.ie3.simona.event.listener.ResultEventListener
 import edu.ie3.simona.io.result.plain.PlainResult.PlainNodeResult
 import edu.ie3.simona.io.result.plain.PlainWriter
+import edu.ie3.simona.logging.logback.LogbackConfiguration
 import edu.ie3.simona.test.KafkaSpecLike
 import edu.ie3.simona.test.KafkaSpecLike.Topic
 import edu.ie3.simona.util.ResultFileHierarchy
@@ -103,6 +104,8 @@ class ResultEntityKafkaSpec
                 20,
               ),
             ),
+            configureLogger =
+              LogbackConfiguration.default("INFO", Some("ERROR"))(_),
           )
         )
       )