Skip to content

Commit b9c1c29

Browse files
DCPerf:Adding instructions in README for how to use jit size monitoring scripts (#311)
Summary: Pull Request resolved: #311 Adds README documentation for JIT monitoring and TC dump options in MediaWiki benchmark. Instructs users to use --dry-run to get the base command, then lists available monitoring options with their defaults, expected output files, and usage notes. Reviewed By: charles-typ Differential Revision: D87393672 fbshipit-source-id: 23e9140d4d2500e174a5370655242594c32d3f86
1 parent d5eb954 commit b9c1c29

File tree

1 file changed

+42
-0
lines changed

1 file changed

+42
-0
lines changed

packages/mediawiki/README.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -133,6 +133,48 @@ you can run the following:
133133
./benchpress_cli.py run oss_performance_mediawiki_mlp -i '{"scale_out": 3}'
134134
```
135135

136+
### JIT Monitoring and Translation Cache Dumping
137+
138+
The MediaWiki benchmark supports real-time JIT size monitoring and Translation Cache (TC) dumping for performance analysis. These features can be enabled through the `run.sh` script options.
139+
140+
#### Getting the Command
141+
142+
To see the full `run.sh` command with all available options, use the `--dry-run` flag with benchpress:
143+
144+
```bash
145+
./benchpress_cli.py run oss_performance_mediawiki_mlp --dry-run
146+
```
147+
148+
This will display the complete command that benchpress would execute. You can then copy this command and append the JIT monitoring options described below.
149+
150+
#### Available JIT Monitoring Options
151+
152+
The following options can be added to the `run.sh` command:
153+
154+
- `-j`: Enable JIT size monitoring with `dump_jit_size.py`
155+
- `-J <port>`: Specify JIT monitoring port (default: `localhost:9092`)
156+
- `-I <seconds>`: Set JIT monitoring interval in seconds (default: `1`)
157+
- `-O <directory>`: Specify output directory for JIT monitoring files (default: `/tmp/jit_study_output`)
158+
- `-D`: Enable TC dump with `vm-dump-tc`
159+
- `-C <seconds>`: Set TC dump interval in seconds (default: `600`)
160+
161+
#### Output Files
162+
163+
When JIT monitoring is enabled, the following files will be generated in the output directory:
164+
165+
- `jit_monitor_<timestamp>.txt`: Human-readable text log with JIT size measurements
166+
- `jit_monitor_<timestamp>.csv`: CSV file containing timestamp, elapsed time, and JIT size in bytes
167+
- `tc_dumps_<timestamp>/`: Directory containing TC dump files (when `-D` is enabled)
168+
- `tc_dump_*`: Translation cache dump files
169+
- `tc_data.txt.gz`: Compressed TC data file
170+
171+
#### Notes
172+
173+
- JIT monitoring runs in the background and automatically stops when the benchmark completes
174+
- The monitoring script requires `curl` to be installed on the system
175+
- TC dumps can be large, so ensure sufficient disk space is available when using the `-D` option
176+
- The default monitoring interval of 1 second provides granular data but may generate large CSV files for long-running benchmarks
177+
136178
### Running Mediawiki mini
137179

138180
Mediawiki mini is a shrunken version of Mediawiki

0 commit comments

Comments
 (0)