[doc, Q1'25-CQH] synthetic benchmarks documentation updates #12814
Conversation
Clarifies usage and some gotchas I encountered while getting acquainted with the tool.
| @@ -38,6 +38,18 @@ Before an RPC request is sent, the tooling awaits capacity on a buffered channel | |||
|
|
|||
| The tooling's [`justfile`](../../../benchmarks/synth-bm/justfile) contains recipes for the most relevant workflows. | |||
|
|
|||
| A typical workflow benchmarking the native token transfers using the above `justfile` would be something along the: | |||
There was a problem hiding this comment.
As this is specific to the native transfer benchmark, it might go into the subsection ### Benchmark native token transfers.
There was a problem hiding this comment.
Moved it to the ### Benchmark native token transfers subsection and reshuffled things around to keep these reasonably close to the top of the file. PTAL
Co-authored-by: Moritz Zielke <[email protected]>
Co-authored-by: Moritz Zielke <[email protected]>
|
For markdown the cspell syntax is: |
Makes sense. Removed. |
Done. |
|
Looks like the section on enabling memtrie was removed. Usually we want to enable memtrie for all benchmark runs, even when using the default config. So mentioning it only in the "Un-limiting config" section is not sufficient. Please add back "Enable memtrie", then it should be good to go. |
Done! |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #12814 +/- ##
==========================================
+ Coverage 70.41% 70.44% +0.02%
==========================================
Files 848 848
Lines 174849 174849
Branches 174849 174849
==========================================
+ Hits 123117 123166 +49
+ Misses 46485 46428 -57
- Partials 5247 5255 +8
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
Clarifies usage and some gotchas I encountered while getting acquainted with the tool.