loda-rust/rust_project/loda-rust-cli/src/mine/metrics_worker.rs

use super::{MetricEvent, MetricsPrometheus, MovingAverage, Recorder, CoordinatorWorkerMessage};
use std::time::{Duration, Instant};
use prometheus_client::encoding::text::encode;
use prometheus_client::registry::Registry;
use std::sync::{Arc, Mutex};
use bastion::prelude::*;

pub struct MetricsWorker;

impl MetricsWorker {
    /// Print metrics every second to commandline.
    pub fn start_without_server() -> anyhow::Result<()> {
        Bastion::supervisor(|supervisor| {
            supervisor.children(|children| {
                children
                    .with_redundancy(1)
                    .with_distributor(Distributor::named("metrics_worker"))
                    .with_exec(metrics_worker_print)
            })
        }).expect("Unable to create metrics_worker_print");
        Ok(())
    }

    /// Runs a webserver with realtime metrics, so bottlenecks can be identified.
    pub fn start_with_server(listen_on_port: u16, number_of_workers: u64) -> anyhow::Result<()> {
        println!("miner metrics can be downloaded here: http://localhost:{}/metrics", listen_on_port);
    
        let mut registry = <Registry>::default();
        let metrics = MetricsPrometheus::new(&mut registry);
        metrics.number_of_workers.set(number_of_workers);
    
        let registry2: MyRegistry = Arc::new(Mutex::new(registry));
    
        let _ = tokio::spawn(async move {
            let result = webserver_with_metrics(registry2, listen_on_port).await;
            if let Err(error) = result {
                error!("webserver thread failed with error: {:?}", error);
            }
        });

        Bastion::supervisor(|supervisor| {
            supervisor.children(|children| {
                children
                    .with_redundancy(1)
                    .with_distributor(Distributor::named("metrics_worker"))
                    .with_exec(move |ctx: BastionContext| {
                        let metrics_clone = metrics.clone();
                        async move {
                            metrics_worker_server(
                                ctx,
                                metrics_clone,
                            ).await
                        }
                    })
            })
        }).expect("Unable to create metrics_worker_webserver");
        Ok(())
    }
}

#[derive(Clone)]
struct State {
    registry: MyRegistry,
}

type MyRegistryInner = prometheus_client::registry::Registry<std::boxed::Box<dyn prometheus_client::encoding::text::SendSyncEncodeMetric>>;
type MyRegistry = std::sync::Arc<std::sync::Mutex<MyRegistryInner>>;

async fn webserver_with_metrics(registry: MyRegistry, listen_port: u16) -> std::result::Result<(), Box<dyn std::error::Error>> {
    let mut app = tide::with_state(State {
        registry: registry,
    });
    app.at("/").get(|_| async { Ok("Hello, world!") });
    app.at("/sync").get(|_| async {
        let distributor = Distributor::named("coordinator_worker");
        let tell_result = distributor.tell_everyone(CoordinatorWorkerMessage::TriggerSync);
        if let Err(error) = tell_result {
            let response = tide::Response::builder(500)
                .body(format!("webserver_with_metrics: /sync - Unable to send TriggerSync to coordinator_worker_distributor. {:?}", error))
                .content_type("text/plain; charset=utf-8")
                .build();
            return Ok(response);
        }
        let response = tide::Response::builder(200)
            .body("did send TriggerSync")
            .content_type("text/plain; charset=utf-8")
            .build();
        Ok(response)
    });
    app.at("/metrics")
        .get(|req: tide::Request<State>| async move {
            let mut encoded = Vec::new();
            {
                let registry = match req.state().registry.lock() {
                    Ok(value) => value,
                    Err(error) => {
                        error!("webserver_with_metrics: /metrics - Unable to lock registry. {:?}", error);
                        let response = tide::Response::builder(500)
                            .body(format!("webserver_with_metrics: /metrics - Unable to lock registry. {:?}", error))
                            .content_type("text/plain; charset=utf-8")
                            .build();
                        return Ok(response);
                    }
                };
                match encode(&mut encoded, &registry) {
                    Ok(()) => {},
                    Err(error) => {
                        error!("webserver_with_metrics: /metrics - Unable to encode registry. {:?}", error);
                        let response = tide::Response::builder(500)
                            .body(format!("webserver_with_metrics: /metrics - Unable to encode registry. {:?}", error))
                            .content_type("text/plain; charset=utf-8")
                            .build();
                        return Ok(response);
                    }
                }
            }
            let response = tide::Response::builder(200)
                .body(encoded)
                .content_type("application/openmetrics-text; version=1.0.0; charset=utf-8")
                .build();
            Ok(response)
        });
    let server_address = format!("localhost:{}", listen_port);
    app.listen(server_address).await?;
    Ok(())
}

