Skip to content

Commit

Permalink
drop the help output for the runner - it's too fast moving a target
Browse files Browse the repository at this point in the history
  • Loading branch information
Zeph Grunschlag committed Sep 6, 2023
1 parent f29b623 commit 316ff04
Showing 1 changed file with 2 additions and 20 deletions.
22 changes: 2 additions & 20 deletions tools/block-generator/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ final_overall_transactions_per_second:8493.40
final_uptime_seconds:3600.06
```

Here is the help output for **runner**:
We recommend printing out the help information for the **runner**:

```bash
~$ ./block-generator runner -h
Expand All @@ -154,25 +154,7 @@ Run an automated test suite using the block-generator daemon and a provided cond
Usage:
block-generator runner [flags]

Flags:
-i, --conduit-binary string Path to conduit binary.
-l, --conduit-log-level string LogLevel to use when starting Conduit. [panic, fatal, error, warn, info, debug, trace] (default "error")
--cpuprofile string Path where Conduit writes its CPU profile.
-f, --genesis-file string The file path to the genesis associated with the db snapshot.
-h, --help help for runner
-k, --keep-data-dir If set the validator will not delete the data directory after tests complete.
-p, --metrics-port uint Port to start the metrics server at. (default 9999)
-c, --postgres-connection-string string Postgres connection string.
-r, --report-directory string Location to place test reports. If --times is used, this is the prefix for multiple report directories.
--reset-db If set the database will be deleted before running tests.
--reset-report-dir If set any existing report directory will be deleted before running tests.
-s, --scenario string Directory containing scenarios, or specific scenario file.
--start-delay duration Duration to wait before starting a test scenario. This may be useful for snapshot tests where DB maintenance occurs after loading data.
--template string Specify the conduit template to use. Choices are: file-exporter or postgres-exporter. (default "postgres-exporter")
-d, --test-duration duration Duration to use for each scenario. (default 5m0s)
-t, --times uint The number of times to run the scenario(s). (default 1)
--validate If set the validator will run after test-duration has elapsed to verify data is correct. An extra line in each report indicates validator success or failure.
-v, --verbose If set the runner will print debugging information from the generator and ledger.
... etc ...
```

## Example Runs using Conduit
Expand Down

0 comments on commit 316ff04

Please sign in to comment.