refactor: logging is consistent and respectfully to console output

Author: JMit-dev

app/queue-server/src/main/java/org/phoebus/applications/queueserver/QueueServerApp.java

@@ -16,7 +16,7 @@
 @SuppressWarnings("nls")
 public final class QueueServerApp implements AppResourceDescriptor {
 
-    public  static final Logger LOGGER = Logger.getLogger(QueueServerApp.class.getPackageName());
+    public static final Logger logger = Logger.getLogger(QueueServerApp.class.getPackageName());
 
     public  static final String NAME         = "queue-server";
     private static final String DISPLAY_NAME = "Queue Server";

app/queue-server/src/main/java/org/phoebus/applications/queueserver/client/RunEngineHttpClient.java

@@ -48,7 +48,7 @@ public static RunEngineHttpClient get() {
     private final String base;
     private final String apiKey;
     private final RateLimiter limiter;
-    private static final Logger LOG = HttpSupport.LOG;
+    private static final Logger logger = HttpSupport.logger;
 
     private RunEngineHttpClient(String baseUrl, String apiKey, double permitsPerSecond) {
         this.http = HttpClient.newBuilder()
@@ -118,14 +118,14 @@ private <T> T executeWithRetry(HttpRequest req, ApiEndpoint ep,
             limiter.acquire();
             long t0 = System.nanoTime();
             try {
-                LOG.log(Level.FINEST, ep + " attempt " + attempt);
+                logger.log(Level.FINEST, ep + " attempt " + attempt);
                 HttpResponse<String> rsp = http.send(req, HttpResponse.BodyHandlers.ofString());
-                LOG.log(Level.FINEST, ep + " " + rsp.statusCode() + " " + HttpSupport.elapsed(t0) + " ms");
+                logger.log(Level.FINEST, ep + " " + rsp.statusCode() + " " + HttpSupport.elapsed(t0) + " ms");
                 check(rsp, ep);
                 return reader.apply(rsp);
             } catch (java.io.IOException ex) {
                 if (!HttpSupport.isRetryable(req) || attempt >= HttpSupport.MAX_RETRIES) throw ex;
-                LOG.log(Level.WARNING, ep + " transport error (" + ex.getClass().getSimpleName() +
+                logger.log(Level.WARNING, ep + " transport error (" + ex.getClass().getSimpleName() +
                         "), retry in " + back + " ms (attempt " + attempt + ")");
                 Thread.sleep(back);
                 back = Math.round(back * HttpSupport.BACKOFF_MULTIPLIER);

app/queue-server/src/main/java/org/phoebus/applications/queueserver/client/RunEngineService.java

@@ -29,13 +29,13 @@
 public final class RunEngineService {
 
     private final RunEngineHttpClient http = RunEngineHttpClient.get();
-    private static final Logger LOG = Logger.getLogger(RunEngineService.class.getName());
+    private static final Logger logger = Logger.getLogger(RunEngineService.class.getPackageName());
 
     /* ---- Ping & status --------------------------------------------------- */
 
     public Envelope<?>          ping()                       throws Exception { return http.call(ApiEndpoint.PING,            NoBody.INSTANCE); }
     public StatusResponse status() throws Exception {
-        LOG.log(Level.FINEST, "Fetching status");
+        logger.log(Level.FINEST, "Fetching status");
         return http.send(ApiEndpoint.STATUS, NoBody.INSTANCE, StatusResponse.class);
     }
     public Envelope<?>          configGet()                  throws Exception { return http.call(ApiEndpoint.CONFIG_GET,      NoBody.INSTANCE); }
@@ -168,7 +168,7 @@ public Envelope<?>          queueItemUpdate(QueueItem item) throws Exception {
     /* ───────── Console monitor ───────── */
 
     public InputStream streamConsoleOutput() throws Exception {
-        LOG.info("Opening console output stream");
+        logger.log(Level.FINE, "Opening console output stream");
         HttpRequest req = HttpRequest.newBuilder()
                 .uri(URI.create(http.getBaseUrl() + ApiEndpoint.STREAM_CONSOLE_OUTPUT.endpoint().path()))
                 .header("Authorization", "ApiKey " + http.getApiKey())
@@ -178,10 +178,10 @@ public InputStream streamConsoleOutput() throws Exception {
         HttpResponse<InputStream> rsp =
                 http.httpClient().send(req, HttpResponse.BodyHandlers.ofInputStream());
         if (rsp.statusCode() < 200 || rsp.statusCode() >= 300) {
-            LOG.log(Level.WARNING, "Console stream failed with HTTP " + rsp.statusCode());
+            logger.log(Level.WARNING, "Console stream failed with HTTP " + rsp.statusCode());
             throw new IOException("console stream - HTTP " + rsp.statusCode());
         }
-        LOG.info("Console output stream opened successfully");
+        logger.log(Level.FINE, "Console output stream opened successfully");
         return rsp.body();
     }
 
@@ -251,7 +251,7 @@ public Envelope<?> rePause(String option) throws Exception {
 
     public Envelope<?>          plansAllowed()               throws Exception { return http.call(ApiEndpoint.PLANS_ALLOWED,   NoBody.INSTANCE); }
     public Map<String, Object>  plansAllowedRaw()           throws Exception {
-        LOG.log(Level.FINE, "Fetching plans allowed (raw)");
+        logger.log(Level.FINE, "Fetching plans allowed (raw)");
         return http.send(ApiEndpoint.PLANS_ALLOWED,   NoBody.INSTANCE);
     }
     public Envelope<?>          devicesAllowed()             throws Exception { return http.call(ApiEndpoint.DEVICES_ALLOWED, NoBody.INSTANCE); }

app/queue-server/src/main/java/org/phoebus/applications/queueserver/controller/ApplicationController.java

@@ -11,6 +11,7 @@
 
 import java.net.URL;
 import java.util.ResourceBundle;
+import java.util.logging.Level;
 import java.util.logging.Logger;
 
 public final class ApplicationController implements Initializable {
@@ -19,18 +20,18 @@ public final class ApplicationController implements Initializable {
     @FXML private Tab editAndControlQueueTab;
     @FXML private TabPane tabPane;
 
-    private static final Logger LOG = Logger.getLogger(ApplicationController.class.getName());
+    private static final Logger logger = Logger.getLogger(ApplicationController.class.getPackageName());
 
     @Override public void initialize(URL url, ResourceBundle rb) {
-        LOG.info("Initializing ApplicationController");
+        logger.log(Level.FINE, "Initializing ApplicationController");
         monitorQueueTab.setContent(ViewFactory.MONITOR_QUEUE.get());
         editAndControlQueueTab.setContent(ViewFactory.EDIT_AND_CONTROL_QUEUE.get());
 
         // Disable focus traversal on all components
         disableFocusTraversal(monitorQueueTab.getContent());
         disableFocusTraversal(editAndControlQueueTab.getContent());
 
-        LOG.info("ApplicationController initialization complete");
+        logger.log(Level.FINE, "ApplicationController initialization complete");
     }
 
     /**

app/queue-server/src/main/java/org/phoebus/applications/queueserver/controller/EditAndControlQueueController.java

@@ -18,11 +18,11 @@ public class EditAndControlQueueController implements Initializable {
     @FXML private AnchorPane planQueueContainer;
     @FXML private AnchorPane planHistoryContainer;
 
-    private static final Logger LOG = Logger.getLogger(EditAndControlQueueController.class.getName());
+    private static final Logger logger = Logger.getLogger(EditAndControlQueueController.class.getPackageName());
 
     @Override
     public void initialize(URL url, ResourceBundle resourceBundle) {
-        LOG.info("Initializing EditAndControlQueueController");
+        logger.log(Level.FINE, "Initializing EditAndControlQueueController");
         loadInto(runningPlanContainer, "/org/phoebus/applications/queueserver/view/ReRunningPlan.fxml", new ReRunningPlanController(false));
         loadInto(planQueueContainer, "/org/phoebus/applications/queueserver/view/RePlanQueue.fxml", new RePlanQueueController(false));
         loadInto(planHistoryContainer, "/org/phoebus/applications/queueserver/view/RePlanHistory.fxml", new RePlanHistoryController(false));
@@ -40,7 +40,7 @@ private void loadInto(AnchorPane container, String fxml, Object controller) {
             AnchorPane.setLeftAnchor(view, 0.0);
             AnchorPane.setRightAnchor(view, 0.0);
         } catch (IOException e) {
-            LOG.log(Level.SEVERE, "Failed to load FXML: " + fxml, e);
+            logger.log(Level.SEVERE, "Failed to load FXML: " + fxml, e);
         }
     }
 

app/queue-server/src/main/java/org/phoebus/applications/queueserver/controller/MonitorQueueController.java

@@ -25,7 +25,7 @@ public class MonitorQueueController implements Initializable {
     @FXML private VBox stack;
 
     private final Map<TitledPane, Double> savedHeights = new HashMap<>();
-    private static final Logger LOG = Logger.getLogger(MonitorQueueController.class.getName());
+    private static final Logger logger = Logger.getLogger(MonitorQueueController.class.getPackageName());
 
     private static final String BAR_NORMAL =
             "-fx-background-color: linear-gradient(to bottom, derive(-fx-base,15%) 0%, derive(-fx-base,-5%) 100%);" +
@@ -34,7 +34,7 @@ public class MonitorQueueController implements Initializable {
 
     @Override
     public void initialize(URL url, ResourceBundle resourceBundle) {
-        LOG.info("Initializing MonitorQueueController");
+        logger.log(Level.FINE, "Initializing MonitorQueueController");
         loadInto(runningPlanContainer, "/org/phoebus/applications/queueserver/view/ReRunningPlan.fxml", new ReRunningPlanController(true));
         loadInto(planQueueContainer, "/org/phoebus/applications/queueserver/view/RePlanQueue.fxml", new RePlanQueueController(true));
         loadInto(planHistoryContainer, "/org/phoebus/applications/queueserver/view/RePlanHistory.fxml", new RePlanHistoryController(true));
@@ -76,7 +76,7 @@ private void loadInto(AnchorPane container, String fxml, Object controller) {
             AnchorPane.setLeftAnchor(view, 0.0);
             AnchorPane.setRightAnchor(view, 0.0);
         } catch (IOException e) {
-            LOG.log(Level.SEVERE, "Failed to load FXML: " + fxml, e);
+            logger.log(Level.SEVERE, "Failed to load FXML: " + fxml, e);
         }
     }
 

app/queue-server/src/main/java/org/phoebus/applications/queueserver/controller/ReEnvironmentControlsController.java

@@ -14,6 +14,7 @@
 import java.net.URL;
 import java.util.Map;
 import java.util.ResourceBundle;
+import java.util.logging.Level;
 import java.util.logging.Logger;
 
 public final class ReEnvironmentControlsController implements Initializable {
@@ -23,7 +24,7 @@ public final class ReEnvironmentControlsController implements Initializable {
     @FXML private Button destroyBtn;
 
     private final RunEngineService svc = new RunEngineService();
-    private final Logger LOG = Logger.getLogger(getClass().getName());
+    private static final Logger logger = Logger.getLogger(ReEnvironmentControlsController.class.getPackageName());
 
     @Override public void initialize(URL url, ResourceBundle rb) {
         StatusBus.latest().addListener(this::onStatus);
@@ -57,12 +58,12 @@ private void refreshButtons(Object statusObj) {
 
     @FXML private void open() {
         try { svc.environmentOpen(); }
-        catch (Exception ex) { LOG.warning("environmentOpen: " + ex); }
+        catch (Exception ex) { logger.log(Level.WARNING, "environmentOpen: " + ex); }
     }
 
     @FXML private void close() {
         try { svc.environmentClose(); }
-        catch (Exception ex) { LOG.warning("environmentClose: " + ex); }
+        catch (Exception ex) { logger.log(Level.WARNING, "environmentClose: " + ex); }
     }
 
     @FXML private void destroy() {
@@ -75,9 +76,9 @@ private void refreshButtons(Object statusObj) {
             if (response == ButtonType.OK) {
                 try { 
                     svc.environmentDestroy(); 
-                    LOG.info("Environment destroyed successfully");
+                    logger.log(Level.FINE, "Environment destroyed successfully");
                 } catch (Exception ex) { 
-                    LOG.warning("environmentDestroy: " + ex); 
+                    logger.log(Level.WARNING, "environmentDestroy: " + ex); 
                 }
             }
         });

app/queue-server/src/main/java/org/phoebus/applications/queueserver/controller/ReExecutionControlsController.java

@@ -12,6 +12,7 @@
 import java.net.URL;
 import java.util.Map;
 import java.util.ResourceBundle;
+import java.util.logging.Level;
 import java.util.logging.Logger;
 
 public final class ReExecutionControlsController implements Initializable {
@@ -20,7 +21,7 @@ public final class ReExecutionControlsController implements Initializable {
             stopBtn, abortBtn, haltBtn;
 
     private final RunEngineService svc = new RunEngineService();
-    private final Logger LOG = Logger.getLogger(getClass().getName());
+    private static final Logger logger = Logger.getLogger(ReExecutionControlsController.class.getPackageName());
 
     @Override public void initialize(URL url, ResourceBundle rb) {
 
@@ -109,6 +110,6 @@ else if (statusObj instanceof Map<?,?> m) {
 
     private void call(String label, Runnable r) {
         try { r.run(); }
-        catch (Exception ex) { LOG.warning(label + ": " + ex); }
+        catch (Exception ex) { logger.log(Level.WARNING, label + ": " + ex); }
     }
 }

app/queue-server/src/main/java/org/phoebus/applications/queueserver/controller/ReManagerConnectionController.java

@@ -21,14 +21,14 @@ public final class ReManagerConnectionController {
     private final RunEngineService svc = new RunEngineService();
     private ScheduledFuture<?>   pollTask;
     private static final int PERIOD_SEC = 1;
-    private static final Logger LOG = Logger.getLogger(ReManagerConnectionController.class.getName());
+    private static final Logger logger = Logger.getLogger(ReManagerConnectionController.class.getPackageName());
 
     @FXML private void connect()    { startPolling(); }
     @FXML private void disconnect() { stopPolling();  }
 
     private void startPolling() {
         if (pollTask != null && !pollTask.isDone()) return;     // already running
-        LOG.info("Starting connection polling every " + PERIOD_SEC + " seconds");
+        logger.log(Level.FINE, "Starting connection polling every " + PERIOD_SEC + " seconds");
         showPending();                                          // UI while waiting
 
         updateWidgets(queryStatusOnce());
@@ -42,13 +42,13 @@ private StatusResponse queryStatusOnce() {
         try {
             return svc.status();
         } catch (Exception ex) {
-            LOG.log(Level.FINE, "Status query failed: " + ex.getMessage());
+            logger.log(Level.FINE, "Status query failed: " + ex.getMessage());
             return null;
         }
     }
 
     private void stopPolling() {
-        LOG.info("Stopping connection polling");
+        logger.log(Level.FINE, "Stopping connection polling");
         if (pollTask != null) pollTask.cancel(true);
         pollTask = null;
         StatusBus.push(null);
@@ -74,7 +74,7 @@ private void showOnline() {
     private void updateWidgets(StatusResponse s) {
         StatusBus.push((s));
         if (s != null) {
-            LOG.log(Level.FINEST, "Status update: manager_state=" + s.managerState());
+            logger.log(Level.FINEST, "Status update: manager_state=" + s.managerState());
             showOnline();
         } else {
             showPending();      // keep polling; user may Disconnect

app/queue-server/src/main/java/org/phoebus/applications/queueserver/controller/RePlanEditorController.java

@@ -51,7 +51,7 @@ public class RePlanEditorController implements Initializable {
     @FXML private TableColumn<ParameterRow, String> valueCol;
 
     private final RunEngineService svc = new RunEngineService();
-    private static final Logger LOG = Logger.getLogger(RePlanEditorController.class.getName());
+    private static final Logger logger = Logger.getLogger(RePlanEditorController.class.getPackageName());
     private final ObservableList<ParameterRow> parameterRows = FXCollections.observableArrayList();
     private final Map<String, Map<String, Object>> allowedPlans = new HashMap<>();
     private final Map<String, Map<String, Object>> allowedInstructions = new HashMap<>();
@@ -389,10 +389,10 @@ private void loadAllowedPlansAndInstructions() {
                             allowedPlans.put(planName, planInfo);
                         }
                     } else {
-                        LOG.log(Level.WARNING, "No 'plans_allowed' key in response. Keys: " + responseMap.keySet());
+                        logger.log(Level.WARNING, "No 'plans_allowed' key in response. Keys: " + responseMap.keySet());
                     }
                 } else {
-                    LOG.log(Level.WARNING, "Plans response failed. Response: " + responseMap);
+                    logger.log(Level.WARNING, "Plans response failed. Response: " + responseMap);
                 }
 
                 allowedInstructions.clear();
@@ -407,7 +407,7 @@ private void loadAllowedPlansAndInstructions() {
                 });
 
             } catch (Exception e) {
-                LOG.log(Level.WARNING, "Failed to load plans", e);
+                logger.log(Level.WARNING, "Failed to load plans", e);
             }
         }).start();
     }
@@ -711,7 +711,7 @@ private void addItemToQueue() {
                         }
                     });
                 } catch (Exception e) {
-                    LOG.log(Level.WARNING, "Failed to add item to queue", e);
+                    logger.log(Level.WARNING, "Failed to add item to queue", e);
                     Platform.runLater(() -> {
                         String errorMsg = e.getMessage();
                         if (errorMsg == null || errorMsg.isEmpty()) {
@@ -723,7 +723,7 @@ private void addItemToQueue() {
             }).start();
 
         } catch (Exception e) {
-            LOG.log(Level.SEVERE, "Failed to add item to queue", e);
+            logger.log(Level.SEVERE, "Failed to add item to queue", e);
             Platform.runLater(() -> {
                 showValidationError("Failed to add item: " + e.getMessage());
             });
@@ -790,7 +790,7 @@ private void saveItem() {
                         }
                     });
                 } catch (Exception e) {
-                    LOG.log(Level.WARNING, "Failed to save item", e);
+                    logger.log(Level.WARNING, "Failed to save item", e);
                     Platform.runLater(() -> {
                         String errorMsg = e.getMessage();
                         if (errorMsg == null || errorMsg.isEmpty()) {
@@ -802,7 +802,7 @@ private void saveItem() {
             }).start();
 
         } catch (Exception e) {
-            LOG.log(Level.SEVERE, "Failed to save item", e);
+            logger.log(Level.SEVERE, "Failed to save item", e);
             Platform.runLater(() -> {
                 showValidationError("Failed to save item: " + e.getMessage());
             });
@@ -966,7 +966,7 @@ private void processBatchFile(String filePath, String fileType) {
                 }
 
             } catch (Exception e) {
-                LOG.log(Level.WARNING, "Batch file processing error", e);
+                logger.log(Level.WARNING, "Batch file processing error", e);
                 Platform.runLater(() -> {
                     Alert alert = new Alert(Alert.AlertType.ERROR);
                     alert.setTitle("Error");