You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/en/docs/measuring/runner-switches.md
+9-6Lines changed: 9 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -8,17 +8,19 @@ weight: 830
8
8
9
9
Apart from the `config.yml` some additional configuration is possible when manually running with the `runner.py`.
10
10
11
+
-`--name` A name which will be stored to the database to discern this run from others
11
12
-`--uri` The URI to get the usage_scenario.yml from.
12
13
+ If given a URL starting with `http(s)` the tool will try to clone a remote repository to `/tmp/green-metrics-tool/repo`
13
14
+ If given a local directory starting with `/`, this will be used instead.
14
15
-`--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
16
16
-`--filename` An optional alternative filename if you do not want to use "usage_scenario.yml"
17
17
-`--variables` A list of string key-value pairs with variables to be replaced in the [usage_scenario.yml →]({{< relref "usage-scenario" >}})
18
18
+ 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" >}})
19
21
-`--config-override` Override the configuration file with the passed in yml file.
20
22
+ 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`
22
24
-`--debug` flag to activate steppable debug mode
23
25
+ This allows you to enter the containers and debug them if necessary.
24
26
-`--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
30
32
-`--skip-unsafe` flag to skip unsafe volume bindings, ports and complex env vars
31
33
+ This is typically done when reusing already present `compose.yml` files without the need to alter the file
32
34
-`--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.
34
35
-`--verbose-provider-boot` flag to boot metric providers gradually
35
36
+ This will enable the user to see the impact of each metric provider more clearly in the metric timelines
36
37
+ There will be a 10 second sleep after each provider boot
37
38
+`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" >}})
39
39
-`--full-docker-prune` Stop and remove all containers, build caches, volumes and images on the system
40
40
-`--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
+
41
44
-`--dev-no-metrics` Skips loading the metric providers. Runs will be faster, but you will have no metric
42
45
-`--dev-no-sleeps` Removes all sleeps. Resulting measurement data will be skewed.
46
+
-`--dev-no-phase-stats` Do not calculate phase stats.
43
47
-`--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
45
48
-`--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
47
49
-`--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
48
51
49
52
These options are not available when doing cron runs.
0 commit comments