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.
This commit is contained in:
@@ -1,5 +1,22 @@
|
||||
"""
|
||||
Prometheus metrics configuration for the OPC Ingestor application.
|
||||
|
||||
This module defines all the metrics used for monitoring and observability
|
||||
of the OPC Ingestor system. It includes metrics for:
|
||||
|
||||
- Application health and performance
|
||||
- OPC server connections and subscriptions
|
||||
- Data processing and storage operations
|
||||
- Resource management and load balancing
|
||||
- Error tracking and notification systems
|
||||
|
||||
All metrics follow Prometheus naming conventions and include appropriate
|
||||
labels for multi-dimensional analysis and alerting.
|
||||
"""
|
||||
|
||||
from prometheus_client import Counter, Gauge, Histogram
|
||||
|
||||
# Metric label definitions for consistent labeling across all metrics
|
||||
POD_ID_LABEL = ["pod_id"]
|
||||
SERVER_LABELS = ["pod_id", "server_name", "server_url"]
|
||||
KAFKA_LABELS = ["pod_id", "topic"]
|
||||
@@ -15,7 +32,6 @@ TAG_WRITTEN_COUNT = Counter(
|
||||
[*MAIN_LABELS, "tag_name", "collection_name"],
|
||||
)
|
||||
|
||||
|
||||
# --- General Application Metrics ---
|
||||
APP_LOOP_COUNT = Counter(
|
||||
"app_main_loop_total",
|
||||
|
||||
Reference in New Issue
Block a user