Merge pull request #395 from ie3-institute/hotfix/jh/#394-fix-logging-imports

ckittl · web-flow · commit 9e058b8e7d55 · 2021-07-09T13:00:10.000+02:00
Replace LogManager with LogFactory
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased/Snapshot]
 
+## [2.0.1] - 2021-07-08
+
+### Fixed
+- fix CHANGELOG.md
+- replace `LogManager` calls with `LogFactory` for facade logging support
+
+## [2.0.0] - 2021-05-21
+
 ### Added
 -   definition for a default input file directory structure
 -   tarball utils to extract and compress files
@@ -86,5 +94,7 @@ coordinates or multiple exactly equal coordinates possible
 -   CsvDataSource now stops trying to get an operator for empty operator uuid field in entities
 -   CsvDataSource now parsing multiple geoJson strings correctly
 
-[Unreleased/Snapshot]: https://github.com/ie3-institute/powersystemdatamodel/compare/1.1.0...HEAD
+[Unreleased/Snapshot]: https://github.com/ie3-institute/powersystemdatamodel/compare/2.0.1...HEAD
+[2.0.1]: https://github.com/ie3-institute/powersystemdatamodel/compare/2.0.0...2.0.1
+[2.0.0]: https://github.com/ie3-institute/powersystemdatamodel/compare/1.1.0...2.0.0
 [1.1.0]: https://github.com/ie3-institute/powersystemdatamodel/compare/6a49bc514be8859ebd29a3595cd58cd000498f1e...1.1.0
diff --git a/src/main/java/edu/ie3/datamodel/io/connectors/CsvFileConnector.java b/src/main/java/edu/ie3/datamodel/io/connectors/CsvFileConnector.java
@@ -23,8 +23,8 @@
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
 import org.apache.commons.io.FilenameUtils;
-import org.apache.logging.log4j.LogManager;
-import org.apache.logging.log4j.Logger;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 /**
  * Provides the connector (here: buffered writer) for specific files to be used by a {@link
@@ -34,7 +34,7 @@
  * @since 19.03.20
  */
 public class CsvFileConnector implements DataConnector {
-  private static final Logger log = LogManager.getLogger(CsvFileConnector.class);
+  private static final Logger log = LoggerFactory.getLogger(CsvFileConnector.class);
 
   private final Map<Class<? extends UniqueEntity>, BufferedCsvWriter> entityWriters =
       new HashMap<>();
@@ -160,8 +160,8 @@ public BufferedReader initReader(Class<? extends UniqueEntity> clz) throws FileN
     } catch (ConnectorException e) {
       log.error(
           "Cannot get reader for entity '{}' as no file naming strategy for this file exists. Exception: {}",
-          clz::getSimpleName,
-          () -> e);
+          clz.getSimpleName(),
+          e);
     }
     return initReader(filePath);
   }
diff --git a/src/main/java/edu/ie3/datamodel/io/connectors/SqlConnector.java b/src/main/java/edu/ie3/datamodel/io/connectors/SqlConnector.java
@@ -9,16 +9,16 @@
 import edu.ie3.util.TimeUtil;
 import java.sql.*;
 import java.util.*;
-import org.apache.logging.log4j.LogManager;
-import org.apache.logging.log4j.Logger;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 /**
  * Implements a DataConnector for a native SQL connection to a relational database. It was
  * implemented with a PostgreSQL database in mind, so there might be dialect issues if used with
  * other databases.
  */
 public class SqlConnector implements DataConnector {
-  private static final Logger log = LogManager.getLogger(SqlConnector.class);
+  public static final Logger log = LoggerFactory.getLogger(SqlConnector.class);
 
   private final String jdbcUrl;
   private final Properties connectionProps;
diff --git a/src/main/java/edu/ie3/datamodel/io/extractor/Extractor.java b/src/main/java/edu/ie3/datamodel/io/extractor/Extractor.java
@@ -12,8 +12,8 @@
 import edu.ie3.datamodel.models.input.OperatorInput;
 import java.util.*;
 import java.util.concurrent.CopyOnWriteArrayList;
-import org.apache.logging.log4j.LogManager;
-import org.apache.logging.log4j.Logger;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 /**
  * A simple utility class that can be used by sinks to extract nested elements (e.g. nodes, types)
@@ -24,7 +24,7 @@
  */
 public final class Extractor {
 
-  private static final Logger log = LogManager.getLogger(Extractor.class);
+  private static final Logger log = LoggerFactory.getLogger(Extractor.class);
 
   private Extractor() {
     throw new IllegalStateException("Utility classes cannot be instantiated");
@@ -78,8 +78,8 @@ public static Set<InputEntity> extractElements(NestedEntity nestedEntity)
                 } catch (ExtractorException e) {
                   log.error(
                       "An error occurred during extraction of nested entity '{}':{}",
-                      () -> element.getClass().getSimpleName(),
-                      () -> e);
+                      element.getClass().getSimpleName(),
+                      e);
                 }
               }
             });
