frame-omni-bencher maintenance (paritytech#5466)

Changes:
- Set default level to `Info` again. Seems like a dependency update set
it to something higher.
- Fix docs to not use `--locked` since we rely on dependency bumps via
cargo.
- Add README with rust docs.
- Fix bug where the node ignored `--heap-pages` argument.

You can test the `--heap-pages` bug by running this command on master
and then on this branch. Note that it should fail because of the very
low heap pages arg:
`cargo run --release --bin polkadot --features=runtime-benchmarks --
benchmark pallet --chain=dev --steps=10 --repeat=30
--wasm-execution=compiled --heap-pages=8 --pallet=frame-system
--extrinsic="*"`

---------

Signed-off-by: Oliver Tale-Yazdi <[email protected]>
Co-authored-by: ggwpez <[email protected]>

prdoc/pr_5466.prdoc

@@ -0,0 +1,14 @@
+crates:
+- bump: patch
+  name: frame-omni-bencher
+- bump: patch
+  name: frame-benchmarking-cli
+doc:
+- audience: Runtime Dev
+  description: |
+    Changes:
+    - Set default level to `Info` again. Seems like a dependency update set it to something higher.
+    - Fix docs to not use `--locked` since we rely on dependency bumps via cargo.
+    - Add README with rust docs.
+    - Fix bug where the node ignored `--heap-pages` argument.
+title: frame-omni-bencher maintenance

substrate/utils/frame/benchmarking-cli/src/pallet/command.rs

@@ -243,7 +243,7 @@ impl PalletCmd {
 		let state = &state_without_tracking;
 		let runtime = self.runtime_blob(&state_without_tracking)?;
 		let runtime_code = runtime.code()?;
-		let alloc_strategy = Self::alloc_strategy(runtime_code.heap_pages);
+		let alloc_strategy = self.alloc_strategy(runtime_code.heap_pages);
 
 		let executor = WasmExecutor::<(
 			sp_io::SubstrateHostFunctions,
@@ -753,9 +753,9 @@ impl PalletCmd {
 	}
 
 	/// Allocation strategy for pallet benchmarking.
-	fn alloc_strategy(heap_pages: Option<u64>) -> HeapAllocStrategy {
-		heap_pages.map_or(DEFAULT_HEAP_ALLOC_STRATEGY, |p| HeapAllocStrategy::Static {
-			extra_pages: p as _,
+	fn alloc_strategy(&self, runtime_heap_pages: Option<u64>) -> HeapAllocStrategy {
+		self.heap_pages.or(runtime_heap_pages).map_or(DEFAULT_HEAP_ALLOC_STRATEGY, |p| {
+			HeapAllocStrategy::Static { extra_pages: p as _ }
 		})
 	}
 

substrate/utils/frame/omni-bencher/Cargo.toml

@@ -6,6 +6,7 @@ authors.workspace = true
 edition.workspace = true
 repository.workspace = true
 license.workspace = true
+readme = "README.md"
 
 [lints]
 workspace = true
@@ -17,5 +18,5 @@ frame-benchmarking-cli = { workspace = true }
 sc-cli = { workspace = true, default-features = true }
 sp-runtime = { workspace = true, default-features = true }
 sp-statement-store = { workspace = true, default-features = true }
-sp-tracing = { workspace = true }
+tracing-subscriber = { workspace = true }
 log = { workspace = true }

substrate/utils/frame/omni-bencher/README.md

@@ -0,0 +1,60 @@
+# Polkadot Omni Benchmarking CLI
+
+The Polkadot Omni benchmarker allows to benchmark the extrinsics of any Polkadot runtime. It is
+meant to replace the current manual integration of the `benchmark pallet` into every parachain node.
+This reduces duplicate code and makes maintenance for builders easier. The CLI is currently only
+able to benchmark extrinsics. In the future it is planned to extend this to some other areas.
+
+General FRAME runtimes could also be used with this benchmarker, as long as they don't utilize any
+host functions that are not part of the Polkadot host specification.
+
+## Installation
+
+Directly via crates.io:
+
+```sh
+cargo install frame-omni-bencher --profile=production
+```
+
+from GitHub:
+
+```sh
+cargo install --git https://github.com/paritytech/polkadot-sdk frame-omni-bencher --profile=production
+```
+
+or locally from the sources:
+
+```sh
+cargo install --path substrate/utils/frame/omni-bencher --profile=production
+```
+
+Check the installed version and print the docs:
+
+```sh
+frame-omni-bencher --help
+```
+
+## Usage
+
+First we need to ensure that there is a runtime available. As example we will build the Westend
+runtime:
+
+```sh
+cargo build -p westend-runtime --profile production --features runtime-benchmarks
+```
+
+Now as an example, we benchmark the `balances` pallet:
+
+```sh
+frame-omni-bencher v1 benchmark pallet \
+--runtime target/release/wbuild/westend-runtime/westend-runtime.compact.compressed.wasm \
+--pallet "pallet_balances" --extrinsic ""
+```
+
+The `--steps`, `--repeat`, `--heap-pages` and `--wasm-execution` arguments have sane defaults and do
+not need be passed explicitly anymore.
+
+## Backwards Compatibility
+
+The exposed pallet sub-command is identical as the node-integrated CLI. The only difference is that
+it needs to be prefixed with a `v1` to ensure drop-in compatibility.

substrate/utils/frame/omni-bencher/src/command.rs

@@ -36,13 +36,19 @@ use sp_runtime::traits::BlakeTwo256;
 /// Directly via crates.io:
 ///
 /// ```sh
-/// cargo install --locked frame-omni-bencher
+/// cargo install frame-omni-bencher --profile=production
 /// ```
 ///
-/// or when the sources are locally checked out:
+/// from GitHub:
 ///
 /// ```sh
-/// cargo install --locked --path substrate/utils/frame/omni-bencher --profile=production
+/// cargo install --git https://github.com/paritytech/polkadot-sdk frame-omni-bencher --profile=production
+/// ```
+///
+/// or locally from the sources:
+///
+/// ```sh
+/// cargo install --path substrate/utils/frame/omni-bencher --profile=production
 /// ```
 ///
 /// Check the installed version and print the docs:
@@ -60,7 +66,7 @@ use sp_runtime::traits::BlakeTwo256;
 /// cargo build -p westend-runtime --profile production --features runtime-benchmarks
 /// ```
 ///
-/// Now as example we benchmark `pallet_balances`:
+/// Now as an example, we benchmark the `balances` pallet:
 ///
 /// ```sh
 /// frame-omni-bencher v1 benchmark pallet \

substrate/utils/frame/omni-bencher/src/main.rs

@@ -19,10 +19,22 @@ mod command;
 
 use clap::Parser;
 use sc_cli::Result;
+use tracing_subscriber::EnvFilter;
 
 fn main() -> Result<()> {
-	sp_tracing::try_init_simple();
+	setup_logger();
+
 	log::warn!("The FRAME omni-bencher is not yet battle tested - double check the results.",);
 
 	command::Command::parse().run()
 }
+
+/// Setup logging with `info` as default level. Can be set via `RUST_LOG` env.
+fn setup_logger() {
+	let env_filter = EnvFilter::try_from_default_env().unwrap_or_else(|_| EnvFilter::new("info"));
+
+	tracing_subscriber::fmt()
+		.with_env_filter(env_filter)
+		.with_writer(std::io::stderr)
+		.init();
+}