Skip to content

Commit ea49c0f

Browse files
committed
Updates the params
1 parent 585b69f commit ea49c0f

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

content/en/docs/measuring/runner-switches.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,17 +8,19 @@ weight: 830
88

99
Apart from the `config.yml` some additional configuration is possible when manually running with the `runner.py`.
1010

11+
- `--name` A name which will be stored to the database to discern this run from others
1112
- `--uri` The URI to get the usage_scenario.yml from.
1213
+ If given a URL starting with `http(s)` the tool will try to clone a remote repository to `/tmp/green-metrics-tool/repo`
1314
+ If given a local directory starting with `/`, this will be used instead.
1415
- `--branch` When providing a git repository, optionally specify a branch
15-
- `--name` A name which will be stored to the database to discern this run from others
1616
- `--filename` An optional alternative filename if you do not want to use "usage_scenario.yml"
1717
- `--variables` A list of string key-value pairs with variables to be replaced in the [usage_scenario.yml →]({{< relref "usage-scenario" >}})
1818
+ e.g.: `--variables '__GMT_VAR_MY_VALUE_=cats are cool'`
19+
- `--commit-hash-folder` Use a different folder than the repository root to determine the commit hash for the run
20+
- `--user-id` Execute run as a specific user (Default: 1) - See also [User Management →]({{< relref "/docs/cluster/user-management.md" >}})
1921
- `--config-override` Override the configuration file with the passed in yml file.
2022
+ Must be located in the same directory as the regular configuration file. Pass in only the name.
21-
- `--no-file-cleanup` flag to not delete the metric provider data in `/tmp/green-metrics-tool`
23+
- `--file-cleanup` flag to delete the metric provider data in `/tmp/green-metrics-tool`
2224
- `--debug` flag to activate steppable debug mode
2325
+ This allows you to enter the containers and debug them if necessary.
2426
- `--allow-unsafe` flag to activate unsafe volume bindings, ports, and complex env vars
@@ -30,21 +32,22 @@ Apart from the `config.yml` some additional configuration is possible when manua
3032
- `--skip-unsafe` flag to skip unsafe volume bindings, ports and complex env vars
3133
+ This is typically done when reusing already present `compose.yml` files without the need to alter the file
3234
- `--skip-system-checks` Skip checking the system if the GMT can run
33-
- `--skip-volume-inspect` flag to skip disable docker volume inspection. Can help if you encounter permission issues, since GMT runs as non root but for some docker configurations volume dir are only readable by root user.
3435
- `--verbose-provider-boot` flag to boot metric providers gradually
3536
+ This will enable the user to see the impact of each metric provider more clearly in the metric timelines
3637
+ There will be a 10 second sleep after each provider boot
3738
+ `RAPL` metric providers will be prioritized to start first, if enabled
38-
- `--user-id` Execute run as a specific user (Default: 1) - See also [User Management →]({{< relref "/docs/cluster/user-management.md" >}})
3939
- `--full-docker-prune` Stop and remove all containers, build caches, volumes and images on the system
4040
- `--docker-prune` Prune all unassociated build caches, networks volumes and stopped containers on the system
41+
- `--skip-volume-inspect` Disable docker volume inspection. Can help if you encounter permission issues.
42+
- `--dev-flow-timetravel` Allows to repeat a failed flow or timetravel to beginning of flows or restart services
43+
4144
- `--dev-no-metrics` Skips loading the metric providers. Runs will be faster, but you will have no metric
4245
- `--dev-no-sleeps` Removes all sleeps. Resulting measurement data will be skewed.
46+
- `--dev-no-phase-stats` Do not calculate phase stats.
4347
- `--dev-cache-build` Checks if a container image is already in the local cache and will then not build it. Also doesn't clear the images after a run. Please note that skipping builds only works the second time you make a run since the image has to be built at least initially to work.
44-
- `--dev-flow-timetravel` Allows to repeat a failed flow or timetravel to beginning of flows or restart services
4548
- `--dev-no-optimizations` Disables the creation of potential optimization recommendations based on the measurement run.
46-
- `--print-logs` Prints the container and process logs to stdout
4749
- `--print-phase-stats PHASE_NAME` Prints the stats of the given phase to the CLI. Typical argument would be "\[RUNTIME\]" to see all runtime phases combined
50+
- `--print-logs` Prints the container and process logs to stdout
4851

4952
These options are not available when doing cron runs.
5053

0 commit comments

Comments
 (0)