SIENTIAPDE-1084

Update README.md to clarify data streaming and storage features

- Revised descriptions for Real-time Data Streaming and Persistent Storage to emphasize historical data streaming capabilities.
- Updated Data Manager section to reflect the integration of both MongoDB and Kafka for data management.
- Enhanced configuration example in the prerequisites section with additional fields for server configuration.
This commit is contained in:
vitor-aignosi
2025-08-29 11:26:36 -03:00
parent 8f6ba4ddcf
commit 873c733730

View File

@@ -7,8 +7,8 @@ A high-performance, scalable OPC UA data ingestion system designed for industria
### Core Functionality ### Core Functionality
- **OPC UA Integration**: Native support for OPC UA servers with secure and unsecured connections - **OPC UA Integration**: Native support for OPC UA servers with secure and unsecured connections
- **Automatic Load Balancing**: Slot-based architecture for horizontal scaling across multiple instances - **Automatic Load Balancing**: Slot-based architecture for horizontal scaling across multiple instances
- **Real-time Data Streaming**: Kafka integration for high-throughput data distribution - **Real-time Data Streaming**: Kafka integration for historical data streaming
- **Persistent Storage**: MongoDB integration for historical data retention and analysis - **Persistent Storage**: MongoDB integration for historical data streaming
- **Health Monitoring**: Comprehensive Prometheus metrics and health checks - **Health Monitoring**: Comprehensive Prometheus metrics and health checks
- **Fault Tolerance**: Automatic failover, reconnection, and error recovery - **Fault Tolerance**: Automatic failover, reconnection, and error recovery
@@ -47,7 +47,7 @@ The OPC Ingestor uses a modular, manager-based architecture:
- **Ingestor**: Main application orchestrator managing the overall lifecycle - **Ingestor**: Main application orchestrator managing the overall lifecycle
- **IngestorManager**: Coordinates slot allocation, OPC server management, and load balancing - **IngestorManager**: Coordinates slot allocation, OPC server management, and load balancing
- **OPC Manager**: Handles individual OPC UA server connections and tag subscriptions - **OPC Manager**: Handles individual OPC UA server connections and tag subscriptions
- **Data Manager**: Manages data persistence (MongoDB) and streaming (Kafka) - **Data Manager**: Manages data streaming (MongoDB | Kafka)
- **Resource Manager**: Coordinates resource allocation and instance coordination via Redis - **Resource Manager**: Coordinates resource allocation and instance coordination via Redis
## 📋 Prerequisites ## 📋 Prerequisites
@@ -253,14 +253,24 @@ OPC servers are configured through Redis with the following structure:
"slot:opc_tags:1": { "slot:opc_tags:1": {
"server1": { "server1": {
"name": "server1", "name": "server1",
"server_id": "1",
"url": "opc.tcp://localhost:4841", "url": "opc.tcp://localhost:4841",
"server_uri": "http://opcua-server.simulator", "server_uri": "http://opcua-server.simulator",
"tags": { "tags": {
"ns=2;i=2": { "ns=2;i=2": {
"aggr_func": "avg",
"data_range": [
-100,
100
],
"frequency": "15000",
"server_id": "1",
"tag_address": "ns=2;i=2",
"tag_name": "Counter", "tag_name": "Counter",
"frequency": 1000, "topics": [
"topics": ["opcua", "counter"] "raw_scouter-opcua-orchestrated-pipeline",
} "raw_scouter-basic-sum-model"
]
} }
} }
} }