Skip to content

Commit 672dc5d

Browse files
committed
Updated RAPL installation instructions
1 parent 1d6dffa commit 672dc5d

File tree

4 files changed

+16
-34
lines changed

4 files changed

+16
-34
lines changed

content/en/docs/installation/installation-linux.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -312,9 +312,16 @@ On kernels > 2.6 all the kernel modules should automatically be loaded.
312312
However just in case run:
313313

314314
```bash
315-
sudo modprobe intel_rapl_common # or intel_rapl for kernels < 5
316-
sudo modprobe intel_rapl_msr
317-
sudo modprobe rapl
315+
# this should be all you need to use the GMT metric providers
316+
sudo modprobe msr
317+
318+
# this is optional if you want to debug stuff
319+
320+
sudo modprobe intel_rapl_msr # activates /sys/devices/virtual/powercap/intel-rapl subsystem
321+
sudo modprobe intel_rapl_common # needed common code for powercap subsystem above
322+
sudo modprobe intel_rapl # same thing but for kernels < 5
323+
324+
sudo modprobe rapl # activates kernel events to read RAPL via perf cli tool and perf_events lib
318325
```
319326

320327
## Live system

content/en/docs/measuring/metric-providers/cpu-energy-RAPL-MSR-component.md

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -14,16 +14,8 @@ This metric provider reads the energy of the CPU Package from the Running Averag
1414

1515
This MSR keeps a running count of the energy used in a specified domain in microJoules. This metric provider specifically reads from the `energy-pkg` domain, which gives you the cumulatove energy used by the domains `energy-cores`, `energy-gpu` and some extra parts like the voltage regulator and such that also reside on the package.
1616

17-
### System Setup
18-
On kernels > 2.6 all the kernel modules should automatically be loaded.
19-
20-
However just in case run:
21-
22-
```bash
23-
sudo modprobe intel_rapl_common # or intel_rapl for kernels < 5
24-
sudo modprobe intel_rapl_msr
25-
sudo modprobe rapl
26-
```
17+
### Setup
18+
Please look at [RAPL installation]({{< relref "/docs/installation/installation-linux" >}})
2719

2820
### Technical specs
2921

content/en/docs/measuring/metric-providers/memory-energy-RAPL-MSR-component.md

Lines changed: 2 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -14,17 +14,8 @@ This metric provider reads the DRAM energy from the Running Average Power Limit
1414
This MSR keeps a running count of the energy used in a specified domain in microJoules. This metric provider specifically reads from the `energy-pkg` domain, which gives you the energy used by all the domains.
1515

1616

17-
### System Setup
18-
On kernels > 2.6 all the kernel modules should automatically be loaded.
19-
20-
However just in case run:
21-
22-
```bash
23-
sudo modprobe intel_rapl_common # or intel_rapl for kernels < 5
24-
sudo modprobe intel_rapl_msr
25-
sudo modprobe rapl
26-
```
27-
17+
### Setup
18+
Please look at [RAPL installation]({{< relref "/docs/installation/installation-linux" >}})
2819

2920
### Technical specs
3021

content/en/docs/measuring/metric-providers/psu-energy-dc-rapl-msr-machine.md

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -18,16 +18,8 @@ This MSR keeps a running count of the energy used in a specified domain in micro
1818

1919
We have tested this domain on modern [Framework](https://frame.work/de/en) notebooks and the domain includes here at least all of the CPU, DRAM as well as the display.
2020

21-
### System Setup
22-
On kernels > 2.6 all the kernel modules should automatically be loaded.
23-
24-
However just in case run:
25-
26-
```bash
27-
sudo modprobe intel_rapl_common # or intel_rapl for kernels < 5
28-
sudo modprobe intel_rapl_msr
29-
sudo modprobe rapl
30-
```
21+
### Setup
22+
Please look at [RAPL installation]({{< relref "/docs/installation/installation-linux" >}})
3123

3224
### Technical specs
3325

0 commit comments

Comments
 (0)