Merge pull request #97 from hkupty/minilogger-refactor

feat: Refactor mini logger

.circleci/config.yml

@@ -22,6 +22,8 @@ jobs:
           path: penna-api/build/reports/pmd/main.html
       - store_artifacts:
           path: penna-core/build/reports/pmd/main.html
+      - store_artifacts:
+          path: penna-core/.jqwik-database
       - store_artifacts:
           path: penna-dev/build/reports/pmd/main.html
       - store_artifacts:

.gitignore

@@ -22,3 +22,5 @@ gradle-app.setting
 .idea_modules/
 www/public
 www/resources
+
+.jqwik-database

buildSrc/src/main/groovy/penna.publishing.gradle

@@ -8,6 +8,12 @@ java {
     withSourcesJar()
 }
 
+jar {
+    manifest {
+        attributes 'Implementation-Version': version,
+                   'Implementation-Title': project.name
+    }
+}
 
 publishing {
     publications {

penna-api/src/main/java/module-info.java

@@ -13,4 +13,5 @@
 
     exports penna.api.models;
     exports penna.api.config;
+    exports penna.api.audit;
 }

penna-api/src/main/java/penna/api/audit/Logger.java

@@ -0,0 +1,32 @@
+package penna.api.audit;
+
+import penna.api.audit.internal.StdoutLogger;
+
+/**
+ * This class provides static methods for the logger to report back, specially during initialization.
+ * It is supposed to be as simple as possible and as minimally used as possible.
+ */
+public class Logger {
+    private Logger() {}
+    private static final PseudoLogger impl = new StdoutLogger();
+
+    /**
+     * Reports through the underlying logger some important event. To be used sparingly.
+     * @param level The target level.
+     * @param event The message to be printed.
+     */
+    public static void report(String level, String event) {
+        impl.report(level, event);
+    }
+
+    /**
+     * Reports an error, usually in the form of an {@link Exception}. To be used sparingly, in situations
+     * where the logger malfunctions and needs to explain upstream why it didn't work.
+     * @param level The target level.
+     * @param event The message to be printed.
+     * @param throwable The exception or error that caused the report.
+     */
+    public static void reportError(String level, String event, Throwable throwable) {
+        impl.reportError(level, event, throwable);
+    }
+}

penna-api/src/main/java/penna/api/audit/PseudoLogger.java

@@ -0,0 +1,22 @@
+package penna.api.audit;
+
+/**
+ * This is the internal logging mechanism, so we can still log important messages if something fails on initialization.
+ */
+public interface PseudoLogger {
+    /**
+     * This method should be used to notify an event;
+     * @param level How critical this event is;
+     * @param event The event as a short string;
+     */
+    void report(String level, String event);
+
+
+    /**
+     * This method should be used to notify a failure or an exception, handled or not;
+     * @param level How critical is the situation
+     * @param event The event as a short string;
+     * @param throwable The error that happened
+     */
+    void reportError(String level, String event, Throwable throwable);
+}

penna-api/src/main/java/penna/api/audit/internal/StdoutLogger.java

@@ -0,0 +1,49 @@
+package penna.api.audit.internal;
+
+import penna.api.audit.PseudoLogger;
+
+/**
+ * Simple string-concat based logger just to print important messages to stdout.
+ * See {@link PseudoLogger} for more information.
+ */
+public class StdoutLogger implements PseudoLogger {
+    private final String version = StdoutLogger.class.getPackage().getImplementationVersion();
+
+    /**
+     * Builds an audit logger instance.
+     * See {@link PseudoLogger} for more information.
+     */
+    public StdoutLogger() {}
+
+    @Override
+    public void report(String level, String event) {
+        String sb = "{\"logger\":\"penna.api.audit.Logger\",\"level\":\"" +
+                level +
+                "\",\"message\":\"" +
+                event +
+                "\",\"pennaVersion\":\"" +
+                version +
+                "\"}";
+        System.out.println(sb);
+    }
+
+    @Override
+    public void reportError(String level, String event, Throwable throwable) {
+        StringBuilder sb = new StringBuilder();
+        sb.append("{\"logger\":\"penna.api.audit.Logger\",\"level\":\"");
+        sb.append(level);
+        sb.append("\",\"message\":\"");
+        sb.append(event);
+        sb.append("\",\"error\":\"");
+        sb.append(throwable.getMessage());
+        sb.append("\",\"stacktrace\":\"");
+        for (StackTraceElement stackTraceElement : throwable.getStackTrace()) {
+            sb.append(stackTraceElement.toString());
+            sb.append("\\n");
+        }
+        sb.append("\",\"pennaVersion\":\"");
+        sb.append(version);
+        sb.append("\"}");
+        System.out.println(sb);
+    }
+}

penna-core/src/main/java/penna/core/logger/LogUnitContext.java

@@ -5,14 +5,15 @@
 import org.slf4j.event.LoggingEvent;
 import org.slf4j.spi.LoggingEventBuilder;
 import penna.core.internals.LogUnitContextPool;
-import penna.core.minilog.MiniLogger;
 import penna.core.models.KeyValuePair;
 import penna.core.models.PennaLogEvent;
 import penna.core.sink.Sink;
 
 import java.io.IOException;
 import java.util.function.Supplier;
 
+import static penna.api.audit.Logger.reportError;
+
 public record LogUnitContext(
         LogUnitContextPool pool,
         int selfReference,
@@ -116,7 +117,7 @@ public void log() {
         try {
             sink.write(logEvent);
         } catch (IOException e) {
-            MiniLogger.error("Unable to write log.", e);
+            reportError("ERROR", "Unable to write log.", e);
         } finally {
             release();
         }

penna-core/src/main/java/penna/core/sink/CoreSink.java

@@ -4,7 +4,6 @@
 import penna.api.models.LogField;
 import penna.core.internals.DirectJson;
 import penna.core.internals.StackTraceBloomFilter;
-import penna.core.minilog.MiniLogger;
 import penna.core.models.LogConfig;
 import penna.core.models.PennaLogEvent;
 import penna.core.slf4j.PennaMDCAdapter;
@@ -19,6 +18,8 @@
 import java.util.concurrent.atomic.AtomicLong;
 import java.util.function.BiConsumer;
 
+import static penna.api.audit.Logger.report;
+
 public final class CoreSink implements Sink, Closeable {
     private static final byte[] SUPPRESSED = "suppressed".getBytes();
     private static final byte[] STACKTRACE = "stacktrace".getBytes();
@@ -65,7 +66,7 @@ public CoreSink(WritableByteChannel channel) {
         if (MDC.getMDCAdapter() instanceof PennaMDCAdapter adapter) {
             mdcAdapter = adapter;
         } else {
-            MiniLogger.error("Not using PennaMDCAdapter for some reason! MDC will be off");
+            report("ERROR", "Not using PennaMDCAdapter for some reason! MDC will be off");
             mdcAdapter = null;
         }
         jsonGenerator = new DirectJson(channel);

penna-core/src/main/java/penna/core/slf4j/PennaServiceProvider.java

@@ -8,6 +8,8 @@
 import penna.api.config.Manager;
 import penna.core.internals.ManagerHolder;
 
+import static penna.api.audit.Logger.report;
+
 public final class PennaServiceProvider implements SLF4JServiceProvider {
 
     /**
@@ -50,5 +52,6 @@ public void initialize() {
         this.loggerFactory = pennaLoggerFactory;
         markerFactory = new BasicMarkerFactory();
         mdcAdapter = new PennaMDCAdapter();
+        report("INFO", "Penna initialized successfully");
     }
 }

penna-yaml-config/src/main/java/penna/config/yaml/YamlConfigProvider.java

@@ -10,6 +10,9 @@
 import java.util.Objects;
 import java.util.concurrent.atomic.AtomicBoolean;
 
+import static penna.api.audit.Logger.report;
+import static penna.api.audit.Logger.reportError;
+
 /**
  * Implementation of the {@link Provider} interface that extends the {@link Manager}
  * by adding configuration from a yaml file source.
@@ -57,9 +60,9 @@ public boolean register(Manager manager) {
             if (configMap.watch()) {
                 startWorker();
             }
-
             return true;
-        } catch (Exception ex) {
+        } catch (Exception ignored) {
+            report("INFO", "yaml config not registered");
             return false;
         }
     }
@@ -79,7 +82,9 @@ private void startWorker() {
                     }
                     key.reset();
                 }
-            } catch (Exception ignored) {}
+            } catch (Exception exception) {
+                reportError("WARN", "yaml config file watcher got error, closing", exception);
+            }
         });
     }
 
@@ -105,8 +110,8 @@ private void refresh() throws IOException {
     public void init() {
         try {
             refresh();
-        } catch (Exception ignored) {
-            // TODO log
+        } catch (Exception exception) {
+            reportError("WARN", "yaml config init got error", exception);
         }
     }
 }