/// Inspect metrics via the Graphana dashboard.
/// 
/// Underneeth Graphana accesses the data via Prometheus.
/// 
/// This function forwards metrics events to Prometheus.
async fn metrics_worker_server(ctx: BastionContext, metrics: MetricsPrometheus) -> Result<(), ()> {
    debug!("metrics_worker_server is ready");
    let mut progress_time = Instant::now();
    let mut miner_iteration_count: u64 = 0;
    let mut moving_average = MovingAverage::new();
    loop {
        let elapsed: u128 = progress_time.elapsed().as_millis();
        if elapsed >= 1000 {
            // Compute average number of iterations over the last second.
            moving_average.insert(miner_iteration_count);
            let weighted_average: u64 = moving_average.average();
            moving_average.rotate();
            metrics.number_of_iteration_now.set(weighted_average);

            progress_time = Instant::now();
            miner_iteration_count = 0;
        }

        let timeout = Duration::from_millis(1000);
        let message: SignedMessage = match ctx.try_recv_timeout(timeout).await {
            Ok(message) => message,
            Err(error) => {
                if let ReceiveError::Timeout(_duration) = error {
                    debug!("metrics_worker_server: timeout happened");
                    continue;
                }
                error!("metrics_worker_server: Unknown error happened. error: {:?}", error);
                continue;
            }
        };
        MessageHandler::new(message)
            .on_tell(|metric_event: MetricEvent, _| {
                if let MetricEvent::General { number_of_iterations, .. } = metric_event {
                    miner_iteration_count += number_of_iterations;
                }
                metrics.record(&metric_event);
            })
            .on_fallback(|unknown, _sender_addr| {
                error!(
                    "metrics_worker_server {}, received an unknown message!:\n{:?}",
                    ctx.current().id(),
                    unknown
                );
            });
    }
}

/// Inspect metrics from commandline.
/// 
/// Prints stats with 1 second interval.
async fn metrics_worker_print(ctx: BastionContext) -> Result<(), ()> {
    debug!("metrics_worker_print is ready");
    let mut progress_time = Instant::now();
    let mut miner_iteration_count: u64 = 0;
    let mut metric_event_count: u64 = 0;
    loop {
        let elapsed: u128 = progress_time.elapsed().as_millis();
        if elapsed >= 1000 {
            if miner_iteration_count > 0 {
                println!("miner_iterations: {}", miner_iteration_count);
            } else {
                debug!("metrics_worker_print: metric_events: {} miner_iterations: {} - no activity", metric_event_count, miner_iteration_count);
            }
            progress_time = Instant::now();
            miner_iteration_count = 0;
            metric_event_count = 0;
        }

        let timeout = Duration::from_millis(1000);
        let message: SignedMessage = match ctx.try_recv_timeout(timeout).await {
            Ok(message) => message,
            Err(error) => {
                if let ReceiveError::Timeout(_duration) = error {
                    debug!("metrics_worker_print: timeout happened");
                    continue;
                }
                error!("metrics_worker_print: Unknown error happened. error: {:?}", error);
                continue;
            }
        };
        MessageHandler::new(message)
            .on_tell(|metric_event: MetricEvent, _| {
                metric_event_count += 1;
                if let MetricEvent::General { number_of_iterations, .. } = metric_event {
                    miner_iteration_count += number_of_iterations;
                }
            })
            .on_fallback(|unknown, _sender_addr| {
                error!(
                    "metrics_worker_print {}, received an unknown message!:\n{:?}",
                    ctx.current().id(),
                    unknown
                );
            });
    }
}