// Copyright 2019-2021 Parity Technologies (UK) Ltd. // This file is part of Parity Bridges Common. // Parity Bridges Common is free software: you can redistribute it and/or modify // it under the terms of the GNU General Public License as published by // the Free Software Foundation, either version 3 of the License, or // (at your option) any later version. // Parity Bridges Common is distributed in the hope that it will be useful, // but WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU General Public License for more details. // You should have received a copy of the GNU General Public License // along with Parity Bridges Common. If not, see . //! Global system-wide Prometheus metrics exposed by relays. use crate::metrics::{ metric_name, register, Gauge, GaugeVec, Opts, PrometheusError, Registry, StandaloneMetrics, F64, U64, }; use async_std::sync::{Arc, Mutex}; use async_trait::async_trait; use std::time::Duration; use sysinfo::{ProcessExt, RefreshKind, System, SystemExt}; /// Global metrics update interval. const UPDATE_INTERVAL: Duration = Duration::from_secs(10); /// Global Prometheus metrics. #[derive(Debug, Clone)] pub struct GlobalMetrics { system: Arc>, system_average_load: GaugeVec, process_cpu_usage_percentage: Gauge, process_memory_usage_bytes: Gauge, } impl GlobalMetrics { /// Create and register global metrics. pub fn new(registry: &Registry, prefix: Option<&str>) -> Result { Ok(GlobalMetrics { system: Arc::new(Mutex::new(System::new_with_specifics(RefreshKind::everything()))), system_average_load: register( GaugeVec::new( Opts::new(metric_name(prefix, "system_average_load"), "System load average"), &["over"], )?, registry, )?, process_cpu_usage_percentage: register( Gauge::new(metric_name(prefix, "process_cpu_usage_percentage"), "Process CPU usage")?, registry, )?, process_memory_usage_bytes: register( Gauge::new( metric_name(prefix, "process_memory_usage_bytes"), "Process memory (resident set size) usage", )?, registry, )?, }) } } #[async_trait] impl StandaloneMetrics for GlobalMetrics { async fn update(&self) { // update system-wide metrics let mut system = self.system.lock().await; let load = system.get_load_average(); self.system_average_load.with_label_values(&["1min"]).set(load.one); self.system_average_load.with_label_values(&["5min"]).set(load.five); self.system_average_load.with_label_values(&["15min"]).set(load.fifteen); // update process-related metrics let pid = sysinfo::get_current_pid().expect( "only fails where pid is unavailable (os=unknown || arch=wasm32);\ relay is not supposed to run in such MetricsParamss;\ qed", ); let is_process_refreshed = system.refresh_process(pid); match (is_process_refreshed, system.get_process(pid)) { (true, Some(process_info)) => { let cpu_usage = process_info.cpu_usage() as f64; let memory_usage = process_info.memory() * 1024; log::trace!( target: "bridge-metrics", "Refreshed process metrics: CPU={}, memory={}", cpu_usage, memory_usage, ); self.process_cpu_usage_percentage .set(if cpu_usage.is_finite() { cpu_usage } else { 0f64 }); self.process_memory_usage_bytes.set(memory_usage); } _ => { log::warn!( target: "bridge-metrics", "Failed to refresh process information. Metrics may show obsolete values", ); } } } fn update_interval(&self) -> Duration { UPDATE_INTERVAL } }