_log: add option to redirect other loggers to same json file (#358)

* `_log`: add option to redirect other loggers to same json file

* add `extra` options for logging to json

src/dolphin/_log.py

@@ -39,16 +39,25 @@
 __all__ = ["log_runtime"]
 
 
-def setup_logging(debug: bool = False, filename: PathOrStr | None = None):
+def setup_logging(
+    *,
+    logger_name: str = "dolphin",
+    debug: bool = False,
+    filename: PathOrStr | None = None,
+):
     config_file = Path(__file__).parent / Path("log-config.json")
     with open(config_file) as f_in:
         config = json.load(f_in)
 
+    if logger_name not in config["loggers"]:
+        config["loggers"][logger_name] = {"level": "INFO", "handlers": ["stderr"]}
+
     if debug:
-        config["loggers"]["dolphin"]["level"] = "DEBUG"
+        config["loggers"][logger_name]["level"] = "DEBUG"
 
     if filename:
-        config["loggers"]["dolphin"]["handlers"].append("file")
+        if "file" not in config["loggers"][logger_name]["handlers"]:
+            config["loggers"][logger_name]["handlers"].append("file")
         config["handlers"]["file"]["filename"] = os.fspath(filename)
         Path(filename).parent.mkdir(exist_ok=True, parents=True)
 
@@ -57,6 +66,7 @@ def setup_logging(debug: bool = False, filename: PathOrStr | None = None):
         config["handlers"].pop("file")
 
     logging.config.dictConfig(config)
+
     # Temp work around for tqdm on py312
     if sys.version_info.major == 3 and sys.version_info.minor == 12:
         os.environ["TQDM_DISABLE"] = "1"

src/dolphin/workflows/unwrapping.py

@@ -3,6 +3,7 @@
 from __future__ import annotations
 
 import logging
+import time
 from pathlib import Path
 from typing import Sequence
 
@@ -56,6 +57,7 @@ def run(
         list of Paths to connected component files created.
 
     """
+    t0 = time.perf_counter()
     if len(ifg_file_list) != len(cor_file_list):
         msg = f"{len(ifg_file_list) = } != {len(cor_file_list) = }"
         raise ValueError(msg)
@@ -93,6 +95,15 @@ def run(
         create_overviews(unwrapped_paths, image_type=ImageType.UNWRAPPED)
         create_overviews(conncomp_paths, image_type=ImageType.CONNCOMP)
 
+    # Dump the used options for JSON parsing
+    logger.info(
+        "unwrapping complete",
+        extra={
+            "elapsed": time.perf_counter() - t0,
+            "unwrap_options": unwrap_options.model_dump(mode="json"),
+        },
+    )
+
     return (unwrapped_paths, conncomp_paths)
 
 

src/dolphin/workflows/wrapped_phase.py

@@ -2,6 +2,7 @@
 
 import datetime
 import logging
+import time
 from pathlib import Path
 from typing import Optional, Sequence, cast
 
@@ -53,6 +54,7 @@ def run(
         Path to the created SHP counts file.
 
     """
+    t0 = time.perf_counter()
     setup_logging(debug=debug, filename=cfg.log_file)
     if tqdm_kwargs is None:
         tqdm_kwargs = {}
@@ -181,6 +183,14 @@ def run(
                 **kwargs,
             )
         )
+    # Dump the used options for JSON parsing
+    logger.info(
+        "wrapped_phase complete",
+        extra={
+            "elapsed": time.perf_counter() - t0,
+            "phase_linking_options": cfg.phase_linking.model_dump(mode="json"),
+        },
+    )
 
     # ###################################################
     # Form interferograms from estimated wrapped phase