Skip to content

Commit bf4cf46

Browse files
author
Kellian Leveque
committed
docs(reference): Update overview.md
- Remove duplicate lines in the overview.md file - Fix formatting issues in the overview.md file - Fix broken image links in the processors section - Update the tables headers
1 parent c108291 commit bf4cf46

File tree

1 file changed

+11
-13
lines changed

1 file changed

+11
-13
lines changed

docs/reference/overview.md

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@
33
This project aims to offer a range of tools to promote greener computing. The focus is on creating software-defined PowerMeters to measure the power consumption of various programs.
44
At the heart of this initiative is the [PowerAPI](https://github.com/powerapi-ng/powerapi) toolkit, which facilitates the development of these PowerMeters.
55

6-
7-
86
## Software PowerMeters
97

108
A software PowerMeter is an application built using PowerAPI components, designed to measure the power consumption of software running on a single machine or across a cluster of machines.
@@ -13,10 +11,10 @@ The diagram below illustrates the overall architecture of a PowerMeter within th
1311

1412
![PowerAPI Architecture Overview](../assets/images/reference/overview/global-architecture.jpg){ width="1000px"}
1513

16-
A PowerMeter consists of two essential components:
14+
A PowerMeter consists of two essential components:
1715

18-
- A [Sensor](#Sensor), which collects system usage metrics and generates usage reports.
19-
- A [Formula](#Formula), which applies a computational model to the usage reports, producing power consumption data (in mJ).
16+
- a [Sensor](#Sensor), which collects system usage metrics and generates usage reports.
17+
- a [Formula](#Formula), which applies a computational model to the usage reports, producing power consumption data (in mJ).
2018

2119
Additionally, [Preprocessors](./overview.md#Preprocessors) can be utilized to modify usage reports before they are processed by the Formula.
2220

@@ -30,9 +28,9 @@ The raw data collected is then stored as usage Reports in various formats, eithe
3028

3129
### Existing Sensors
3230

33-
| Sensor name | Documentation | GitHub Repository | Description | Supported |
31+
| Sensor | Documentation | Repository | Description | Supported |
3432
| :---------------: |----------------------|--------------------------|----------------|---------------|
35-
| HWPC | [HWPC Documentation](./sensors/hwpc-sensor.md) | https://github.com/powerapi-ng/hwpc-sensor | Hardware Performance Counters monitoring agent for containers | :material-check: Supported |
33+
| HWPC | [HWPC Documentation](./sensors/hwpc-sensor.md) | [Github](https://github.com/powerapi-ng/hwpc-sensor) | Hardware Performance Counters monitoring agent for containers | :material-check: Supported |
3634

3735

3836
## Formula
@@ -47,17 +45,17 @@ There are two modes in which a Formula can operate:
4745

4846
### Existing Formulas
4947

50-
| Formula name | Documentation | GitHub Repository | Description | Supported |
48+
| Formula | Documentation | Repository | Description | Supported |
5149
| :---------------: |----------------------|--------------------------|----------------|---------------|
52-
| SmartWatts | [SmartWatts Documentation](./formulas/smatwatts.md) | https://github.com/powerapi-ng/smartwatts-formula | HSmartWatts is a formula for a self-adaptive software-defined power meter based on the PowerAPI framework. | :material-check: Supported |
50+
| SmartWatts | [SmartWatts Documentation](./formulas/smatwatts.md) | [Github](https://github.com/powerapi-ng/smartwatts-formula) | HSmartWatts is a formula for a self-adaptive software-defined power meter based on the PowerAPI framework. | :material-check: Supported |
5351

5452
## Processors
5553

5654
Processors allow for the customized filtering and modification of Reports. While optional, they offer additional flexibility, but Software PowerMeters can still function without them.
5755

5856
The diagram below shows where Processors are integrated into the architecture of a Software PowerMeter.
5957

60-
![Processor integration in the processing pipeline](../..//docs/assets/images/reference/processors/processors.jpg)
58+
![Processor integration in the processing pipeline](../assets/images/reference/processors/processors.jpg)
6159

6260
### Preprocessors
6361

@@ -66,8 +64,8 @@ Their role is to pre-process usage reports before the power consumption estimati
6664

6765
#### Existing Preprocessors
6866

69-
| Preprocessor name | Documentation | GitHub Repository | Description | Supported |
67+
| Preprocessor | Documentation | Repository | Description | Supported |
7068
| :---------------: |----------------------|--------------------------|----------------|---------------|
71-
| k8sPreprocessor | [k8sPreprocessor Documentation](./processors/processors.md#k8spreprocessor) | https://github.com/powerapi-ng/powerapi/tree/master/src/powerapi/processor/pre/k8s | Add K8S Specific metadata to corresponding Reports | :material-check: Supported |
72-
| libvirt | [libvirtPreprocessor Documentation](.processors/processors.md#libvirt) | https://github.com/powerapi-ng/powerapi/tree/master/src/powerapi/processor/pre/libvirt | Replace `libvirt ID` in Reports with `Open Stack UUID` | :material-check: Supported |
69+
| k8sPreprocessor | [k8sPreprocessor Documentation](./processors/processors.md#k8spreprocessor) | [Github](https://github.com/powerapi-ng/powerapi/tree/master/src/powerapi/processor/pre/k8s) | Add K8S Specific metadata to corresponding Reports | :material-check: Supported |
70+
| libvirt | [libvirtPreprocessor Documentation](.processors/processors.md#libvirt) | [Github](https://github.com/powerapi-ng/powerapi/tree/master/src/powerapi/processor/pre/libvirt) | Replace `libvirt ID` in Reports with `Open Stack UUID` | :material-check: Supported |
7371

0 commit comments

Comments
 (0)