Skip to content

Commit dda8d19

Browse files
[docs/mock_uss] Improve tracer documentation (#1266)
1 parent 397f2e9 commit dda8d19

File tree

1 file changed

+22
-1
lines changed

1 file changed

+22
-1
lines changed

monitoring/mock_uss/tracer/README.md

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,13 +38,34 @@ container in order to use the tracer subscribe capability.
3838
Visit /tracer/logs to see a list of log entries recorded by tracer while the
3939
current session has been running.
4040

41+
## Log download
42+
To download the full set of current tracer logs, visit /tracer/logs.zip
43+
4144
## Invocation
4245
An instance of tracer-enabled mock_uss is brought up as part of the [local deployment](../README.md#local-deployment). It can also be deployed [with Google Cloud Platform](../deployment/gcp) when configured appropriately.
4346

44-
## Offline historical KML generator
47+
## Offline historical KML generation
4548

4649
With a large number of log files, KML generation via the server endpoint can
4750
require a prohibitive amount of time. To generate a historical KML in these
4851
cases, the [make_historical_kml utility](./make_historical_kml.py) can be used
4952
to parse a folder of logs (generally acquired from downloading a .zip file of
5053
logs while the server is active) into a KML file.
54+
55+
To use this utility via docker, first set `LOG_PATH` to the folder containing the unzipped log files:
56+
57+
```shell
58+
export LOG_PATH=/path/to/log/files
59+
```
60+
61+
Then, invoke the tool, writing to `historical.kml` in the log file folder:
62+
63+
```shell
64+
docker container run \
65+
-u "$(id -u):$(id -g)" \
66+
-v "$LOG_PATH:/logs" \
67+
interuss/monitoring \
68+
uv run /app/monitoring/mock_uss/tracer/make_historical_kml.py \
69+
--logfolder /logs \
70+
--kmlfile /logs/historical.kml
71+
```

0 commit comments

Comments
 (0)