Skip to content

Commit

Permalink
Cosmetic and English fixes to README.md
Browse files Browse the repository at this point in the history
* Missing indent
* Consistency between titles
* Some small English tweaks
  • Loading branch information
gray-matter authored May 15, 2024
1 parent dc50acf commit 929f09c
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@
### Scripted language
hwbench embeds a very simplified script language, greatly inspired by [fio](https://github.com/axboe/fio), that turns a very simple script file into a large list of individual tests.

### Preparing the server before the benchmark
### Prepares the server before the benchmark
Some tuning can be performed automatically to ensure constant system settings across time and reboots. It avoids many human mistakes.

### Collect server's context
### Collects server's context
At startup, hwbench will collect as much as possible server's context like:
- BIOS configuration
- server properties (via DMI)
Expand All @@ -23,27 +23,27 @@ This context will be attached to the performance metrics for later analysis.
### Can run any type of benchmark
hwbench is using *engines* to define how to execute a particular external application.
The current version of hwbench supports 3 different engines.
[stress-ng](https://github.com/ColinIanKing/stress-ng): no need to present this very popular low-level benchmarking tool
- spike: a custom engine used to make fans spiking. Very useful to study the cooling strategy of a server.
- [stress-ng](https://github.com/ColinIanKing/stress-ng): no need to present this very popular low-level benchmarking tool
- spike: a custom engine used to make fans spike. Very useful to study the cooling strategy of a server.
- sleep: a stupid sleep call used to observe how the system is behaving in idle mode

Benchmark performance metrics are extracted and saved for later analysis.

### Collect server's environment
### Collects server's environment
If the server is equipped with a [BMC](https://en.wikipedia.org/wiki/Intelligent_Platform_Management_Interface#Baseboard_management_controller), hwbench will collect environmental metrics and associate them with the final results for later analysis.

This release supports Dell and HPE servers and collects:
- Thermal sensors
- Fans speed
- Power consumption metrics

This feature uses [redfish](https://www.dmtf.org/standards/redfish) protocol with both generic and OEM-specific endpoints.
This feature uses [Redfish](https://www.dmtf.org/standards/redfish) protocol with both generic and OEM-specific endpoints.

For more details and usage, see the specific documentation.

# How can results be analyzed?
**hwgraph** tool, bundled in the same repository, generates graphs from **hwbench** output files.
If a single output file is provided, **hwgraph** plot for each benchmark :
If a single output file is provided, **hwgraph** plots for each benchmark :
- performance metrics
- performance metrics per watt
- environmental metrics along the run:
Expand All @@ -52,6 +52,6 @@ If a single output file is provided, **hwgraph** plot for each benchmark :
- power consumption
- CPU frequency

If multiple output files are passed in argument, and only if they were generated with the same script file, **hwgraph** will compare for each benchmark the performance metrics.
If multiple output files are passed as arguments, and only if they were generated with the same script file, **hwgraph** will compare for each benchmark the performance metrics.

For more details, see the specific documentation.
For more details, see the specific documentation.

0 comments on commit 929f09c

Please sign in to comment.