This repository has been archived by the owner on Nov 15, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 2.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
refactor(cli): Make some run params reusable (#13870)
* refactor: extract TelemetryParams and PrometheusParams * improve run_cmd docs * extract `RuntimeParams` * use `normalize` * keep params types same style * improve `max_runtime_instances` * fmt * add license and improve code * Update client/cli/src/params/runtime_params.rs Co-authored-by: Bastian Köcher <git@kchr.de> --------- Co-authored-by: Bastian Köcher <git@kchr.de>
- Loading branch information
Showing
9 changed files
with
210 additions
and
103 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,63 @@ | ||
// This file is part of Substrate. | ||
|
||
// 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 sc_service::config::PrometheusConfig; | ||
use std::net::{Ipv4Addr, SocketAddr}; | ||
|
||
/// Parameters used to config prometheus. | ||
#[derive(Debug, Clone, Args)] | ||
pub struct PrometheusParams { | ||
/// Specify Prometheus exporter TCP Port. | ||
#[arg(long, value_name = "PORT")] | ||
pub prometheus_port: Option<u16>, | ||
/// Expose Prometheus exporter on all interfaces. | ||
/// | ||
/// Default is local. | ||
#[arg(long)] | ||
pub prometheus_external: bool, | ||
/// Do not expose a Prometheus exporter endpoint. | ||
/// | ||
/// Prometheus metric endpoint is enabled by default. | ||
#[arg(long)] | ||
pub no_prometheus: bool, | ||
} | ||
|
||
impl PrometheusParams { | ||
/// Creates [`PrometheusConfig`]. | ||
pub fn prometheus_config( | ||
&self, | ||
default_listen_port: u16, | ||
chain_id: String, | ||
) -> Option<PrometheusConfig> { | ||
if self.no_prometheus { | ||
None | ||
} else { | ||
let interface = | ||
if self.prometheus_external { Ipv4Addr::UNSPECIFIED } else { Ipv4Addr::LOCALHOST }; | ||
|
||
Some(PrometheusConfig::new_with_default_registry( | ||
SocketAddr::new( | ||
interface.into(), | ||
self.prometheus_port.unwrap_or(default_listen_port), | ||
), | ||
chain_id, | ||
)) | ||
} | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
// This file is part of Substrate. | ||
|
||
// 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 std::str::FromStr; | ||
|
||
/// Parameters used to config runtime. | ||
#[derive(Debug, Clone, Args)] | ||
pub struct RuntimeParams { | ||
/// The size of the instances cache for each runtime. The values higher than 256 are illegal. | ||
#[arg(long, default_value_t = 8, value_parser = parse_max_runtime_instances)] | ||
pub max_runtime_instances: usize, | ||
|
||
/// Maximum number of different runtimes that can be cached. | ||
#[arg(long, default_value_t = 2)] | ||
pub runtime_cache_size: u8, | ||
} | ||
|
||
fn parse_max_runtime_instances(s: &str) -> Result<usize, String> { | ||
let max_runtime_instances = usize::from_str(s) | ||
.map_err(|_err| format!("Illegal `--max-runtime-instances` value: {s}"))?; | ||
|
||
if max_runtime_instances > 256 { | ||
Err(format!("Illegal `--max-runtime-instances` value: {max_runtime_instances} is more than the allowed maximum of `256` ")) | ||
} else { | ||
Ok(max_runtime_instances) | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.