Skip to content

Snoop: add benchmark filenames when displaying info about benchmark in the CLI

Context

Currently when viewing info on a benchmark we need to grep codebase manually to find a file where it is defined, with the current change benchmark filename will be available on the cli to view. e.g

./octez-snoop display info for benchmark builtin/TIMER_LATENCY  

Name:
    builtin/TIMER_LATENCY
Filename:
    src/lib_benchmark/builtin_benchmarks.ml
Info:
    Measuring timer latency
Tags:
    misc; builtin
Models:
    *:
        Aggregated model containing the following abstract models:
            zero
            builtin/timer_model
./octez-snoop display info for benchmark bloomer/bloomer_add

Name:
    bloomer/bloomer_add
Filename:
    src/lib_shell_benchmarks/bloomer_benchmarks.ml
Info:
    Benchmarking Bloomer.add
Tags:
    shell; misc
Models:
    bloomer:
        Aggregated model containing the following abstract models:
            bloomer/bloomer_add
            builtin/timer_model

./octez-snoop display info for benchmark interpreter/N_ISha3

Name:
    interpreter/N_ISha3
Filename:
    src/proto_alpha/lib_benchmarks_proto/interpreter_benchmarks.ml
Info:
    Benchmark N_ISha3
Tags:
    alpha; interpreter
Models:
    interpreter:
        Aggregated model containing the following abstract models:
            interpreter/N_ISha3
            builtin/timer_model

Manually testing the MR

Checklist

  • Document the interface of any function added or modified (see the coding guidelines)
  • Document any change to the user interface, including configuration parameters (see node configuration)
  • Provide automatic testing (see the testing guide).
  • For new features and bug fixes, add an item in the appropriate changelog (docs/protocols/alpha.rst for the protocol and the environment, CHANGES.rst at the root of the repository for everything else).
  • Select suitable reviewers using the Reviewers field below.
  • Select as Assignee the next person who should take action on that MR
Edited by Pavlo Khrystenko

Merge request reports