nost-tools 2.3.0__py3-none-any.whl → 2.4.0__py3-none-any.whl

nost_tools/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "2.3.0"
+__version__ = "2.4.0"
 
 from .application import Application
 from .application_utils import ConnectionConfig, ModeStatusObserver, TimeStatusPublisher

nost_tools/application.py

@@ -4,6 +4,7 @@ Provides a base application that publishes messages from a simulator to a broker
 
 import functools
 import logging
+import logging.handlers
 import os
 import signal
 import ssl
@@ -308,6 +309,17 @@ class Application:
                 self.shut_down_when_terminated = getattr(
                     parameters, "shut_down_when_terminated", shut_down_when_terminated
                 )
+
+                # Configure file logging if requested
+                if getattr(parameters, "enable_file_logging", False):
+                    self.configure_file_logging(
+                        log_dir=getattr(parameters, "log_dir", None),
+                        log_filename=getattr(parameters, "log_filename", None),
+                        log_level=getattr(parameters, "log_level", None),
+                        max_bytes=getattr(parameters, "max_bytes", None),
+                        backup_count=getattr(parameters, "backup_count", None),
+                        log_format=getattr(parameters, "log_format", None),
+                    )
             else:
                 logger.warning("No parameters found in configuration, using defaults")
                 self.set_offset = set_offset
@@ -1475,9 +1487,67 @@ class Application:
 
     def _create_shut_down_observer(self) -> None:
         """
-        Creates an observer to shut down the application when the simulation is terminated.
+        Creates a shut down observer to close the application when the simulator is terminated.
         """
         if self._shut_down_observer is not None:
             self.simulator.remove_observer(self._shut_down_observer)
         self._shut_down_observer = ShutDownObserver(self)
         self.simulator.add_observer(self._shut_down_observer)
+
+    def configure_file_logging(
+        self,
+        log_dir: str = None,
+        log_filename: str = None,
+        log_level: str = None,
+        max_bytes: int = None,
+        backup_count: int = None,
+        log_format: str = None,
+    ):
+        """
+        Configures file logging for the application.
+
+        Args:
+            log_dir (str): Directory where log files will be stored
+            log_filename (str): Name of the log file. If None, a timestamped filename will be used
+            log_level (str): Logging level (e.g., 'DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL')
+            max_bytes (int): Maximum file size in bytes before rotating
+            backup_count (int): Number of backup files to keep
+            log_format (str): Log message format
+        """
+        try:
+            if log_filename is None:
+                timestamp = datetime.now().strftime("%Y%m%d_%H%M%S")
+                log_filename = os.path.join(log_dir, f"{self.app_name}_{timestamp}.log")
+            else:
+                log_filename = os.path.join(log_dir, log_filename)
+
+            # Create log directory if it doesn't exist
+            if log_dir and not os.path.exists(log_dir):
+                os.makedirs(log_dir)
+                logger.info(f"Log directory {log_dir} successfully created.")
+
+            # Configure rotating file handler
+            handler = logging.handlers.RotatingFileHandler(
+                log_filename, maxBytes=max_bytes, backupCount=backup_count
+            )
+
+            # Set log level
+            level = getattr(logging, log_level.upper(), logging.INFO)
+            handler.setLevel(level)
+
+            # Set log format
+            if log_format is not None:
+                formatter = logging.Formatter(log_format)
+                handler.setFormatter(formatter)
+            else:
+                # Default format
+                formatter = logging.Formatter(
+                    "%(asctime)s - %(name)s - %(levelname)s - %(message)s"
+                )
+                handler.setFormatter(formatter)
+
+            # Add the handler to the root logger
+            logging.getLogger().addHandler(handler)
+            logger.info(f"File logging configured: {log_filename} (level: {log_level})")
+        except Exception as e:
+            logger.error(f"Error configuring file logging: {e}")

nost_tools/manager.py

@@ -164,7 +164,7 @@ class Manager(Application):
         set_offset: bool = True,
         time_status_step: timedelta = None,
         time_status_init: datetime = None,
