SIENTIAPDE-1084

Remove deprecated files and enhance documentation

- Deleted `coverage.sh`, `docker-compose.yaml`, `Dockerfile`, and simulator-related files to streamline the project structure.
- Updated `README.md` to provide a comprehensive overview of the OPC Ingestor, including features, architecture, installation, usage, and troubleshooting.
- Enhanced docstrings across various classes and methods in the `ingestor` module for better clarity and maintainability.
- Improved Prometheus metrics documentation in `metrics.py` to ensure proper monitoring and observability of the system.

ingestor/managers/opc_manager.py

@@ -13,6 +13,47 @@ import ingestor.metrics as metrics
 
 
 class OpcManager(BaseActivity):
+    """
+    Manages OPC UA server connections and tag subscriptions.
+
+    The OpcManager is responsible for:
+    - Establishing and maintaining secure connections to OPC UA servers
+    - Managing tag subscriptions and data collection
+    - Handling server reconnection and error recovery
+    - Processing OPC data and forwarding it to the data manager
+    - Monitoring connection health and performance metrics
+
+    The manager supports both secure and unsecured connections, with optional
+    certificate-based authentication for enhanced security.
+
+    Args:
+        name (str): Unique identifier for the OPC server
+        url (str): OPC UA server endpoint URL
+        data_manager (DataManager): Manager for data persistence and export
+        logger (Logger): Logger instance for application logging
+        server_uri (str): OPC UA server application URI
+        notification_handler (NotificationHandler): Handler for sending notifications
+        metadata (dict): Application metadata for notifications and tracking
+        cert_path (str, optional): Path to client certificate file for secure connections
+        private_key_path (str, optional): Path to client private key file
+        server_cert_path (str, optional): Path to server certificate file for validation
+
+    Attributes:
+        url (str): OPC UA server endpoint URL
+        name (str): Unique identifier for the OPC server
+        server_uri (str): OPC UA server application URI
+        data_queue (dict): Queue for buffering OPC data before processing
+        non_receive_count (int): Counter for cycles without data reception
+        client (Client): OPC UA client instance
+        cert_path (str): Path to client certificate file
+        private_key_path (str): Path to client private key file
+        server_cert_path (str): Path to server certificate file
+        nodes (dict): Dictionary of OPC node references
+        subscriptions (dict): Active OPC subscriptions
+        data_manager (DataManager): Manager for data persistence and export
+        metadata (dict): Application metadata
+    """
+
     def __init__(self, name: str, url: str, data_manager: DataManager, logger: Logger,
                  server_uri: str, notification_handler: NotificationHandler, metadata: dict,
                  cert_path: str = None, private_key_path: str = None, server_cert_path: str = None):
@@ -40,11 +81,27 @@ class OpcManager(BaseActivity):
             pod_id=self.pod_id, server_name=self.name).set(0)
 
     def __str__(self):
+        """
+        String representation of the OPC Manager.
+
+        Returns:
+            str: Human-readable representation showing server details and current state.
+        """
         return f"OpcManager(name={self.name}, url={self.url}, server_uri={self.server_uri})\n" \
             f"nodes={self.nodes}, subscriptions={self.subscriptions}"
 
     async def shutdown(self):
-        """Comprehensive cleanup method"""
+        """
+        Comprehensive cleanup method for graceful shutdown.
+
+        This method ensures proper cleanup of all OPC UA resources:
+        - Closes active subscriptions
+        - Disconnects from the OPC server
+        - Releases allocated resources
+
+        Should be called before the application terminates to prevent resource leaks
+        and ensure clean disconnection from OPC servers.
+        """
         try:
 
             await self.disconnect()
@@ -54,21 +111,24 @@ class OpcManager(BaseActivity):
     async def set_security(self):
         """
         Configures the security settings for the OPC UA client.
+
         This method sets up the security policy, certificates, and timeouts
         required for establishing a secure connection with the OPC UA server.
+        It implements Basic256 security policy with certificate-based authentication.
+
         Raises:
             ValueError: If either the certificate path or private key path is not provided.
-        Attributes:
-            cert_path (str): Path to the client's certificate file.
-            private_key_path (str): Path to the client's private key file.
-            server_cert_path (str, optional): Path to the server's certificate file.
-            server_uri (str): The URI of the server to be used as the application URI.
-            client (opcua.Client): The OPC UA client instance.
-            logger (logging.Logger): Logger instance for logging information.
+
         Security Settings:
             - Security Policy: Basic256
             - Secure Channel Timeout: 10,000,000 ms
             - Session Timeout: 10,000,000 ms
+
+        The method configures:
+            - Client application URI
+            - Certificate-based authentication
+            - Server certificate validation (if provided)
+            - Connection timeouts for stability
         """
 
         if not all([self.cert_path, self.private_key_path]):
@@ -93,11 +153,23 @@ class OpcManager(BaseActivity):
     async def connect(self):
         """
         Establishes a connection to the OPC server.
+
         This method initializes the OPC client using the provided URL and
         sets up security if a certificate path is specified. It then
         attempts to connect to the server and logs the connection status.
+
+        The connection process includes:
+        1. Client initialization with server URL
+        2. Security configuration (if certificates are provided)
+        3. Connection establishment
+        4. Metrics recording for monitoring
+
         Raises:
             Exception: If the connection to the OPC server fails.
+
+        Metrics:
+            - OPC_CONNECTIONS_TOTAL: Incremented on connection attempt
+            - OPC_CONNECTION_STATUS: Set to 1 on successful connection
         """
 
         metrics.OPC_CONNECTIONS_TOTAL.labels(