feat: SplitLogger, for sending errors to stderr and everything else to stdout (#844)

Author: c-dilks

common-tools/clas-analysis/src/main/java/org/jlab/analysis/postprocess/RebuildScalers.java

@@ -13,7 +13,6 @@
 import org.jlab.jnp.hipo4.data.Event;
 import org.jlab.jnp.hipo4.io.HipoReader;
 import org.jlab.jnp.hipo4.io.HipoWriterSorted;
-import org.jlab.logging.DefaultLogger;
 import org.jlab.utils.groups.IndexedTable;
 import org.jlab.utils.options.OptionParser;
 import org.jlab.utils.system.ClasUtilsFile;
@@ -32,8 +31,6 @@ public class RebuildScalers {
 
     public static void main(String[] args) {
 
-        DefaultLogger.debug();
-
         OptionParser parser = new OptionParser("rebuildscaler");
         parser.addRequired("-o","output.hipo");
         parser.addOption("-c", "0", "Fix DSC/RUN::scaler clock rollover");

common-tools/clas-analysis/src/main/java/org/jlab/analysis/postprocess/Tag1ToEvent.java

@@ -13,7 +13,7 @@
 import org.jlab.detector.helicity.HelicityBit;
 import org.jlab.detector.helicity.HelicitySequenceDelayed;
 import org.jlab.jnp.hipo4.data.SchemaFactory;
-import org.jlab.logging.DefaultLogger;
+import org.jlab.logging.SplitLogger;
 import org.jlab.utils.groups.IndexedTable;
 import org.jlab.utils.options.OptionParser;
 
@@ -31,19 +31,18 @@
 
 public class Tag1ToEvent {
 
-    static final Logger LOGGER = Logger.getLogger(Tag1ToEvent.class.getName());
+    static final Logger LOGGER = SplitLogger.create(Tag1ToEvent.class.getName());
 
     public static void main(String[] args) {
 
-        DefaultLogger.debug();
-
-        // Parse command-line options:
         OptionParser parser = new OptionParser("postprocess");
+        parser.useExternalLogger(); // necessary, since we have `LOGGER` here
         parser.addOption("-q","0","do beam charge and livetime (0/1=false/true)");
         parser.addOption("-d","0","do delayed helicity (0/1=false/true)");
         parser.addOption("-f","0","rebuild the HEL::flip banks (0/1=false/true)");
         parser.addRequired("-o","output.hipo");
         parser.parse(args);
+        SplitLogger.configureLevel(LOGGER, parser.getLogLevel());
         if (parser.getInputList().isEmpty()) {
             parser.printUsage();
             LOGGER.severe("No input file(s) specified.");

common-tools/clas-analysis/src/main/java/org/jlab/analysis/postprocess/Util.java

@@ -22,13 +22,15 @@
 import org.jlab.detector.helicity.HelicitySequenceDelayed;
 import org.jlab.detector.helicity.HelicitySequenceManager;
 
+import org.jlab.logging.SplitLogger;
+
 /**
  * Static utility methods for postprocessing.
  * @author baltzell
  */
 class Util {
 
-    static final Logger logger = Logger.getLogger(Util.class.getName());
+    static final Logger logger = SplitLogger.create(Util.class.getName());
 
     /**
      * Assign the delay-corrected helicity to the HEL::scaler bank's rows

common-tools/clas-detector/src/main/java/org/jlab/detector/calib/utils/ConstantsManager.java

@@ -13,6 +13,7 @@
 import java.util.logging.Logger;
 
 import org.jlab.utils.groups.IndexedTable;
+import org.jlab.logging.SplitLogger;
 
 /**
  *
@@ -22,7 +23,7 @@ public class ConstantsManager {
 
     public static final int DBERROR_SLEEP_SECONDS=3;
 
-    private static Logger LOGGER = Logger.getLogger(ConstantsManager.class.getName());
+    private static Logger LOGGER = SplitLogger.create(ConstantsManager.class.getName(), false);
 
     private DatabaseConstantsDescriptor defaultDescriptor = new DatabaseConstantsDescriptor();
     private volatile Map<Integer, DatabaseConstantsDescriptor> runConstants = new LinkedHashMap<Integer, DatabaseConstantsDescriptor>();
@@ -181,7 +182,7 @@ public String toString() {
      */
     public static class DatabaseConstantsDescriptor {
 
-        Logger LOGGER = Logger.getLogger(DatabaseConstantsDescriptor.class.getName());
+        Logger LOGGER = SplitLogger.create(DatabaseConstantsDescriptor.class.getName(), false);
 
         private String  descName   = "descriptor";
         private int     runNumber  = 10;

common-tools/clas-detector/src/main/java/org/jlab/detector/calib/utils/DatabaseConstantProvider.java

@@ -22,14 +22,15 @@
 import org.jlab.utils.groups.IndexedTable;
 import org.jlab.utils.groups.IndexedTableViewer;
 import org.jlab.utils.system.FileSystemExecScan;
+import org.jlab.logging.SplitLogger;
 
 /**
  *
  * @author gavalian
  */
 public class DatabaseConstantProvider implements ConstantProvider {
 
-    static final Logger LOGGER = Logger.getLogger(DatabaseConstantProvider.class.getName());
+    static final Logger LOGGER = SplitLogger.create(DatabaseConstantProvider.class.getName(), false);
 
     private final HashMap<String,String[]> constantContainer = new HashMap<>();
     private final boolean PRINT_ALL = true;

common-tools/clas-detector/src/main/java/org/jlab/detector/calib/utils/RCDBProvider.java

@@ -3,6 +3,7 @@
 import java.util.HashMap;
 import java.util.logging.Level;
 import java.util.logging.Logger;
+import org.jlab.logging.SplitLogger;
 
 import org.rcdb.RCDB;
 import org.rcdb.Condition;
@@ -33,7 +34,7 @@ public Double getSolenoidScale(int run) {
         }
     }
 
-    public static Logger LOGGER = Logger.getLogger(RCDBProvider.class.getName());
+    public static Logger LOGGER = SplitLogger.create(RCDBProvider.class.getName(), false);
 
     public static final String DEFAULTADDRESS = "mysql://[email protected]/rcdb";
 

common-tools/clas-detector/src/main/java/org/jlab/detector/helicity/HelicityGenerator.java

@@ -6,6 +6,7 @@
 import java.util.Comparator;
 import java.util.logging.Level;
 import java.util.logging.Logger;
+import org.jlab.logging.SplitLogger;
 
 /**
  * Helicity Pseudo-Random Sequence.
@@ -29,7 +30,7 @@
  */
 public final class HelicityGenerator implements Comparable<HelicityGenerator>, Comparator<HelicityGenerator> {
 
-    static final Logger LOGGER = Logger.getLogger(HelicityGenerator.class.getName());
+    static final Logger LOGGER = SplitLogger.create(HelicityGenerator.class.getName());
     public static final int REGISTER_SIZE=30;
     private final List<Integer> states=new ArrayList<>();
     private int offset=0;
@@ -187,7 +188,7 @@ public HelicityBit get(final int n) {
      */
     public final boolean initialize(List<HelicityState> states) {
 
-        LOGGER.log(Level.INFO, "HelicityGenerator:  Initializing with {0} states ...", states.size());
+        LOGGER.log(Level.INFO, "Initializing with {0} states ...", states.size());
 
         // make sure they're time-ordered:
         Collections.sort(states);
@@ -242,7 +243,7 @@ else if (iStates.size() > 2 &&
                     // bad timestamp delta, reset the sequence:
                     if (seconds < (1.0-0.5)/this.clock ||
                         seconds > (1.0+0.5)/this.clock) {
-                        LOGGER.log(Level.INFO,"HelicityGenerator:  got bad timestamp, resetting... ");
+                        LOGGER.log(Level.INFO,"got bad timestamp, resetting... ");
                         iStates.clear();
                     }
 
@@ -303,7 +304,7 @@ else if (iStates.size() > 2 &&
                     double corr=(jj-this.offset)/this.clock*HelicitySequence.TIMESTAMP_CLOCK;
                     timestamps.add(timeStamp-corr);
                     timestampsRaw.add((double)timeStamp);
-                    LOGGER.fine(String.format("HelicityGenerator:  timestamp = %d/%.1f/%.2f",
+                    LOGGER.fine(String.format("timestamp = %d/%.1f/%.2f",
                                 timeStamp,corr,timeStamp-corr));
                 }
             }
@@ -313,7 +314,7 @@ else if (iStates.size() > 2 &&
             System.err.println("HelicityGenerator:  Initialization Error.");
             this.reset();
         }
-        LOGGER.fine("HelicityGenerator:  Initialized.");
+        LOGGER.fine("Initialized.");
 
         return this.initialized();
     }

common-tools/clas-detector/src/main/java/org/jlab/detector/helicity/HelicitySequence.java

@@ -10,6 +10,7 @@
 import java.util.logging.Level;
 import java.util.logging.Logger;
 import org.jlab.detector.calib.utils.ConstantsManager;
+import org.jlab.logging.SplitLogger;
 
 import org.jlab.jnp.hipo4.data.Bank;
 import org.jlab.jnp.hipo4.data.Event;
@@ -52,7 +53,7 @@
  */
 public class HelicitySequence {
 
-    static final Logger LOGGER = Logger.getLogger(HelicitySequence.class.getName());
+    static final Logger LOGGER = SplitLogger.create(HelicitySequence.class.getName());
     public static final double TIMESTAMP_CLOCK=250.0e6; // Hz
     protected double helicityClock=29.56; // Hz
     protected HelicityPattern pattern=HelicityPattern.QUARTET;
@@ -456,7 +457,7 @@ else if (seconds > (1.0+0.5)/this.helicityClock) {
         }
 
         LOGGER.info(
-            "HWP       ERRORS:  "+hwpErrors+
+            "\nHWP       ERRORS:  "+hwpErrors+
             "\nSYNC      ERRORS:  "+syncErrors+
             "\nQUARTET   ERRORS:  "+quartetErrors+
             "\nBIGGAP    ERRORS:  "+bigGapErrors+

common-tools/clas-detector/src/main/java/org/jlab/detector/helicity/HelicitySequenceManager.java

@@ -12,6 +12,7 @@
 import org.jlab.jnp.hipo4.data.Event;
 import org.jlab.jnp.hipo4.data.SchemaFactory;
 import org.jlab.jnp.hipo4.io.HipoReader;
+import org.jlab.logging.SplitLogger;
 
 /**
  * Manage helicity sequences for multiple run numbers simultaneously.
@@ -21,7 +22,7 @@
  */
 public final class HelicitySequenceManager {
 
-    static final Logger LOGGER = Logger.getLogger(HelicitySequence.class.getName());
+    static final Logger LOGGER = SplitLogger.create(HelicitySequence.class.getName());
     SchemaFactory schema=null;
     private final int delay;
     private boolean flip=false;

common-tools/clas-detector/src/main/java/org/jlab/detector/scalers/DaqScalersSequence.java

@@ -12,6 +12,7 @@
 import org.jlab.jnp.hipo4.data.Bank;
 import org.jlab.jnp.hipo4.data.SchemaFactory;
 import org.jlab.detector.calib.utils.ConstantsManager;
+import org.jlab.logging.SplitLogger;
 
 /**
  * For easy access to most recent scaler readout for any given event.
@@ -30,7 +31,7 @@ public class DaqScalersSequence implements Comparator<DaqScalers> {
     private Bank runConfigBank=null;
     private Bank runScalerBank=null;
 
-    protected static final Logger logger = Logger.getLogger(DaqScalersSequence.class.getName());
+    protected static final Logger logger = SplitLogger.create(DaqScalersSequence.class.getName());
 
     protected DaqScalersSequence(){};