Struct EnhancedMetricsProvider 

pub struct EnhancedMetricsProvider { /* private fields */ }

A comprehensive metrics provider that integrates Prometheus and OpenTelemetry systems.

This provider acts as the central metrics collection and export hub for the QoS system, collecting system metrics, application-specific metrics, and custom metrics. It manages metric collection, storage, and export to monitoring systems through Prometheus and OpenTelemetry protocols. The provider supports historical metrics collection and can manage an embedded Prometheus server for metrics exposure.

Implementations

impl EnhancedMetricsProvider

pub fn new( metrics_config: MetricsConfig, otel_config: &OpenTelemetryConfig, ) -> Result<Self>

Creates a new enhanced metrics provider with Prometheus and OpenTelemetry support.

Initializes the metrics collection infrastructure including Prometheus collectors, OpenTelemetry exporters, and shared registries. Sets up metric collection for both system-level and application-specific metrics, and prepares the provider for metrics export through multiple protocols.

Parameters

• metrics_config - Configuration for metrics collection, retention, and reporting
• otel_config - OpenTelemetry-specific configuration settings

Errors

Returns an error if the PrometheusCollector or OpenTelemetryExporter initialization fails.

pub async fn start_collection(self: Arc<Self>) -> Result<()>

Starts the metrics collection and reporting process.

This method initializes the background metrics collection task that periodically gathers system and blueprint metrics. It also starts the Prometheus server if configured to expose metrics via HTTP endpoints. This method should be called once after creating the provider to begin the metrics pipeline.

Errors

Returns an error if the PrometheusServer fails to start or if the background metrics collection task cannot be created.

pub fn record_job_execution( &self, job_id: u64, execution_time: f64, service_id: u64, blueprint_id: u64, )

Records metrics for a successful job execution.

Updates both Prometheus and OpenTelemetry metrics with information about a completed job. This includes recording the execution time, incrementing job counters, and updating histograms with execution duration data. Job metrics are tagged with service ID, blueprint ID, and job ID to enable detailed filtering and analysis.

Parameters

• job_id - Unique identifier for the executed job
• execution_time - Duration of the job execution in seconds
• service_id - Identifier for the service that executed the job
• blueprint_id - Identifier for the blueprint that executed the job

pub fn record_job_error(&self, job_id: u64, error_type: &str)

Records metrics for a failed job execution.

Updates error counters and metrics when a job fails, categorizing the error by type. This method enables tracking of error rates and common failure modes across jobs.

Parameters

• job_id - Unique identifier for the failed job
• error_type - Classification of the error that occurred

pub fn opentelemetry_exporter(&self) -> Arc<OpenTelemetryExporter>

Returns a reference to the OpenTelemetryExporter.

Provides access to the underlying OpenTelemetryExporter for advanced operations such as creating custom meters, recorders, or manually pushing metrics to the OpenTelemetry backend.

pub fn prometheus_collector(&self) -> Arc<PrometheusCollector>

Returns a reference to the PrometheusCollector.

Provides access to the underlying PrometheusCollector for advanced operations such as registering custom collectors or directly manipulating Prometheus metrics.

pub fn get_otel_job_executions_counter(&self) -> Counter<u64>

Returns a clone of the OpenTelemetry job executions counter.

This counter tracks the total number of job executions recorded through OpenTelemetry. It can be used to increment execution counts from external components.

pub fn shared_registry(&self) -> Arc<Registry>

Returns the shared Prometheus registry used for all metrics.

This registry consolidates all Prometheus metrics from both direct Prometheus collectors and OpenTelemetry exporters. It’s useful for registering additional custom collectors or exporting all metrics to external systems.

pub fn force_flush_otel_metrics(&self) -> Result<()>

Forces flush of accumulated OpenTelemetry metrics to their destination.

This method triggers an immediate export of all buffered OpenTelemetry metrics rather than waiting for the normal export interval. This is useful during graceful shutdown or when immediate metric visibility is required.

Errors

Returns an error if the OpenTelemetryExporter fails to force flush metrics.

Trait Implementations

impl Clone for EnhancedMetricsProvider

fn clone(&self) -> EnhancedMetricsProvider

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl MetricsProvider for EnhancedMetricsProvider

async fn get_system_metrics(&self) -> SystemMetrics

Returns the latest collected SystemMetrics.

async fn get_blueprint_metrics(&self) -> BlueprintMetrics

Returns the latest collected BlueprintMetrics.

async fn get_blueprint_status(&self) -> BlueprintStatus

Returns the current BlueprintStatus.

async fn get_system_metrics_history(&self) -> Vec<SystemMetrics>

Returns the historical SystemMetrics (up to max_history).

async fn get_blueprint_metrics_history(&self) -> Vec<BlueprintMetrics>

Returns the historical BlueprintMetrics (up to max_history).

async fn add_custom_metric(&self, key: String, value: String)

Adds a custom metric to the collection.

Parameters

• key - The key for the custom metric.
• value - The value of the custom metric.

async fn set_blueprint_status( &self, status_code: u32, status_message: Option<String>, )

Sets the BlueprintStatus.

Parameters

• status_code - The status code to set.
• status_message - An optional status message.

async fn update_last_heartbeat(&self, timestamp: u64)

Updates the last heartbeat timestamp in the BlueprintStatus.

Parameters

• timestamp - The Unix timestamp of the last heartbeat.

async fn start_collection(&self) -> Result<()>

Starts the metrics collection process for this provider.

This typically involves spawning background tasks for periodic metric gathering and potentially starting servers for metric exposure (e.g., a Prometheus server).

Errors

Returns an error if the collection process or any associated services fail to start.