Struct frame_benchmarking_cli::MachineCmd

pub struct MachineCmd {
    pub shared_params: SharedParams,
    pub allow_fail: bool,
    pub tolerance: f64,
    pub verify_duration: f32,
    pub hash_duration: f32,
    pub memory_duration: f32,
    pub disk_duration: f32,
}

Command to benchmark the hardware.

Runs multiple benchmarks and prints their output to console. Can be used to gauge if the hardware is fast enough to keep up with a chain’s requirements. This command must be integrated by the client since the client can set compiler flags which influence the results.

You can use the --base-path flag to set a location for the disk benchmarks.

Fields

shared_params: SharedParams

allow_fail: bool

Do not return an error if any check fails.

Should only be used for debugging.

tolerance: f64

Set a fault tolerance for passing a requirement.

10% means that the test would pass even when only 90% score was archived. Can be used to mitigate outliers of the benchmarks.

verify_duration: f32

Time limit for the verification benchmark.

hash_duration: f32

Time limit for the hash function benchmark.

memory_duration: f32

Time limit for the memory benchmark.

disk_duration: f32

Time limit for each disk benchmark.

Implementations

impl MachineCmd

pub fn run(&self, cfg: &Configuration, requirements: Requirements) -> Result<()>

Execute the benchmark and print the results.

Trait Implementations

impl Args for MachineCmd

fn group_id() -> Option<Id>

Report the [ArgGroup::id][crate::ArgGroup::id] for this set of arguments

fn augment_args<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate Self.

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to [Command] so it can update self.

impl CliConfiguration for MachineCmd

fn shared_params(&self) -> &SharedParams

Get the SharedParams for this object

fn import_params(&self) -> Option<&ImportParams>

Get the ImportParams for this object

fn pruning_params(&self) -> Option<&PruningParams>

Get the PruningParams for this object

fn keystore_params(&self) -> Option<&KeystoreParams>

Get the KeystoreParams for this object

fn network_params(&self) -> Option<&NetworkParams>

Get the NetworkParams for this object

fn offchain_worker_params(&self) -> Option<&OffchainWorkerParams>

Get a reference to OffchainWorkerParams for this object.

fn node_key_params(&self) -> Option<&NodeKeyParams>

Get the NodeKeyParams for this object

fn database_params(&self) -> Option<&DatabaseParams>

Get the DatabaseParams for this object

fn base_path(&self) -> Result<Option<BasePath>, Error>

Get the base path of the configuration (if any)

fn is_dev(&self) -> Result<bool, Error>

Returns true if the node is for development or not

fn role(&self, _is_dev: bool) -> Result<Role, Error>

Gets the role

fn transaction_pool(&self, _is_dev: bool) -> Result<Options, Error>

Get the transaction pool options

fn network_config( &self, chain_spec: &Box<dyn ChainSpec>, is_dev: bool, is_validator: bool, net_config_dir: PathBuf, client_id: &str, node_name: &str, node_key: NodeKeyConfig, default_listen_port: u16 ) -> Result<NetworkConfiguration, Error>

Get the network configuration

fn keystore_config(&self, config_dir: &PathBuf) -> Result<KeystoreConfig, Error>

Get the keystore configuration.

fn database_cache_size(&self) -> Result<Option<usize>, Error>

Get the database cache size.

fn database(&self) -> Result<Option<Database>, Error>

Get the database backend variant.

fn database_config( &self, base_path: &PathBuf, cache_size: usize, database: Database ) -> Result<DatabaseSource, Error>

Get the database configuration object for the parameters provided

fn trie_cache_maximum_size(&self) -> Result<Option<usize>, Error>

Get the trie cache maximum size.

fn state_pruning(&self) -> Result<Option<PruningMode>, Error>

Get the state pruning mode.

fn blocks_pruning(&self) -> Result<BlocksPruning, Error>

Get the block pruning mode.

fn chain_id(&self, is_dev: bool) -> Result<String, Error>

Get the chain ID (string).

fn node_name(&self) -> Result<String, Error>

Get the name of the node.

fn wasm_method(&self) -> Result<WasmExecutionMethod, Error>

Get the WASM execution method.

fn wasm_runtime_overrides(&self) -> Option<PathBuf>

Get the path where WASM overrides live.

fn rpc_addr( &self, _default_listen_port: u16 ) -> Result<Option<Vec<RpcEndpoint>>, Error>

