Skip to content

Commit f4a9594

Browse files
authored
Update apply-load docs (#4594)
# Description Apply load docs are out of date <!--- Describe what this pull request does, which issue it's resolving (usually applicable for code changes). ---> # Checklist - [ ] Reviewed the [contributing](https://github.com/stellar/stellar-core/blob/master/CONTRIBUTING.md#submitting-changes) document - [ ] Rebased on top of master (no merge commits) - [ ] Ran `clang-format` v8.0.0 (via `make format` or the Visual Studio extension) - [ ] Compiles - [ ] Ran all tests - [ ] If change impacts performance, include supporting evidence per the [performance document](https://github.com/stellar/stellar-core/blob/master/performance-eval/performance-eval.md)
2 parents 4729b41 + 99865fd commit f4a9594

File tree

1 file changed

+6
-9
lines changed

1 file changed

+6
-9
lines changed

docs/software/commands.md

+6-9
Original file line numberDiff line numberDiff line change
@@ -20,20 +20,17 @@ Common options can be placed at any place in the command line.
2020
Command options can only by placed after command.
2121

2222
* **apply-load**: Applies Soroban transactions by repeatedly generating transactions and closing
23-
them directly through the LedgerManager. The parameters specified below configure the network limits, and
24-
they're all required - **--ledger-max-instructions N**, **--ledger-max-read-entries N**, **--ledger-max-write-entries N**, **--ledger-max-read-byte N**, **--ledger-max-write-bytes N**, **--ledger-max-tx-size N**, **--ledger-max-tx-count N**. This command will generate enough transactions to fill up a synthetic transaction queue (it's just a list of transactions with the same limits as the real queue), and then create a transaction set off of that to
23+
them directly through the LedgerManager. This command will generate enough transactions to fill up a synthetic transaction queue (it's just a list of transactions with the same limits as the real queue), and then create a transaction set off of that to
2524
apply.
2625

2726
* At the moment, the Soroban transactions are generated using some of the same config parameters as the **generateload** command. Specifically,
2827
`ARTIFICIALLY_GENERATE_LOAD_FOR_TESTING=true`,
29-
`LOADGEN_NUM_DATA_ENTRIES_FOR_TESTING`,
30-
`LOADGEN_NUM_DATA_ENTRIES_DISTRIBUTION_FOR_TESTING`,
31-
`LOADGEN_IO_KILOBYTES_FOR_TESTING`,
32-
`LOADGEN_IO_KILOBYTES_DISTRIBUTION_FOR_TESTING`,
33-
`LOADGEN_TX_SIZE_BYTES_FOR_TESTING`,
34-
`LOADGEN_TX_SIZE_BYTES_DISTRIBUTION_FOR_TESTING`,
3528
`LOADGEN_INSTRUCTIONS_FOR_TESTING`, and
36-
`LOADGEN_INSTRUCTIONS_DISTRIBUTION_FOR_TESTING`.
29+
`LOADGEN_INSTRUCTIONS_DISTRIBUTION_FOR_TESTING`. In addition to those, you must also set the
30+
limit related settings - `APPLY_LOAD_LEDGER_MAX_INSTRUCTIONS`, `APPLY_LOAD_TX_MAX_INSTRUCTIONS`, `APPLY_LOAD_LEDGER_MAX_READ_LEDGER_ENTRIES`, `APPLY_LOAD_TX_MAX_READ_LEDGER_ENTRIES`, `APPLY_LOAD_LEDGER_MAX_WRITE_LEDGER_ENTRIES`, `APPLY_LOAD_TX_MAX_WRITE_LEDGER_ENTRIES`, `APPLY_LOAD_LEDGER_MAX_READ_BYTES`, `APPLY_LOAD_TX_MAX_READ_BYTES`, `APPLY_LOAD_LEDGER_MAX_WRITE_BYTES`, `APPLY_LOAD_TX_MAX_WRITE_BYTES`, `APPLY_LOAD_MAX_TX_SIZE_BYTES`, `APPLY_LOAD_MAX_LEDGER_TX_SIZE_BYTES`, `APPLY_LOAD_MAX_CONTRACT_EVENT_SIZE_BYTES`, `APPLY_LOAD_MAX_TX_COUNT`.
31+
* `apply-load` will also generate a synthetic bucket list using `APPLY_LOAD_BL_SIMULATED_LEDGERS`, `APPLY_LOAD_BL_WRITE_FREQUENCY`, `APPLY_LOAD_BL_BATCH_SIZE`, `APPLY_LOAD_BL_LAST_BATCH_LEDGERS`, `APPLY_LOAD_BL_LAST_BATCH_SIZE`. These have default values set in `Config.h`.
32+
* There are additional `APPLY_LOAD_*` related config settings that can be used to configure
33+
`apply-load`, and you can learn more about these from the comments in `Config.h`.
3734

3835
* **catchup <DESTINATION-LEDGER/LEDGER-COUNT>**: Perform catchup from history
3936
archives without connecting to network. For new instances (with empty history

0 commit comments

Comments
 (0)