sol_log_bench

Turns

    "Program Fg6PaFpoGXkYsidMpWTK6W2BeZ7FEfcYkg476zPFsLnS invoke [1]",
    "Program log: Instruction: Benchmark",
    "Program log: Bench: Wrapper Bench",
    "Program consumption: 198860 units remaining",
    "Program log: Bench: FindProgramAddress",
    "Program consumption: 198831 units remaining",
    "Program consumption: 194243 units remaining",
    "Program log: Bench: PubkeyFromString",
    "Program consumption: 194216 units remaining",
    "Program log: Pubkey: C8mgrCncLMtpfh4QzkJsPfrWd384yQeSYpdujw4LF53T",
    "Program consumption: 174269 units remaining",
    "Program log: Log something else",
    "Program consumption: 174247 units remaining",
    "Program Fg6PaFpoGXkYsidMpWTK6W2BeZ7FEfcYkg476zPFsLnS consumed 25938 of 200000 compute units",
    "Program Fg6PaFpoGXkYsidMpWTK6W2BeZ7FEfcYkg476zPFsLnS success"

into:

Usage

On the rust/Solana side of things

  // label the benchmark and wrap the code you want to benchmark in `sol_log_compute_units`
  msg!("Bench: FindProgramAddress");
  solana_program::log::sol_log_compute_units(); // Begin findProgramAddressBench

  // The code we want to benchmark
  solana_program::pubkey::Pubkey::find_program_address(&[b"foo"], &ctx.accounts.signer.key());

  solana_program::log::sol_log_compute_units(); // End findProgramAddressBench

On the test side of things:

  import { parseAndPrintLogs } from 'sol_log_bench';

  ...

  await provider.connection.confirmTransaction(txId);
  let tx = await provider.connection.getTransaction(txId, { commitment: 'confirmed' });

  return parseAndPrintLogs(tx.meta.logMessages);

Installation

yarn add https://github.com/schwarzbi3r/sol_log_bench#v1.0.0

Typedoc

You can find the Typedoc's at https://schwarzbi3r.github.io/sol_log_bench

More Examples

    pub fn simple_benchmark(_ctx: Context<EmptyBenchmark>) -> Result<()> {
        msg!("Bench: Pubkey macro");
        solana_program::log::sol_log_compute_units();
        let pubkey: Pubkey = pubkey!("C8mgrCncLMtpfh4QzkJsPfrWd384yQeSYpdujw4LF53T");
        solana_program::log::sol_log_compute_units();

        msg!("Bench: Pubkey to String");
        solana_program::log::sol_log_compute_units();
        msg!("Pubkey: {}", pubkey.to_string());
        solana_program::log::sol_log_compute_units();

        Ok(())
    }

    pub fn nested_benchmarks(ctx: Context<SingleAccountBenchmark>) -> Result<()> {
        msg!("Bench: EntireProgram");
        solana_program::log::sol_log_compute_units();

        msg!("Bench: FindProgramAddress");
        solana_program::log::sol_log_compute_units(); // Begin findProgramAddressBench
        solana_program::pubkey::Pubkey::find_program_address(&[b"foo"],&ctx.accounts.signer.key());
        solana_program::log::sol_log_compute_units(); // End findProgramAddressBench

        msg!("Bench: PubkeyFromString");
        solana_program::log::sol_log_compute_units(); // Begin pubkeyFromString
        let pubkey = Pubkey::from_str(PUBKEY_STR).unwrap();
        solana_program::log::sol_log_compute_units(); // End pubkeyFromString
        msg!("Pubkey: {}", pubkey.to_string());

        msg!("Log something else");

        solana_program::log::sol_log_compute_units();
        Ok(())
    }

Which will show up in your tests as:

and