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,145 @@
|
||||
// This file is part of Bizinikiwi.
|
||||
|
||||
// Copyright (C) Parity Technologies (UK) Ltd.
|
||||
// SPDX-License-Identifier: GPL-3.0-or-later WITH Classpath-exception-2.0
|
||||
|
||||
// This program 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.
|
||||
|
||||
// This program 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 this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
use clap::Args;
|
||||
use pezsp_core::traits::SpawnEssentialNamed;
|
||||
use std::{
|
||||
io,
|
||||
path::{Path, PathBuf},
|
||||
time::Duration,
|
||||
};
|
||||
|
||||
const LOG_TARGET: &str = "storage-monitor";
|
||||
|
||||
/// Result type used in this crate.
|
||||
pub type Result<T> = std::result::Result<T, Error>;
|
||||
|
||||
/// Error type used in this crate.
|
||||
#[derive(Debug, thiserror::Error)]
|
||||
pub enum Error {
|
||||
#[error("IO Error")]
|
||||
IOError(#[from] io::Error),
|
||||
#[error("Out of storage space: available {0}MiB, required {1}MiB")]
|
||||
StorageOutOfSpace(u64, u64),
|
||||
}
|
||||
|
||||
/// Parameters used to create the storage monitor.
|
||||
#[derive(Default, Debug, Clone, Args)]
|
||||
pub struct StorageMonitorParams {
|
||||
/// Required available space on database storage.
|
||||
///
|
||||
/// If available space for DB storage drops below the given threshold, node will
|
||||
/// be gracefully terminated.
|
||||
///
|
||||
/// If `0` is given monitoring will be disabled.
|
||||
#[arg(long = "db-storage-threshold", value_name = "MiB", default_value_t = 1024)]
|
||||
pub threshold: u64,
|
||||
|
||||
/// How often available space is polled.
|
||||
#[arg(long = "db-storage-polling-period", value_name = "SECONDS", default_value_t = 5, value_parser = clap::value_parser!(u32).range(1..))]
|
||||
pub polling_period: u32,
|
||||
}
|
||||
|
||||
/// Storage monitor service: checks the available space for the filesystem for given path.
|
||||
pub struct StorageMonitorService {
|
||||
/// watched path
|
||||
path: PathBuf,
|
||||
/// number of megabytes that shall be free on the filesystem for watched path
|
||||
threshold: u64,
|
||||
/// storage space polling period
|
||||
polling_period: Duration,
|
||||
}
|
||||
|
||||
impl StorageMonitorService {
|
||||
/// Creates new StorageMonitorService for given client config
|
||||
pub fn try_spawn(
|
||||
parameters: StorageMonitorParams,
|
||||
path: PathBuf,
|
||||
spawner: &impl SpawnEssentialNamed,
|
||||
) -> Result<()> {
|
||||
if parameters.threshold == 0 {
|
||||
log::info!(
|
||||
target: LOG_TARGET,
|
||||
"StorageMonitorService: threshold `0` given, storage monitoring disabled",
|
||||
);
|
||||
} else {
|
||||
log::debug!(
|
||||
target: LOG_TARGET,
|
||||
"Initializing StorageMonitorService for db path: {}",
|
||||
path.display()
|
||||
);
|
||||
|
||||
Self::check_free_space(&path, parameters.threshold)?;
|
||||
|
||||
let storage_monitor_service = StorageMonitorService {
|
||||
path,
|
||||
threshold: parameters.threshold,
|
||||
polling_period: Duration::from_secs(parameters.polling_period.into()),
|
||||
};
|
||||
|
||||
spawner.spawn_essential(
|
||||
"storage-monitor",
|
||||
None,
|
||||
Box::pin(storage_monitor_service.run()),
|
||||
);
|
||||
}
|
||||
|
||||
Ok(())
|
||||
}
|
||||
|
||||
/// Main monitoring loop, intended to be spawned as essential task. Quits if free space drop
|
||||
/// below threshold.
|
||||
async fn run(self) {
|
||||
loop {
|
||||
tokio::time::sleep(self.polling_period).await;
|
||||
if Self::check_free_space(&self.path, self.threshold).is_err() {
|
||||
break;
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
/// Returns free space in MiB, or error if statvfs failed.
|
||||
fn free_space(path: &Path) -> Result<u64> {
|
||||
Ok(fs4::available_space(path).map(|s| s / 1024 / 1024)?)
|
||||
}
|
||||
|
||||
/// Checks if the amount of free space for given `path` is above given `threshold` in MiB.
|
||||
/// If it dropped below, error is returned.
|
||||
/// System errors are silently ignored.
|
||||
fn check_free_space(path: &Path, threshold: u64) -> Result<()> {
|
||||
match StorageMonitorService::free_space(path) {
|
||||
Ok(available_space) => {
|
||||
log::trace!(
|
||||
target: LOG_TARGET,
|
||||
"free: {available_space} , threshold: {threshold}.",
|
||||
);
|
||||
|
||||
if available_space < threshold {
|
||||
log::error!(target: LOG_TARGET, "Available space {available_space}MiB for path `{}` dropped below threshold: {threshold}MiB , terminating...", path.display());
|
||||
Err(Error::StorageOutOfSpace(available_space, threshold))
|
||||
} else {
|
||||
Ok(())
|
||||
}
|
||||
},
|
||||
Err(e) => {
|
||||
log::error!(target: LOG_TARGET, "Could not read available space: {e:?}.");
|
||||
Err(e)
|
||||
},
|
||||
}
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user