Skip to content
This repository was archived by the owner on Jul 3, 2023. It is now read-only.

Commit 810a384

Browse files
author
Lauric Desauw
committed
doc: update README
1 parent 9ef1d47 commit 810a384

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
1-
VirtualWatts is a software-defined power meter based on the PowerAPI toolkit.
2-
VirtualWatts a configurable software that can estimate the power consumption of
3-
process inside a VM in real-time.
4-
VirtuallWatts is supposed to be used inside a VM. It need to receive two metrics :
1+
# Procfs-Sensor
52

6-
- The energy consumption of the VM, usually made with
7-
[SmartWatts](https://github.com/powerapi-ng/smartwatts-formula)
8-
- The cpu usage of the tracked processes and the global cpu usage, as provided
9-
by [procfs-sensor](https://github.com/powerapi-ng/procfs-sensor).
3+
The Proc Filesystem Sensor is a tool that monitor the CPU usage of cgroup via
4+
the linux's proc filesystem.
5+
It use `pidstat` to retreive the percentage of CPU usage of each process.
6+
It then use the `/sys/fs/perf_event` directory to find the appartenance of
7+
processes to cgroup.
8+
9+
The sensor need the cgroup version 1. The version 2 is not supported yet.
1010

1111
# About
1212

13-
VirtualWatts is an open-source project developed by the [Spirals research
13+
Procfs Sensor is an open-source project developed by the [Spirals research
1414
group](https://team.inria.fr/spirals) (University of Lille 1 and Inria).
1515

1616
The documentation is not available yet.
@@ -19,13 +19,13 @@ The documentation is not available yet.
1919

2020
If you would like to contribute code you can do so through GitHub by forking the
2121
repository and sending a pull request.
22-
You should start by reading the [contribution guide](https://github.com/powerapi-ng/virtualwatts/blob/main/contributing.md)
22+
You should start by reading the [contribution guide](https://github.com/powerapi-ng/procfs-sensor/blob/main/contributing.md)
2323

2424
When submitting code, please check that it is conform by using `pylint` and
2525
`flake8` with the configurations files at the root of the project.
2626

2727
## Acknowledgments
2828

29-
VirtualWatts is written in [Python](https://www.python.org/) (under [PSF
30-
license](https://docs.python.org/3/license.html)) and built on top of
31-
[PowerAPI](https://github.com/powerapi-ng/powerapi)
29+
Procfs Sensor is written in [Python](https://www.python.org/) (under [PSF
30+
license](https://docs.python.org/3/license.html)).
31+
It also use [`pidstat`](https://github.com/sysstat/sysstat)

0 commit comments

Comments
 (0)