Add logLevelFilter parameter

Signed-off-by: lisrte <[email protected]>
powsybl · May 27, 2024 · 209c335 · 209c335
1 parent 81b84f6
commit 209c335
Show file tree

Hide file tree

Showing 6 changed files with 34 additions and 11 deletions.
diff --git a/dynawaltz/src/main/java/com/powsybl/dynawaltz/DynaWaltzParameters.java b/dynawaltz/src/main/java/com/powsybl/dynawaltz/DynaWaltzParameters.java
@@ -41,6 +41,7 @@ public class DynaWaltzParameters extends AbstractExtension<DynamicSimulationPara
     public static final boolean DEFAULT_USE_MODEL_SIMPLIFIERS = false;
     public static final double DEFAULT_PRECISION = 1e-6;
     public static final ExportMode DEFAULT_TIMELINE_EXPORT_MODE = ExportMode.TXT;
+    public static final LogLevel DEFAULT_LOG_LEVEL_FILTER = LogLevel.INFO;
 
     /**
      * Information about the solver to use in the simulation
@@ -72,6 +73,13 @@ public String getFileExtension() {
         }
     }
 
+    public enum LogLevel {
+        DEBUG,
+        INFO,
+        WARN,
+        ERROR
+    }
+
     private Map<String, ParametersSet> modelsParameters = new LinkedHashMap<>();
     private ParametersSet networkParameters;
     private ParametersSet solverParameters;
@@ -82,6 +90,7 @@ public String getFileExtension() {
     private DumpFileParameters dumpFileParameters = DumpFileParameters.DEFAULT_DUMP_FILE_PARAMETERS;
     private double precision = DEFAULT_PRECISION;
     private ExportMode timelineExportMode = DEFAULT_TIMELINE_EXPORT_MODE;
+    private LogLevel logLevelFilter = DEFAULT_LOG_LEVEL_FILTER;
 
     /**
      * Loads parameters from the default platform configuration.
@@ -122,6 +131,7 @@ public static DynaWaltzParameters load(PlatformConfig platformConfig, FileSystem
             c.getOptionalBooleanProperty("useModelSimplifiers").ifPresent(parameters::setUseModelSimplifiers);
             c.getOptionalDoubleProperty("precision").ifPresent(parameters::setPrecision);
             c.getOptionalEnumProperty("timeline.exportMode", ExportMode.class).ifPresent(parameters::setTimelineExportMode);
+            c.getOptionalEnumProperty("log.levelFilter", LogLevel.class).ifPresent(parameters::setLogLevelFilter);
         });
         return parameters;
     }
@@ -244,4 +254,13 @@ public DynaWaltzParameters setTimelineExportMode(ExportMode timelineExportMode)
         this.timelineExportMode = timelineExportMode;
         return this;
     }
+
+    public LogLevel getLogLevelFilter() {
+        return logLevelFilter;
+    }
+
+    public DynaWaltzParameters setLogLevelFilter(LogLevel logLevelFilter) {
+        this.logLevelFilter = logLevelFilter;
+        return this;
+    }
 }
diff --git a/dynawaltz/src/main/java/com/powsybl/dynawaltz/xml/JobsXml.java b/dynawaltz/src/main/java/com/powsybl/dynawaltz/xml/JobsXml.java
@@ -87,6 +87,7 @@ private static void writeSimulation(XMLStreamWriter writer, DynaWaltzContext con
     }
 
     private static void writeOutput(XMLStreamWriter writer, DynaWaltzContext context) throws XMLStreamException {
+        DynaWaltzParameters parameters = context.getDynaWaltzParameters();
         writer.writeStartElement(DYN_URI, "outputs");
         writer.writeAttribute("directory", "outputs");
 
@@ -98,8 +99,8 @@ private static void writeOutput(XMLStreamWriter writer, DynaWaltzContext context
         writer.writeAttribute("exportMode", context.getDynaWaltzParameters().getTimelineExportMode().name());
 
         writer.writeEmptyElement(DYN_URI, "finalState");
-        writer.writeAttribute("exportIIDMFile", Boolean.toString(context.getDynaWaltzParameters().isWriteFinalState()));
-        writer.writeAttribute("exportDumpFile", Boolean.toString(context.getDynaWaltzParameters().getDumpFileParameters().exportDumpFile()));
+        writer.writeAttribute("exportIIDMFile", Boolean.toString(parameters.isWriteFinalState()));
+        writer.writeAttribute("exportDumpFile", Boolean.toString(parameters.getDumpFileParameters().exportDumpFile()));
 
         if (context.withCurves()) {
             writer.writeEmptyElement(DYN_URI, "curves");
@@ -108,16 +109,16 @@ private static void writeOutput(XMLStreamWriter writer, DynaWaltzContext context
         }
 
         writer.writeStartElement(DYN_URI, "logs");
-        writeAppender(writer);
+        writeAppender(writer, parameters);
         writer.writeEndElement();
 
         writer.writeEndElement();
     }
 
-    private static void writeAppender(XMLStreamWriter writer) throws XMLStreamException {
+    private static void writeAppender(XMLStreamWriter writer, DynaWaltzParameters parameters) throws XMLStreamException {
         writer.writeEmptyElement(DYN_URI, "appender");
         writer.writeAttribute("tag", "");
         writer.writeAttribute("file", "dynawaltz.log");
-        writer.writeAttribute("lvlFilter", "DEBUG");
+        writer.writeAttribute("lvlFilter", parameters.getLogLevelFilter().toString());
     }
 }
diff --git a/dynawaltz/src/test/java/com/powsybl/dynawaltz/DynaWaltzParametersTest.java b/dynawaltz/src/test/java/com/powsybl/dynawaltz/DynaWaltzParametersTest.java
@@ -12,7 +12,6 @@
 import com.powsybl.commons.test.AbstractSerDeTest;
 import com.powsybl.dynamicsimulation.DynamicSimulationParameters;
 import com.powsybl.dynamicsimulation.json.JsonDynamicSimulationParameters;
-import com.powsybl.dynawaltz.DynaWaltzParameters.ExportMode;
 import com.powsybl.dynawaltz.DynaWaltzParameters.SolverType;
 import com.powsybl.dynawaltz.parameters.Parameter;
 import com.powsybl.dynawaltz.parameters.ParameterType;
@@ -61,7 +60,8 @@ void checkParameters() throws IOException {
         boolean useModelSimplifiers = true;
         double precision = 1e-8;
         ExportMode timelinExportMode = ExportMode.XML;
-        initPlatformConfig(networkParametersId, solverType, solverParametersId, mergeLoads, useModelSimplifiers, precision, timelinExportMode);
+        DynaWaltzParameters.LogLevel logLevel = DynaWaltzParameters.LogLevel.WARN;
+        initPlatformConfig(networkParametersId, solverType, solverParametersId, mergeLoads, useModelSimplifiers, precision, timelinExportMode, logLevel);
 
         DynaWaltzParameters parameters = DynaWaltzParameters.load(platformConfig, fileSystem);
 
@@ -94,6 +94,7 @@ void checkParameters() throws IOException {
         assertEquals(useModelSimplifiers, parameters.isUseModelSimplifiers());
         assertEquals(precision, parameters.getPrecision());
         assertEquals(timelinExportMode, parameters.getTimelineExportMode());
+        assertEquals(logLevel, parameters.getLogLevelFilter());
     }
 
     @Test
@@ -116,7 +117,7 @@ void roundTripParametersSerializing() throws IOException {
         SolverType solverType = SolverType.IDA;
         String solverParametersId = "solverParametersId";
         boolean mergeLoads = false;
-        initPlatformConfig(networkParametersId, solverType, solverParametersId, mergeLoads, false, 1e-7, ExportMode.TXT);
+        initPlatformConfig(networkParametersId, solverType, solverParametersId, mergeLoads, false, 1e-7, ExportMode.TXT, DynaWaltzParameters.LogLevel.INFO);
 
         DynamicSimulationParameters dynamicSimulationParameters = new DynamicSimulationParameters()
                 .setStartTime(0)
@@ -127,7 +128,7 @@ void roundTripParametersSerializing() throws IOException {
                 JsonDynamicSimulationParameters::read, "/DynaWaltzParameters.json");
     }
 
-    private void initPlatformConfig(String networkParametersId, SolverType solverType, String solverParametersId, boolean mergeLoads, boolean useModelSimplifiers, double precision, ExportMode timelineExportMode) throws IOException {
+    private void initPlatformConfig(String networkParametersId, SolverType solverType, String solverParametersId, boolean mergeLoads, boolean useModelSimplifiers, double precision, ExportMode timelineExportMode, DynaWaltzParameters.LogLevel logLevel) throws IOException {
         String parametersFile = USER_HOME + "parametersFile";
         String networkParametersFile = USER_HOME + "networkParametersFile";
         String solverParametersFile = USER_HOME + "solverParametersFile";
@@ -143,6 +144,7 @@ private void initPlatformConfig(String networkParametersId, SolverType solverTyp
         moduleConfig.setStringProperty("useModelSimplifiers", String.valueOf(useModelSimplifiers));
         moduleConfig.setStringProperty("precision", Double.toString(precision));
         moduleConfig.setStringProperty("timeline.exportMode", String.valueOf(timelineExportMode));
+        moduleConfig.setStringProperty("log.levelFilter", logLevel.toString());
 
         Files.createDirectories(fileSystem.getPath(USER_HOME));
         copyFile("/parametersSet/models.par", parametersFile);

diff --git a/dynawaltz/src/test/resources/DynaWaltzParameters.json b/dynawaltz/src/test/resources/DynaWaltzParameters.json
@@ -48,6 +48,7 @@
       },
       "precision" : 1.0E-7,
       "timelineExportMode" : "TXT",
+      "logLevelFilter" : "INFO",
       "modelsParameters" : [ {
         "id" : "test",
         "parameters" : {

diff --git a/dynawaltz/src/test/resources/jobs.xml b/dynawaltz/src/test/resources/jobs.xml
@@ -15,7 +15,7 @@
             <dyn:finalState exportIIDMFile="true" exportDumpFile="false"/>
             <dyn:curves inputFile="powsybl_dynawaltz.crv" exportMode="CSV"/>
             <dyn:logs>
-                <dyn:appender tag="" file="dynawaltz.log" lvlFilter="DEBUG"/>
+                <dyn:appender tag="" file="dynawaltz.log" lvlFilter="INFO"/>
             </dyn:logs>
         </dyn:outputs>
     </dyn:job>

diff --git a/dynawaltz/src/test/resources/jobsWithDump.xml b/dynawaltz/src/test/resources/jobsWithDump.xml
@@ -16,7 +16,7 @@
             <dyn:finalState exportIIDMFile="true" exportDumpFile="true"/>
             <dyn:curves inputFile="powsybl_dynawaltz.crv" exportMode="CSV"/>
             <dyn:logs>
-                <dyn:appender tag="" file="dynawaltz.log" lvlFilter="DEBUG"/>
+                <dyn:appender tag="" file="dynawaltz.log" lvlFilter="INFO"/>
             </dyn:logs>
         </dyn:outputs>
     </dyn:job>