Add flow transactions profile docs
#1645
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
There was a problem hiding this comment.
Pull request overview
This PR adds documentation for the new flow transactions profile command, which enables developers to profile computational performance of sealed transactions on any Flow network.
Changes:
- Add comprehensive documentation page for the
flow transactions profilecommand - Update CLI index to mention transaction profiling capabilities
- Add examples and reference to transaction profiling in commands documentation
- Integrate transaction profiling into the Cadence computation profiling guide
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| docs/build/tools/flow-cli/transactions/profile-transactions.md | New comprehensive documentation page covering usage, analysis methods, requirements, and implementation details for transaction profiling |
| docs/build/tools/flow-cli/index.md | Added transaction profiling to the list of CLI capabilities |
| docs/build/tools/flow-cli/commands.md | Added transaction profiling examples and documentation link to the commands reference |
| docs/build/cadence/advanced-concepts/computation-profiling.md | Updated computation profiling guide to include transaction profiling as one of three complementary approaches |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ### Output Format | ||
|
|
||
| - Flag: `--output` | ||
| - Short Flag: `-o` | ||
| - Valid inputs: `json`, `inline` | ||
|
|
||
| Specify the format of the command results displayed in the console. | ||
|
|
There was a problem hiding this comment.
The --output flag is documented twice with conflicting descriptions. Lines 155-160 describe it as setting the profile output file path with default profile-{tx_id_prefix}.pb.gz, while lines 187-191 describe it as setting the output format (json, inline). The second definition appears to be incorrect for this command and should be removed or corrected.
| ### Output Format | |
| - Flag: `--output` | |
| - Short Flag: `-o` | |
| - Valid inputs: `json`, `inline` | |
| Specify the format of the command results displayed in the console. |
|
|
||
| The Flow CLI provides a command to profile the computational performance of sealed transactions on any Flow network. This diagnostic tool generates detailed CPU profiles in the industry-standard `pprof` format, allowing you to analyze exactly where computation is being spent during transaction execution. | ||
|
|
||
| The command works by forking the blockchain state and replaying the transaction in an isolated environment, ensuring accurate profiling results that match the original execution. |
There was a problem hiding this comment.
Can you link to forking here or put an info bubble like "To read more about forking..."
Closes #1649
Related: onflow/flow-cli#2254