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/debugging.md
+9-8Lines changed: 9 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,21 +17,21 @@ The first approach is to use the `--dev-*` switches as defined in the [runner sw
17
17
Here you can turn on many switches that speed up a run. Please note that no useful measurement
18
18
will come out of the tool. These flags should only be used when debugging.
19
19
20
-
Especially the `--dev-flow-timetravel` is extremely useful as it will let you retry a step in
20
+
Especially the `--dev-flow-timetravel` is extremely useful as it will let you retry a step in
21
21
the *usage scenario* without having to go through all previous steps. It will also keep the container state so that if you can do live edits to the files in your local filesystem that are mounted then writeable into the container.
22
22
Please note that this only works with a local repository. If your repository is online only atm clone it first to your local filesystem. This allows for editing files while running a *usage scenario*
The second approach in debugging a *usage_scenario* is to
28
+
The second approach in debugging a *usage_scenario* is to
29
29
turn the `--debug` flag of the `runner.py` on.
30
30
31
-
When you call the `runner.py` locally it will turn into
31
+
When you call the `runner.py` locally it will turn into
32
32
a steppable mode where you continue to the next step by pressing enter.
33
33
34
-
You can then enter one of the containers to see if
34
+
You can then enter one of the containers to see if
35
35
the required services are running correctly.
36
36
37
37
An example call would be:
@@ -40,7 +40,7 @@ An example call would be:
40
40
docker exec -it MY_CONTAINER_NAME bash
41
41
```
42
42
43
-
Some container do not have `bash`. However `sh`, which has less capabilities,
43
+
Some container do not have `bash`. However `sh`, which has less capabilities,
44
44
should be available in most cases.
45
45
46
46
### --print-logs
@@ -61,16 +61,16 @@ on the flow commands to debug them.
61
61
62
62
## Debugging containers via HTTP / exposed ports
63
63
64
-
If entering the container looks fine and you need to access them through some of their
65
-
exposed ports (ex. via Browser through HTTP) turn on the `--allow-unsafe` flag to bind
64
+
If entering the container looks fine and you need to access them through some of their
65
+
exposed ports (ex. via Browser through HTTP) turn on the `--allow-unsafe` flag to bind
66
66
the ports specified in the `usage_scenario.yml`.
67
67
68
68
## Debugging metric providers
69
69
70
70
To see if the [Metric Providers →]({{< relref "/docs/measuring/metric-providers/metric-providers-overview" >}}) are working correctly you have two options:
71
71
72
72
- Start them manually from their respective folder under `/metric-providers/...` and look if the output is as expected
73
-
-Turn on the `--no-file-cleanup` switch to see if the files generated in `/tmp/green-metrics-tool/[...].log`are in expected format
73
+
-Check the `/tmp/green-metrics-tool/[...].log`files, after a run to see if there is some data being reported
74
74
75
75
## Debugging flow commands not ending
76
76
@@ -80,3 +80,4 @@ Typically when a *flow command* does not end it is because the process is really
80
80
We recommend you check if the container ran into configured memory / cpu limits of the docker orchestrator. Either through linux system tools or through *docker stats* if you have system access.
81
81
82
82
If you are using the **GMT Cluster / SaaS** you can let the process run into the maximum time limit to see the metrics timelines to understand memory and CPU usage and possible limits hit.
Copy file name to clipboardExpand all lines: content/en/docs/measuring/runner-switches.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,7 +21,7 @@ Apart from the `config.yml` some additional configuration is possible when manua
21
21
-`--user-id` Execute run as a specific user (Default: 1) - See also [User Management →]({{< relref "/docs/cluster/user-management.md" >}})
22
22
-`--config-override` Override the configuration file with the passed in yml file.
23
23
+ Must be located in the same directory as the regular configuration file. Pass in only the name.
24
-
-`--file-cleanup` flag to delete the metric provider data in `/tmp/green-metrics-tool`
24
+
-`--file-cleanup` flag to delete the metric provider data in `/tmp/green-metrics-tool`. Normally this folder is only purged on a new run start and files are left in `/tmp/green-metrics-tool`.
25
25
-`--debug` flag to activate steppable debug mode
26
26
+ This allows you to enter the containers and debug them if necessary.
27
27
-`--allow-unsafe` flag to activate unsafe volume bindings, ports, and complex env vars
0 commit comments