Skip to content

Commit 786adf5

Browse files
ribalbaArneTR
andauthored
Fixes the new file-cleanup (#70)
Co-authored-by: Arne Tarara <arne@datafuse.de>
1 parent f4cd2a1 commit 786adf5

File tree

2 files changed

+10
-9
lines changed

2 files changed

+10
-9
lines changed

content/en/docs/measuring/debugging.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -17,21 +17,21 @@ The first approach is to use the `--dev-*` switches as defined in the [runner sw
1717
Here you can turn on many switches that speed up a run. Please note that no useful measurement
1818
will come out of the tool. These flags should only be used when debugging.
1919

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
2121
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.
2222
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*
2323

2424
A typical call looks like this:
2525
`python3 --uri MY_LOCAL_PATH --name Testing --allow-unsafe --dev-no-metrics --dev-no-sleeps --dev-cache-build --dev-flow-timetravel`
2626

2727
### --debug flag
28-
The second approach in debugging a *usage_scenario* is to
28+
The second approach in debugging a *usage_scenario* is to
2929
turn the `--debug` flag of the `runner.py` on.
3030

31-
When you call the `runner.py` locally it will turn into
31+
When you call the `runner.py` locally it will turn into
3232
a steppable mode where you continue to the next step by pressing enter.
3333

34-
You can then enter one of the containers to see if
34+
You can then enter one of the containers to see if
3535
the required services are running correctly.
3636

3737
An example call would be:
@@ -40,7 +40,7 @@ An example call would be:
4040
docker exec -it MY_CONTAINER_NAME bash
4141
```
4242

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,
4444
should be available in most cases.
4545

4646
### --print-logs
@@ -61,16 +61,16 @@ on the flow commands to debug them.
6161

6262
## Debugging containers via HTTP / exposed ports
6363

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
6666
the ports specified in the `usage_scenario.yml`.
6767

6868
## Debugging metric providers
6969

7070
To see if the [Metric Providers →]({{< relref "/docs/measuring/metric-providers/metric-providers-overview" >}}) are working correctly you have two options:
7171

7272
- 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
7474

7575
## Debugging flow commands not ending
7676

@@ -80,3 +80,4 @@ Typically when a *flow command* does not end it is because the process is really
8080
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.
8181

8282
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.
83+
>>>>>>> main

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Apart from the `config.yml` some additional configuration is possible when manua
2121
- `--user-id` Execute run as a specific user (Default: 1) - See also [User Management →]({{< relref "/docs/cluster/user-management.md" >}})
2222
- `--config-override` Override the configuration file with the passed in yml file.
2323
+ 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`.
2525
- `--debug` flag to activate steppable debug mode
2626
+ This allows you to enter the containers and debug them if necessary.
2727
- `--allow-unsafe` flag to activate unsafe volume bindings, ports, and complex env vars

0 commit comments

Comments
 (0)