feat: Rebrand Polkadot/Substrate references to PezkuwiChain
This commit systematically rebrands various references from Parity Technologies' Polkadot/Substrate ecosystem to PezkuwiChain within the kurdistan-sdk. Key changes include: - Updated external repository URLs (zombienet-sdk, parity-db, parity-scale-codec, wasm-instrument) to point to pezkuwichain forks. - Modified internal documentation and code comments to reflect PezkuwiChain naming and structure. - Replaced direct references to with or specific paths within the for XCM, Pezkuwi, and other modules. - Cleaned up deprecated issue and PR references in various and files, particularly in and modules. - Adjusted image and logo URLs in documentation to point to PezkuwiChain assets. - Removed or rephrased comments related to external Polkadot/Substrate PRs and issues. This is a significant step towards fully customizing the SDK for the PezkuwiChain ecosystem.
This commit is contained in:
@@ -0,0 +1,173 @@
|
||||
// This file is part of Bizinikiwi.
|
||||
|
||||
// Copyright (C) Parity Technologies (UK) Ltd.
|
||||
// SPDX-License-Identifier: Apache-2.0
|
||||
|
||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||
// you may not use this file except in compliance with the License.
|
||||
// You may obtain a copy of the License at
|
||||
//
|
||||
// http://www.apache.org/licenses/LICENSE-2.0
|
||||
//
|
||||
// Unless required by applicable law or agreed to in writing, software
|
||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
// See the License for the specific language governing permissions and
|
||||
// limitations under the License.
|
||||
|
||||
mod sourced;
|
||||
|
||||
use hyper::{http::StatusCode, Request, Response};
|
||||
use prometheus::{core::Collector, Encoder, TextEncoder};
|
||||
use std::net::SocketAddr;
|
||||
|
||||
pub use prometheus::{
|
||||
self,
|
||||
core::{
|
||||
AtomicF64 as F64, AtomicI64 as I64, AtomicU64 as U64, GenericCounter as Counter,
|
||||
GenericCounterVec as CounterVec, GenericGauge as Gauge, GenericGaugeVec as GaugeVec,
|
||||
},
|
||||
exponential_buckets, histogram_opts, linear_buckets, Error as PrometheusError, Histogram,
|
||||
HistogramOpts, HistogramVec, Opts, Registry,
|
||||
};
|
||||
pub use sourced::{MetricSource, SourcedCounter, SourcedGauge, SourcedMetric};
|
||||
|
||||
type Body = http_body_util::Full<hyper::body::Bytes>;
|
||||
|
||||
pub fn register<T: Clone + Collector + 'static>(
|
||||
metric: T,
|
||||
registry: &Registry,
|
||||
) -> Result<T, PrometheusError> {
|
||||
registry.register(Box::new(metric.clone()))?;
|
||||
Ok(metric)
|
||||
}
|
||||
|
||||
#[derive(Debug, thiserror::Error)]
|
||||
pub enum Error {
|
||||
/// Hyper internal error.
|
||||
#[error(transparent)]
|
||||
Hyper(#[from] hyper::Error),
|
||||
|
||||
/// Http request error.
|
||||
#[error(transparent)]
|
||||
Http(#[from] hyper::http::Error),
|
||||
|
||||
/// i/o error.
|
||||
#[error(transparent)]
|
||||
Io(#[from] std::io::Error),
|
||||
|
||||
#[error("Prometheus port {0} already in use.")]
|
||||
PortInUse(SocketAddr),
|
||||
}
|
||||
|
||||
async fn request_metrics(
|
||||
req: Request<hyper::body::Incoming>,
|
||||
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)
|
||||
}
|
||||
}
|
||||
|
||||
/// Initializes the metrics context, and starts an HTTP server
|
||||
/// to serve metrics.
|
||||
pub async fn init_prometheus(prometheus_addr: SocketAddr, registry: Registry) -> Result<(), Error> {
|
||||
let listener = tokio::net::TcpListener::bind(&prometheus_addr).await.map_err(|e| {
|
||||
log::error!(target: "prometheus", "Error binding to '{prometheus_addr:?}': {e:?}");
|
||||
Error::PortInUse(prometheus_addr)
|
||||
})?;
|
||||
|
||||
init_prometheus_with_listener(listener, registry).await
|
||||
}
|
||||
|
||||
/// Init prometheus using the given listener.
|
||||
async fn init_prometheus_with_listener(
|
||||
listener: tokio::net::TcpListener,
|
||||
registry: Registry,
|
||||
) -> Result<(), Error> {
|
||||
log::info!(target: "prometheus", "〽️ Prometheus exporter started at {}", listener.local_addr()?);
|
||||
|
||||
let server = hyper_util::server::conn::auto::Builder::new(hyper_util::rt::TokioExecutor::new());
|
||||
let graceful = hyper_util::server::graceful::GracefulShutdown::new();
|
||||
|
||||
loop {
|
||||
let io = match listener.accept().await {
|
||||
Ok((sock, _)) => hyper_util::rt::TokioIo::new(sock),
|
||||
Err(e) => {
|
||||
log::debug!(target: "prometheus", "Error accepting connection: {:?}", e);
|
||||
continue;
|
||||
},
|
||||
};
|
||||
|
||||
let registry = registry.clone();
|
||||
|
||||
let conn = server
|
||||
.serve_connection_with_upgrades(
|
||||
io,
|
||||
hyper::service::service_fn(move |req| request_metrics(req, registry.clone())),
|
||||
)
|
||||
.into_owned();
|
||||
let conn = graceful.watch(conn);
|
||||
|
||||
tokio::spawn(async move {
|
||||
if let Err(err) = conn.await {
|
||||
log::debug!(target: "prometheus", "connection error: {:?}", err);
|
||||
}
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
use http_body_util::BodyExt;
|
||||
use hyper::Uri;
|
||||
use hyper_util::{client::legacy::Client, rt::TokioExecutor};
|
||||
|
||||
const METRIC_NAME: &str = "test_test_metric_name_test_test";
|
||||
|
||||
#[tokio::test]
|
||||
async fn prometheus_works() {
|
||||
let listener =
|
||||
tokio::net::TcpListener::bind("127.0.0.1:0").await.expect("Creates listener");
|
||||
|
||||
let local_addr = listener.local_addr().expect("Returns the local addr");
|
||||
|
||||
let registry = Registry::default();
|
||||
register(
|
||||
prometheus::Counter::new(METRIC_NAME, "yeah").expect("Creates test counter"),
|
||||
®istry,
|
||||
)
|
||||
.expect("Registers the test metric");
|
||||
|
||||
tokio::spawn(init_prometheus_with_listener(listener, registry));
|
||||
|
||||
let client = Client::builder(TokioExecutor::new()).build_http::<Body>();
|
||||
|
||||
let res = client
|
||||
.get(Uri::try_from(&format!("http://{}/metrics", local_addr)).expect("Parses URI"))
|
||||
.await
|
||||
.expect("Requests metrics");
|
||||
|
||||
assert!(res.status().is_success());
|
||||
|
||||
let buf = res.into_body().collect().await.expect("Failed to read HTTP body").to_bytes();
|
||||
let body = String::from_utf8(buf.to_vec()).expect("Converts body to String");
|
||||
|
||||
assert!(body.contains(&format!("{} 0", METRIC_NAME)));
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,157 @@
|
||||
// This file is part of Bizinikiwi.
|
||||
|
||||
// Copyright (C) Parity Technologies (UK) Ltd.
|
||||
// SPDX-License-Identifier: Apache-2.0
|
||||
|
||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||
// you may not use this file except in compliance with the License.
|
||||
// You may obtain a copy of the License at
|
||||
//
|
||||
// http://www.apache.org/licenses/LICENSE-2.0
|
||||
//
|
||||
// Unless required by applicable law or agreed to in writing, software
|
||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
// See the License for the specific language governing permissions and
|
||||
// limitations under the License.
|
||||
|
||||
//! Metrics that are collected from existing sources.
|
||||
|
||||
use prometheus::{
|
||||
core::{Collector, Desc, Describer, Number, Opts},
|
||||
proto,
|
||||
};
|
||||
use std::{cmp::Ordering, marker::PhantomData};
|
||||
|
||||
/// A counter whose values are obtained from an existing source.
|
||||
///
|
||||
/// > **Note*: The counter values provided by the source `S`
|
||||
/// > must be monotonically increasing. Otherwise use a
|
||||
/// > [`SourcedGauge`] instead.
|
||||
pub type SourcedCounter<S> = SourcedMetric<Counter, S>;
|
||||
|
||||
/// A gauge whose values are obtained from an existing source.
|
||||
pub type SourcedGauge<S> = SourcedMetric<Gauge, S>;
|
||||
|
||||
/// The type of a sourced counter.
|
||||
#[derive(Copy, Clone)]
|
||||
pub enum Counter {}
|
||||
|
||||
/// The type of a sourced gauge.
|
||||
#[derive(Copy, Clone)]
|
||||
pub enum Gauge {}
|
||||
|
||||
/// A metric whose values are obtained from an existing source,
|
||||
/// instead of being independently recorded.
|
||||
#[derive(Debug, Clone)]
|
||||
pub struct SourcedMetric<T, S> {
|
||||
source: S,
|
||||
desc: Desc,
|
||||
_type: PhantomData<T>,
|
||||
}
|
||||
|
||||
/// A source of values for a [`SourcedMetric`].
|
||||
pub trait MetricSource: Sync + Send + Clone {
|
||||
/// The type of the collected values.
|
||||
type N: Number;
|
||||
/// Collects the current values of the metrics from the source.
|
||||
fn collect(&self, set: impl FnMut(&[&str], Self::N));
|
||||
}
|
||||
|
||||
impl<T: SourcedType, S: MetricSource> SourcedMetric<T, S> {
|
||||
/// Creates a new metric that obtains its values from the given source.
|
||||
pub fn new(opts: &Opts, source: S) -> prometheus::Result<Self> {
|
||||
let desc = opts.describe()?;
|
||||
Ok(Self { source, desc, _type: PhantomData })
|
||||
}
|
||||
}
|
||||
|
||||
impl<T: SourcedType, S: MetricSource> Collector for SourcedMetric<T, S> {
|
||||
fn desc(&self) -> Vec<&Desc> {
|
||||
vec![&self.desc]
|
||||
}
|
||||
|
||||
fn collect(&self) -> Vec<proto::MetricFamily> {
|
||||
let mut counters = Vec::new();
|
||||
|
||||
self.source.collect(|label_values, value| {
|
||||
let mut m = proto::Metric::default();
|
||||
|
||||
match T::proto() {
|
||||
proto::MetricType::COUNTER => {
|
||||
let mut c = proto::Counter::default();
|
||||
c.set_value(value.into_f64());
|
||||
m.set_counter(c);
|
||||
},
|
||||
proto::MetricType::GAUGE => {
|
||||
let mut g = proto::Gauge::default();
|
||||
g.set_value(value.into_f64());
|
||||
m.set_gauge(g);
|
||||
},
|
||||
t => {
|
||||
log::error!("Unsupported sourced metric type: {:?}", t);
|
||||
},
|
||||
}
|
||||
|
||||
debug_assert_eq!(self.desc.variable_labels.len(), label_values.len());
|
||||
match self.desc.variable_labels.len().cmp(&label_values.len()) {
|
||||
Ordering::Greater => {
|
||||
log::warn!("Missing label values for sourced metric {}", self.desc.fq_name)
|
||||
},
|
||||
Ordering::Less => {
|
||||
log::warn!("Too many label values for sourced metric {}", self.desc.fq_name)
|
||||
},
|
||||
Ordering::Equal => {},
|
||||
}
|
||||
|
||||
m.set_label(
|
||||
self.desc
|
||||
.variable_labels
|
||||
.iter()
|
||||
.zip(label_values)
|
||||
.map(|(l_name, l_value)| {
|
||||
let mut l = proto::LabelPair::default();
|
||||
l.set_name(l_name.to_string());
|
||||
l.set_value(l_value.to_string());
|
||||
l
|
||||
})
|
||||
.chain(self.desc.const_label_pairs.iter().cloned())
|
||||
.collect::<Vec<_>>(),
|
||||
);
|
||||
|
||||
counters.push(m);
|
||||
});
|
||||
|
||||
let mut m = proto::MetricFamily::default();
|
||||
m.set_name(self.desc.fq_name.clone());
|
||||
m.set_help(self.desc.help.clone());
|
||||
m.set_field_type(T::proto());
|
||||
m.set_metric(counters);
|
||||
|
||||
vec![m]
|
||||
}
|
||||
}
|
||||
|
||||
/// Types of metrics that can obtain their values from an existing source.
|
||||
pub trait SourcedType: private::Sealed + Sync + Send {
|
||||
#[doc(hidden)]
|
||||
fn proto() -> proto::MetricType;
|
||||
}
|
||||
|
||||
impl SourcedType for Counter {
|
||||
fn proto() -> proto::MetricType {
|
||||
proto::MetricType::COUNTER
|
||||
}
|
||||
}
|
||||
|
||||
impl SourcedType for Gauge {
|
||||
fn proto() -> proto::MetricType {
|
||||
proto::MetricType::GAUGE
|
||||
}
|
||||
}
|
||||
|
||||
mod private {
|
||||
pub trait Sealed {}
|
||||
impl Sealed for super::Counter {}
|
||||
impl Sealed for super::Gauge {}
|
||||
}
|
||||
Reference in New Issue
Block a user