diff --git a/src/main/java/edu/ie3/datamodel/io/factory/Factory.java b/src/main/java/edu/ie3/datamodel/io/factory/Factory.java
@@ -9,8 +9,8 @@
 import java.util.*;
 import java.util.function.IntFunction;
 import java.util.stream.Collectors;
-import org.apache.logging.log4j.LogManager;
-import org.apache.logging.log4j.Logger;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 /**
  * Abstract factory class, that is able to transfer specific "flat" information in to actual model
@@ -22,7 +22,7 @@
  *     edu.ie3.datamodel.io.factory.timeseries.TimeBasedValueFactory})).
  */
 public abstract class Factory<C, D extends FactoryData, R> {
-  public static final Logger log = LogManager.getLogger(Factory.class);
+  public static final Logger log = LoggerFactory.getLogger(Factory.class);
 
   private final List<Class<? extends C>> supportedClasses;
 
diff --git a/src/main/java/edu/ie3/datamodel/io/naming/EntityPersistenceNamingStrategy.java b/src/main/java/edu/ie3/datamodel/io/naming/EntityPersistenceNamingStrategy.java
@@ -27,8 +27,8 @@
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
 import org.apache.commons.io.FilenameUtils;
-import org.apache.logging.log4j.LogManager;
-import org.apache.logging.log4j.Logger;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 /**
  * Provides an easy to use standard way to name files, tables or any other persistent representation
@@ -42,7 +42,7 @@
 public class EntityPersistenceNamingStrategy {
 
   protected static final Logger logger =
-      LogManager.getLogger(EntityPersistenceNamingStrategy.class);
+      LoggerFactory.getLogger(EntityPersistenceNamingStrategy.class);
 
   private static final String UUID_STRING =
       "[a-zA-Z0-9]{8}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{12}";
diff --git a/src/main/java/edu/ie3/datamodel/io/processor/EntityProcessor.java b/src/main/java/edu/ie3/datamodel/io/processor/EntityProcessor.java
@@ -13,8 +13,8 @@
 import javax.measure.Quantity;
 import javax.measure.quantity.Energy;
 import javax.measure.quantity.Power;
-import org.apache.logging.log4j.LogManager;
-import org.apache.logging.log4j.Logger;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 /**
  * Internal API Interface for EntityProcessors. Main purpose is to 'de-serialize' models into a
@@ -26,7 +26,7 @@
  */
 public abstract class EntityProcessor<T extends UniqueEntity> extends Processor<T> {
 
-  public static final Logger log = LogManager.getLogger(EntityProcessor.class);
+  public static final Logger log = LoggerFactory.getLogger(EntityProcessor.class);
   protected final String[] headerElements;
   private final SortedMap<String, Method> fieldNameToMethod;
 
diff --git a/src/main/java/edu/ie3/datamodel/io/processor/ProcessorProvider.java b/src/main/java/edu/ie3/datamodel/io/processor/ProcessorProvider.java
@@ -19,8 +19,8 @@
 import edu.ie3.datamodel.models.value.Value;
 import java.util.*;
 import java.util.stream.Collectors;
-import org.apache.logging.log4j.LogManager;
-import org.apache.logging.log4j.Logger;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 /**
  * Wrapper providing the class specific processor to convert an instance of a {@link UniqueEntity}
@@ -34,7 +34,7 @@
  */
 public class ProcessorProvider {
 
-  private static final Logger log = LogManager.getLogger(ProcessorProvider.class);
+  private static final Logger log = LoggerFactory.getLogger(ProcessorProvider.class);
 
   /** unmodifiable map of all processors that has been provided on construction */
   private final Map<Class<? extends UniqueEntity>, EntityProcessor<? extends UniqueEntity>>
diff --git a/src/main/java/edu/ie3/datamodel/io/sink/CsvFileSink.java b/src/main/java/edu/ie3/datamodel/io/sink/CsvFileSink.java
@@ -36,8 +36,8 @@
 import java.util.*;
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
-import org.apache.logging.log4j.LogManager;
-import org.apache.logging.log4j.Logger;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 /**
  * Sink that provides all capabilities to write {@link UniqueEntity}s to .csv-files. Be careful
@@ -51,7 +51,7 @@
  */
 public class CsvFileSink implements InputDataSink, OutputDataSink {
 
-  private static final Logger log = LogManager.getLogger(CsvFileSink.class);
+  private static final Logger log = LoggerFactory.getLogger(CsvFileSink.class);
 
   private final CsvFileConnector connector;
   private final ProcessorProvider processorProvider;
@@ -294,10 +294,7 @@ public <E extends TimeSeriesEntry<V>, V extends Value> void persistTimeSeries(
             try {
               writer.write(csvEntityFieldData(data));
             } catch (IOException e) {
-              log.error(
-                  "Cannot write the following entity data: '{}'. Exception: {}",
-                  () -> data,
-                  () -> e);
+              log.error("Cannot write the following entity data: '{}'. Exception: {}", data, e);
             } catch (SinkException e) {
               log.error("Exception occurred during processing the provided data fields: ", e);
             }
@@ -350,8 +347,8 @@ private <C extends UniqueEntity> void write(C entity) {
     } catch (SinkException e) {
       log.error(
           "Cannot persist provided entity '{}'. Exception: {}",
-          () -> entity.getClass().getSimpleName(),
-          () -> e);
+          entity.getClass().getSimpleName(),
+          e);
     }
   }
 
diff --git a/src/main/java/edu/ie3/datamodel/io/sink/InfluxDbSink.java b/src/main/java/edu/ie3/datamodel/io/sink/InfluxDbSink.java
@@ -19,14 +19,14 @@
 import java.util.*;
 import java.util.concurrent.TimeUnit;
 import java.util.stream.Collectors;
-import org.apache.logging.log4j.LogManager;
-import org.apache.logging.log4j.Logger;
 import org.influxdb.dto.BatchPoints;
 import org.influxdb.dto.Point;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 /** InfluxDB Sink for result and time series data */
 public class InfluxDbSink implements OutputDataSink {
-  private static final Logger log = LogManager.getLogger(InfluxDbSink.class);
+  public static final Logger log = LoggerFactory.getLogger(InfluxDbSink.class);
   /** Field name for time */
   private static final String FIELD_NAME_TIME = "time";
   /** Field name for input model uuid field in result entities */
@@ -151,8 +151,8 @@ private Optional<Point> transformToPoint(ResultEntity entity, String measurement
     } catch (SinkException e) {
       log.error(
           "Cannot persist provided entity '{}'. Exception: {}",
-          () -> entity.getClass().getSimpleName(),
-          () -> e);
+          entity.getClass().getSimpleName(),
+          e);
     }
     return Optional.empty();
   }
@@ -218,7 +218,7 @@ private <E extends TimeSeriesEntry<V>, V extends Value> Set<Point> transformToPo
         points.add(point);
       }
     } catch (SinkException e) {
-      log.error("Cannot persist provided time series '{}'. Exception: {}", () -> key, () -> e);
+      log.error("Cannot persist provided time series '{}'. Exception: {}", key, e);
     }
     return points;
   }
