mirror of
https://github.com/pezkuwichain/pezkuwi-subxt.git
synced 2026-06-27 03:31:06 +00:00
Roman Borschel
807329ddb8
* Add support for sourced metrics. A sourced metric is a metric that obtains its values from an existing source, rather than the values being independently recorded. It thus allows collecting metrics from existing counters or gauges without having to duplicate them in a dedicated prometheus counter or gauge (and hence another atomic value). The first use-case is to feed the bandwidth counters from libp2p directly into prometheus. * Tabs, not spaces. * Tweak bandwidth counter registration. * Add debug assertion for variable labels and values. * Document monotonicity requirement for sourced counters. * CI * Update client/network/src/service.rs Co-authored-by: Max Inden <mail@max-inden.de> Co-authored-by: Max Inden <mail@max-inden.de>
151 lines
4.2 KiB
Rust
151 lines
4.2 KiB
Rust
// Copyright 2019 Parity Technologies (UK) Ltd.
|
|
// This file is part of Substrate.
|
|
|
|
// Substrate 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.
|
|
|
|
// Substrate 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 Substrate. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
use futures_util::{FutureExt, future::Future};
|
|
pub use prometheus::{
|
|
self,
|
|
Registry, Error as PrometheusError, Opts,
|
|
Histogram, HistogramOpts, HistogramVec,
|
|
exponential_buckets,
|
|
core::{
|
|
GenericGauge as Gauge, GenericCounter as Counter,
|
|
GenericGaugeVec as GaugeVec, GenericCounterVec as CounterVec,
|
|
AtomicF64 as F64, AtomicI64 as I64, AtomicU64 as U64,
|
|
}
|
|
};
|
|
use prometheus::{Encoder, TextEncoder, core::Collector};
|
|
use std::net::SocketAddr;
|
|
|
|
#[cfg(not(target_os = "unknown"))]
|
|
mod networking;
|
|
mod sourced;
|
|
|
|
pub use sourced::{SourcedCounter, SourcedGauge, MetricSource};
|
|
|
|
#[cfg(target_os = "unknown")]
|
|
pub use unknown_os::init_prometheus;
|
|
#[cfg(not(target_os = "unknown"))]
|
|
pub use known_os::init_prometheus;
|
|
|
|
pub fn register<T: Clone + Collector + 'static>(metric: T, registry: &Registry) -> Result<T, PrometheusError> {
|
|
registry.register(Box::new(metric.clone()))?;
|
|
Ok(metric)
|
|
}
|
|
|
|
// On WASM `init_prometheus` becomes a no-op.
|
|
#[cfg(target_os = "unknown")]
|
|
mod unknown_os {
|
|
use super::*;
|
|
|
|
pub enum Error {}
|
|
|
|
pub async fn init_prometheus(_: SocketAddr, _registry: Registry) -> Result<(), Error> {
|
|
Ok(())
|
|
}
|
|
}
|
|
|
|
#[cfg(not(target_os = "unknown"))]
|
|
mod known_os {
|
|
use super::*;
|
|
use hyper::http::StatusCode;
|
|
use hyper::{Server, Body, Request, Response, service::{service_fn, make_service_fn}};
|
|
|
|
#[derive(Debug, derive_more::Display, derive_more::From)]
|
|
pub enum Error {
|
|
/// Hyper internal error.
|
|
Hyper(hyper::Error),
|
|
/// Http request error.
|
|
Http(hyper::http::Error),
|
|
/// i/o error.
|
|
Io(std::io::Error),
|
|
#[display(fmt = "Prometheus port {} already in use.", _0)]
|
|
PortInUse(SocketAddr)
|
|
}
|
|
|
|
impl std::error::Error for Error {
|
|
fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
|
|
match self {
|
|
Error::Hyper(error) => Some(error),
|
|
Error::Http(error) => Some(error),
|
|
Error::Io(error) => Some(error),
|
|
Error::PortInUse(_) => None
|
|
}
|
|
}
|
|
}
|
|
|
|
async fn request_metrics(req: Request<Body>, registry: Registry) -> Result<Response<Body>, Error> {
|
|
if req.uri().path() == "/metrics" {
|
|
let metric_families = registry.gather();
|
|
let mut buffer = vec![];
|
|
let encoder = TextEncoder::new();
|
|
encoder.encode(&metric_families, &mut buffer).unwrap();
|
|
|
|
Response::builder().status(StatusCode::OK)
|
|
.header("Content-Type", encoder.format_type())
|
|
.body(Body::from(buffer))
|
|
.map_err(Error::Http)
|
|
} else {
|
|
Response::builder().status(StatusCode::NOT_FOUND)
|
|
.body(Body::from("Not found."))
|
|
.map_err(Error::Http)
|
|
}
|
|
|
|
}
|
|
|
|
#[derive(Clone)]
|
|
pub struct Executor;
|
|
|
|
impl<T> hyper::rt::Executor<T> for Executor
|
|
where
|
|
T: Future + Send + 'static,
|
|
T::Output: Send + 'static,
|
|
{
|
|
fn execute(&self, future: T) {
|
|
async_std::task::spawn(future);
|
|
}
|
|
}
|
|
|
|
/// Initializes the metrics context, and starts an HTTP server
|
|
/// to serve metrics.
|
|
pub async fn init_prometheus(prometheus_addr: SocketAddr, registry: Registry) -> Result<(), Error>{
|
|
use networking::Incoming;
|
|
let listener = async_std::net::TcpListener::bind(&prometheus_addr)
|
|
.await
|
|
.map_err(|_| Error::PortInUse(prometheus_addr))?;
|
|
|
|
log::info!("〽️ Prometheus server started at {}", prometheus_addr);
|
|
|
|
let service = make_service_fn(move |_| {
|
|
let registry = registry.clone();
|
|
|
|
async move {
|
|
Ok::<_, hyper::Error>(service_fn(move |req: Request<Body>| {
|
|
request_metrics(req, registry.clone())
|
|
}))
|
|
}
|
|
});
|
|
|
|
let server = Server::builder(Incoming(listener.incoming()))
|
|
.executor(Executor)
|
|
.serve(service)
|
|
.boxed();
|
|
|
|
let result = server.await.map_err(Into::into);
|
|
|
|
result
|
|
}
|
|
}
|