Get the RPC address.

fn rpc_methods(&self) -> Result<RpcMethods, Error>

Returns the RPC method set to expose.

fn rpc_max_connections(&self) -> Result<u32, Error>

Get the maximum number of RPC server connections.

fn rpc_cors(&self, _is_dev: bool) -> Result<Option<Vec<String>>, Error>

Get the RPC cors (None if disabled)

fn rpc_max_request_size(&self) -> Result<u32, Error>

Get maximum RPC request payload size.

fn rpc_max_response_size(&self) -> Result<u32, Error>

Get maximum RPC response payload size.

fn rpc_max_subscriptions_per_connection(&self) -> Result<u32, Error>

Get maximum number of subscriptions per connection.

fn rpc_buffer_capacity_per_connection(&self) -> Result<u32, Error>

The number of messages the RPC server is allowed to keep in memory per connection.

fn rpc_batch_config(&self) -> Result<BatchRequestConfig, Error>

RPC server batch request configuration.

fn rpc_rate_limit(&self) -> Result<Option<NonZero<u32>>, Error>

RPC rate limit configuration.

fn rpc_rate_limit_whitelisted_ips(&self) -> Result<Vec<IpNetwork>, Error>

RPC rate limit whitelisted ip addresses.

fn rpc_rate_limit_trust_proxy_headers(&self) -> Result<bool, Error>

RPC rate limit trust proxy headers.

fn prometheus_config( &self, _default_listen_port: u16, _chain_spec: &Box<dyn ChainSpec> ) -> Result<Option<PrometheusConfig>, Error>

Get the prometheus configuration (None if disabled)

fn telemetry_endpoints( &self, chain_spec: &Box<dyn ChainSpec> ) -> Result<Option<TelemetryEndpoints>, Error>

Get the telemetry endpoints (if any)

fn default_heap_pages(&self) -> Result<Option<u64>, Error>

Get the default value for heap pages

fn offchain_worker(&self, role: &Role) -> Result<OffchainWorkerConfig, Error>

Returns an offchain worker config wrapped in Ok(_)

fn force_authoring(&self) -> Result<bool, Error>

Returns Ok(true) if authoring should be forced

fn disable_grandpa(&self) -> Result<bool, Error>

Returns Ok(true) if grandpa should be disabled

fn dev_key_seed(&self, _is_dev: bool) -> Result<Option<String>, Error>

Get the development key seed from the current object

fn tracing_targets(&self) -> Result<Option<String>, Error>

Get the tracing targets from the current object (if any)

fn tracing_receiver(&self) -> Result<TracingReceiver, Error>

Get the TracingReceiver value from the current object

fn node_key(&self, net_config_dir: &PathBuf) -> Result<NodeKeyConfig, Error>

Get the node key from the current object

fn max_runtime_instances(&self) -> Result<Option<usize>, Error>

Get maximum runtime instances

fn runtime_cache_size(&self) -> Result<u8, Error>

Get maximum different runtimes in cache

fn announce_block(&self) -> Result<bool, Error>

Activate or not the automatic announcing of blocks after import

fn create_configuration<C>( &self, cli: &C, tokio_handle: Handle ) -> Result<Configuration, Error>

where C: SubstrateCli,

Create a Configuration object from the current object

fn log_filters(&self) -> Result<String, Error>

Get the filters for the logging.

fn detailed_log_output(&self) -> Result<bool, Error>

Should the detailed log output be enabled.

fn enable_log_reloading(&self) -> Result<bool, Error>

Is log reloading enabled?

fn disable_log_color(&self) -> Result<bool, Error>

Should the log color output be disabled?

fn init<F>( &self, support_url: &String, impl_version: &String, logger_hook: F ) -> Result<(), Error>

where F: FnOnce(&mut LoggerBuilder),

Initialize substrate. This must be done only once per process.

impl CommandFactory for MachineCmd

fn command<'b>() -> Command

Build a [Command] that can instantiate Self.

fn command_for_update<'b>() -> Command

Build a [Command] that can update self.

impl Debug for MachineCmd

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl FromArgMatches for MachineCmd

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches ) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Parser for MachineCmd

fn parse() -> Self

Parse from std::env::args_os(), [exit][Error::exit] on error.

fn try_parse() -> Result<Self, Error>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Self

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, [exit][Error::exit] on error.

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I)

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, [exit][Error::exit] on error.

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.