@@ -244,8 +244,8 @@ private <C extends UniqueEntity> Set<Point> extractPoints(C entity) {
       } catch (SinkException e) {
         log.error(
             "Cannot persist provided entity '{}'. Exception: {}",
-            () -> entity.getClass().getSimpleName(),
-            () -> e);
+            entity.getClass().getSimpleName(),
+            e);
       }
     } else if (entity instanceof TimeSeries) {
       TimeSeries<?, ?> timeSeries = (TimeSeries<?, ?>) entity;
diff --git a/src/main/java/edu/ie3/datamodel/io/source/couchbase/CouchbaseWeatherSource.java b/src/main/java/edu/ie3/datamodel/io/source/couchbase/CouchbaseWeatherSource.java
@@ -26,13 +26,13 @@
 import java.util.concurrent.CompletionException;
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
-import org.apache.logging.log4j.LogManager;
-import org.apache.logging.log4j.Logger;
 import org.locationtech.jts.geom.Point;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 /** Couchbase Source for weather data */
 public class CouchbaseWeatherSource implements WeatherSource {
-  private static final Logger logger = LogManager.getLogger(CouchbaseWeatherSource.class);
+  private static final Logger logger = LoggerFactory.getLogger(CouchbaseWeatherSource.class);
   private static final String DEFAULT_TIMESTAMP_PATTERN = "yyyy-MM-dd'T'HH:mm:ssxxx";
   /** The start of the document key, comparable to a table name in relational databases */
   private static final String DEFAULT_KEY_PREFIX = "weather";
@@ -112,7 +112,7 @@ public Map<Point, IndividualTimeSeries<WeatherValue>> getWeather(
         try {
           jsonWeatherInputs = queryResult.rowsAsObject();
         } catch (DecodingFailureException ex) {
-          logger.error(ex);
+          logger.error("Querying weather inputs failed!", ex);
         }
         if (jsonWeatherInputs != null && !jsonWeatherInputs.isEmpty()) {
           Set<TimeBasedValue<WeatherValue>> weatherInputs =
@@ -143,7 +143,7 @@ public Optional<TimeBasedValue<WeatherValue>> getWeather(ZonedDateTime date, Poi
       JsonObject jsonWeatherInput = getResult.contentAsObject();
       return toTimeBasedWeatherValue(jsonWeatherInput);
     } catch (DecodingFailureException ex) {
-      logger.error(ex);
+      logger.error("Decoding to TimeBasedWeatherValue failed!", ex);
       return Optional.empty();
     } catch (DocumentNotFoundException ex) {
       return Optional.empty();
diff --git a/src/main/java/edu/ie3/datamodel/io/source/csv/CsvDataSource.java b/src/main/java/edu/ie3/datamodel/io/source/csv/CsvDataSource.java
@@ -32,8 +32,8 @@
 import java.util.stream.Collectors;
 import java.util.stream.IntStream;
 import java.util.stream.Stream;
-import org.apache.logging.log4j.LogManager;
-import org.apache.logging.log4j.Logger;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 /**
  * Parent class of all .csv file related sources containing methods and fields consumed by allmost
@@ -44,7 +44,7 @@
  */
 public abstract class CsvDataSource {
 
-  protected static final Logger log = LogManager.getLogger(CsvDataSource.class);
+  protected static final Logger log = LoggerFactory.getLogger(CsvDataSource.class);
 
   // general fields
   protected final String csvSep;
@@ -136,9 +136,9 @@ private Map<String, String> buildFieldsToAttributes(
     } catch (Exception e) {
       log.error(
           "Cannot build fields to attributes map for row '{}' with headline '{}'.\nException: {}",
-          csvRow::trim,
-          () -> String.join(",", headline),
-          () -> e);
+          csvRow.trim(),
+          String.join(",", headline),
+          e);
     }
     return insensitiveFieldsToAttributes;
   }
diff --git a/src/main/java/edu/ie3/datamodel/io/source/sql/SqlWeatherSource.java b/src/main/java/edu/ie3/datamodel/io/source/sql/SqlWeatherSource.java
@@ -21,13 +21,13 @@
 import java.util.*;
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
-import org.apache.logging.log4j.LogManager;
-import org.apache.logging.log4j.Logger;
 import org.locationtech.jts.geom.Point;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 /** SQL source for weather data */
 public class SqlWeatherSource implements WeatherSource {
-  private static final Logger logger = LogManager.getLogger(SqlWeatherSource.class);
+  public static final Logger logger = LoggerFactory.getLogger(SqlWeatherSource.class);
 
   private static final String DEFAULT_WEATHER_FETCHING_ERROR = "Error while fetching weather";
   private static final String WHERE = " WHERE ";
diff --git a/version.properties b/version.properties
@@ -1,8 +1,8 @@
 #Generated by the Semver Plugin for Gradle
-#Fri May 21 18:09:22 CEST 2021
+#Thu Jul 08 19:19:34 CEST 2021
 version.buildmeta=
 version.major=2
 version.minor=0
-version.patch=0
+version.patch=1
 version.prerelease=
-version.semver=2.0.0
+version.semver=2.0.1
