Make sender monitor run optional

Author: kzscisoft

simvue/sender/actions.py

@@ -186,15 +186,16 @@ def _single_item_upload(
         id_mapping: dict[str, str],
         cache_directory: pathlib.Path,
         thread_lock: threading.Lock,
-        simvue_monitor_run: SimvueRun,
+        simvue_monitor_run: SimvueRun | None,
         *,
         throw_exceptions: bool = False,
         retry_failed: bool = False,
         upload_status: dict[str, str | float] | None,
     ) -> None:
         """Upload a single item of this object type."""
         _label: str = cls.object_type[:-1] if cls.singular_object else cls.object_type
-        simvue_monitor_run.log_event(f"Uploading {_label} '{identifier}'")
+        if simvue_monitor_run:
+            simvue_monitor_run.log_event(f"Uploading {_label} '{identifier}'")
         _json_file = cache_directory.joinpath(f"{cls.object_type}/{identifier}.json")
 
         with _json_file.open() as in_f:
@@ -230,10 +231,11 @@ def _single_item_upload(
             _exception_msg: str = (
                 f"Error while committing {_label} '{identifier}': {err}"
             )
-            simvue_monitor_run.log_event(_exception_msg)
-            simvue_monitor_run.log_alert(
-                name="sender_object_upload_failure", state="critical"
-            )
+            if simvue_monitor_run:
+                simvue_monitor_run.log_event(_exception_msg)
+                simvue_monitor_run.log_alert(
+                    name="sender_object_upload_failure", state="critical"
+                )
             cls.logger.error(_exception_msg)
             cls._log_upload_failed(cache_directory, identifier, _data)
             return
@@ -266,9 +268,10 @@ def _single_item_upload(
             with thread_lock:
                 upload_status.setdefault(cls.object_type, 0)
                 upload_status[cls.object_type] += 1
-                simvue_monitor_run.log_metrics(
-                    {f"uploads.{cls.object_type}": upload_status[cls.object_type]}
-                )
+                if simvue_monitor_run:
+                    simvue_monitor_run.log_metrics(
+                        {f"uploads.{cls.object_type}": upload_status[cls.object_type]}
+                    )
 
         cls.post_tasks(
             offline_id=identifier,
@@ -285,7 +288,7 @@ def upload(
         thread_lock: threading.Lock,
         threading_threshold: int,
         max_thread_workers: int,
-        simvue_monitor_run: SimvueRun,
+        simvue_monitor_run: SimvueRun | None,
         *,
         throw_exceptions: bool = False,
         retry_failed: bool = False,
@@ -306,6 +309,8 @@ def upload(
             the number of cached files above which threading will be used.
         max_thread_workers : int
             the maximum number of threads to use.
+        simvue_monitor_run : SimvueRun | None
+            run to track uploading
         throw_exceptions : bool, optional
             whether to throw exceptions and terminate, default False.
         retry_failed : bool, optional
@@ -934,7 +939,7 @@ def _single_item_upload(
         id_mapping: dict[str, str],
         cache_directory: pathlib.Path,
         thread_lock: threading.Lock,
-        simvue_monitor_run: SimvueRun,
+        simvue_monitor_run: SimvueRun | None,
         *,
         throw_exceptions: bool = False,
         retry_failed: bool = False,
@@ -1032,7 +1037,7 @@ def _single_item_upload(
         id_mapping: dict[str, str],
         cache_directory: pathlib.Path,
         thread_lock: threading.Lock,
-        simvue_monitor_run: SimvueRun,
+        simvue_monitor_run: SimvueRun | None,
         *,
         throw_exceptions: bool = False,
         retry_failed: bool = False,
@@ -1057,7 +1062,7 @@ def upload(
         throw_exceptions: bool = False,
         retry_failed: bool = False,
         upload_status: dict[str, str | float] | None = None,
-        simvue_monitor_run: dict[str, str | float] | None = None,
+        simvue_monitor_run: SimvueRun | None = None,
     ) -> None:
         """Upload CO2 intensity data."""
         _ = id_mapping

simvue/sender/base.py

@@ -48,6 +48,7 @@ def __init__(
         retry_failed_uploads: bool = False,
         run_notification: typing.Literal["none", "all", "email"] = "none",
         run_retention_period: str | None = None,
+        monitor_uploads: bool = False,
     ) -> None:
         """Initialise a local data sender.
 
@@ -64,6 +65,8 @@ def __init__(
             default is False (exceptions will be logged)
         retry_failed_uploads : bool, optional
             Whether to retry sending objects which previously failed, by default False
+        monitor_uploads : bool, optional
+            Whether to track uploads as a Simvue run, by default False
         """
         _local_config: SimvueConfiguration = SimvueConfiguration.fetch(mode="online")
         self._cache_directory = cache_directory or _local_config.offline.cache
@@ -77,6 +80,7 @@ def __init__(
         self._run_notification: typing.Literal["none", "email"] = run_notification
         self._run_retention_period: str | None = run_retention_period
         self._upload_status: dict[str, str | float] = {}
+        self._monitor_uploads: bool = monitor_uploads
         self._id_mapping = {
             file_path.name.split(".")[0]: file_path.read_text()
             for file_path in self._cache_directory.glob("server_ids/*.txt")
@@ -149,7 +153,8 @@ def upload(self, objects_to_upload: list[UploadItem] | None = None) -> None:
         """
         self._lock()
 
-        _monitor_run = self._initialise_monitor_run()
+        _monitor_run = self._initialise_monitor_run() if self._monitor_uploads else None
+
         self._upload_status = {}
 
         for action in UPLOAD_ACTION_ORDER:
@@ -171,5 +176,6 @@ def upload(self, objects_to_upload: list[UploadItem] | None = None) -> None:
                 simvue_monitor_run=_monitor_run,
                 upload_status=self._upload_status,
             )
-        _monitor_run.close()
+        if _monitor_run:
+            _monitor_run.close()
         self._release()