-        shut_down_when_terminated: bool = False,
+        shut_down_when_terminated: bool = False
     ) -> None:
         """
         Starts up the application by connecting to message broker, starting a background event loop,

nost_tools/schemas.py

@@ -280,7 +280,7 @@ class KeycloakConfig(BaseModel):
     realm: str = Field("master", description="Keycloak realm.")
     tls: bool = Field(False, description="Keycloak TLS/SSL.")
     token_refresh_interval: int = Field(
-        60, description="Keycloak token refresh interval, in seconds."
+        240, description="Keycloak token refresh interval, in seconds."
     )
 
 
@@ -337,7 +337,35 @@ class TimeScaleUpdateSchema(BaseModel):
     )
 
 
-class ManagerConfig(BaseModel):
+class LoggingConfig(BaseModel):
+    """
+    Configuration for logging.
+    """
+
+    enable_file_logging: Optional[bool] = Field(
+        False, description="Enable file logging."
+    )
+    log_dir: Optional[str] = Field(
+        "logs", description="Directory path for log files."
+    )
+    log_filename: Optional[str] = Field(None, description="Path to the log file.")
+    log_level: Optional[str] = Field(
+        "INFO", description="Logging level (DEBUG, INFO, WARNING, ERROR, CRITICAL)."
+    )
+    max_bytes: Optional[int] = Field(
+        10 * 1024 * 1024,
+        description="Maximum size of the log file in bytes. Default is 10MB.",
+    )
+    backup_count: Optional[int] = Field(
+        5, description="Number of backup log files to keep."
+    )
+    log_format: Optional[str] = Field(
+        "%(asctime)s [%(levelname)s] %(name)s: %(message)s",
+        description="Format of the log messages.",
+    )
+
+
+class ManagerConfig(LoggingConfig):
     sim_start_time: Optional[datetime] = Field(
         None, description="Simulation start time."
     )
@@ -405,7 +433,7 @@ class ManagerConfig(BaseModel):
         return values
 
 
-class ManagedApplicationConfig(BaseModel):
+class ManagedApplicationConfig(LoggingConfig):
     time_scale_factor: float = Field(1.0, description="Time scale factor.")
     time_step: timedelta = Field(
         timedelta(seconds=1), description="Time step for swe_change."

{nost_tools-2.3.0.dist-info → nost_tools-2.4.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: nost_tools
-Version: 2.3.0
+Version: 2.4.0
 Summary: Tools for Novel Observing Strategies Testbed (NOS-T) Applications
 Author-email: "Paul T. Grogan" <paul.grogan@asu.edu>, "Emmanuel M. Gonzalez" <emmanuelgonzalez@asu.edu>
 License-Expression: BSD-3-Clause

{nost_tools-2.3.0.dist-info → nost_tools-2.4.0.dist-info}/RECORD

@@ -1,18 +1,18 @@
-nost_tools/__init__.py,sha256=5DeYQxWXibC9y__BvjwL8YC8K4EYMZbAV6E75k5nuL8,870
-nost_tools/application.py,sha256=gh48fokVifuhKyAoJylZ2mF_WHW90G9L8j99Ct7j2Pg,64257
+nost_tools/__init__.py,sha256=PHcnb5Yc5yUfKYuHt2GDCto5nsYeqZwpA7cVQBOHNZI,870
+nost_tools/application.py,sha256=YCLE17NZzkk12gPCJjlXVCtaf2cUWoYG2qMoEPhwRR4,67274
 nost_tools/application_utils.py,sha256=jiMzuuP6-47UlUO64HhwNvbl6uKvVnsksYgOw7CmxL4,9327
 nost_tools/configuration.py,sha256=4WLs1BrHMMvVhSIpJfjVZe-zw04WygAzjiLX2pVXibY,13146
 nost_tools/entity.py,sha256=JrSN5rz7h-N9zIQsaJOQVBIYPDfygacedks55fsq_QQ,2802
 nost_tools/errors.py,sha256=0JcDlMEkZAya3-5c0rRozLuxp8qF58StG4JgRsaxfKU,344
 nost_tools/logger_application.py,sha256=rxPBfyA7Zym5b_EsoSJvT9JWNIVWZX1a-4czFwCqaQ4,7217
 nost_tools/managed_application.py,sha256=Xa6qGsNVrr_XNnpJt_-L5PVnpeUy7GXIf0p2aEI4dSE,11673
-nost_tools/manager.py,sha256=KqFyE-vv9dPRuVdz_r1SAsPeWt9LwKOTF-a2cJId0rY,24321
+nost_tools/manager.py,sha256=nW74aER5K-8ad8FUb1-QKQbJAY3v-crvp1iWYpjv6DQ,24320
 nost_tools/observer.py,sha256=D64V0KTvHRPEqbB8q3BosJhoAlpBah2vyBlVbxWQR44,8161
 nost_tools/publisher.py,sha256=omU8tb0AXnA6RfhYSh0vnXbJtrRo4ukx1J5ANl4bDLQ,5291
-nost_tools/schemas.py,sha256=RZH9LCWSZT8hGteI_Cc5a_w_TyFYx0Kh5mBM02SObrk,20575
+nost_tools/schemas.py,sha256=39vbVG0G81vnoJ6YoHLCzz2_g3ZTtn8L3gxPQ5ttCYA,21499
 nost_tools/simulator.py,sha256=pWfMSarMCuInQTlvlJ5l53w5ZZP6jjyUtY8uWOkbe-4,20062
-nost_tools-2.3.0.dist-info/licenses/LICENSE,sha256=aAMU-mTHTKpWkBsg9QhkhCQpEm3Gri7J_fVuJov8s3s,1539
-nost_tools-2.3.0.dist-info/METADATA,sha256=6ovwTQnDSv0ODsIsMQcFI5-kN652WW8FYOYlwzg-SH8,4256
-nost_tools-2.3.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-nost_tools-2.3.0.dist-info/top_level.txt,sha256=LNChUgrv2-wiym12O0r61kY83COjTpTiJ2Ly1Ca58A8,11
-nost_tools-2.3.0.dist-info/RECORD,,
+nost_tools-2.4.0.dist-info/licenses/LICENSE,sha256=aAMU-mTHTKpWkBsg9QhkhCQpEm3Gri7J_fVuJov8s3s,1539
+nost_tools-2.4.0.dist-info/METADATA,sha256=1zLzpRY32Q1xrd_sJiowqEMvY3lsL8VhcYkMOx_wj1E,4256
+nost_tools-2.4.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+nost_tools-2.4.0.dist-info/top_level.txt,sha256=LNChUgrv2-wiym12O0r61kY83COjTpTiJ2Ly1Ca58A8,11
+nost_tools-2.4.0.dist-info/RECORD,,