Skip to content

Commit 4e18095

Browse files
committed
docs(system-monitoring): update plugin tuto and move some pictures
1 parent 4d915bb commit 4e18095

11 files changed

Lines changed: 56 additions & 33 deletions

.cspell/project-words.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ powercap
1414
powermeters
1515
rapl
1616
RAPL
17+
regen
1718
rustup
1819
SCPI
1920
slurm

src/SUMMARY.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313

1414
- [Measuring the energy consumption of an AI model training]()
1515
- [Monitoring an entire system](tutorials/system-monitoring.md)
16+
- [Deeper monitoring of an entire system](tutorials/deeper-system-monitoring-tutorial.md)
1617

1718
# Plugins reference
1819

src/images/alumet-start.png

-64.9 KB
Binary file not shown.

src/images/alumet-start2.png

-49.2 KB
Binary file not shown.
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Deeper system monitoring with Alumet

src/tutorials/system-monitoring.md

Lines changed: 53 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -10,37 +10,61 @@ There are several ways of installing Alumet, you can use packages such as *.rpm*
1010
curl -sSL https://raw.githubusercontent.com/alumet-dev/alumet/main/install.sh | bash
1111
```
1212

13-
if you don't trust us (and you're right)
14-
15-
```bash
16-
curl -sSL https://raw.githubusercontent.com/alumet-dev/alumet/main/install.sh -o install.sh
17-
chmod +x install.sh
18-
./install.sh
19-
```
20-
2113
Your password could be asked.
2214

23-
### important files
15+
See more on [Installing Alumet](../start/install.md) chapter.
16+
17+
### Important files
2418

2519
Once installed, let's take a quick look at the files.
26-
The configuration file of alumet could be found under:
20+
The configuration file of alumet can be found under:
2721
**/etc/alumet/alumet-config.toml**, you could add all needed plugins and their configuration.
2822

2923
On installation, Alumet add a systemd service.
30-
![systemd service of Alumet](../images/alumet-systemd-service.png)
24+
![systemd service of Alumet](./system-monitoring_images/alumet-systemd-service.png)
3125

3226
As you can see, the service is not enabled and not running. So Alumet is not running for now.
3327

34-
## Prepare the configuration
28+
## Prepare the Configuration
3529

36-
For now, we want to monitor our system, so let's focus on basic plugin
30+
In this tutorial, we will monitor our system. So let's focus on the following plugins:
3731
- Input plugins
3832
- RAPL
3933
- Procfs (system)
4034
- Output plugins
4135
- CSV
4236

43-
According to the above list, here is the associated configuration file for Alumet. You can add the following content to a file: **./alumet-config. toml**.
37+
### RAPL
38+
39+
This plugin collects measurements of processor energy usage. Also know as `Running average power limit`, follow the link to learn more on [RAPL](https://en.wikipedia.org/wiki/Perf_(Linux)#RAPL).
40+
41+
### Procfs
42+
43+
This plugin collects processes and system-related metrics on Linux based operating systems. Follow the link to learn more on [Procfs](https://en.wikipedia.org/wiki/Procfs).
44+
45+
### CSV
46+
47+
This plugin writes the measurements sent to Alumet in [CSV format](https://en.wikipedia.org/wiki/Comma-separated_values).
48+
49+
### The configuration
50+
51+
Alumet comes with a command to regenerate the configuration. Let's do this for the used plugins using:
52+
53+
```bash
54+
alumet-agent --plugins rapl,procfs,csv config regen
55+
```
56+
57+
![Alumet config regen](./system-monitoring_images/config-regen.png)
58+
59+
If you want, you can disable some plugin, going under the config file and replacing (or adding):
60+
**enabled = false** wherever you want to disable the plugin.
61+
Like this:
62+
![Disable RAPL plugin](system-monitoring_images/rapl_disable.png)
63+
64+
Also, you can use the following configuration for a easy-start Alumet monitoring.
65+
66+
<details>
67+
<summary>Show more</summary>
4468

4569
```toml
4670
[plugins.rapl]
@@ -95,43 +119,39 @@ csv_delimiter = ";"
95119
csv_late_delimiter = ","
96120
```
97121

98-
## Run Alumet
99-
100-
Once your configuration is done, it's time to run Alumet. Several ways appears. We can use the systemd to make the measurements in background, and so use:
101-
to start Alumet
122+
</details>
102123

103-
```bash
104-
sudo systemctl start alumet.service
105-
```
124+
Learn more about configuration file on the [Configuration file](../start/config.md) chapter.
106125

107-
and to stop measurements
126+
## Run Alumet
108127

109-
```bash
110-
sudo systemctl stop alumet.service
111-
```
128+
Once your configuration is done, it's time to run Alumet.
112129

113-
But here, for more demonstrative try, I will directly launch it through CLI.
114-
To start Alumet on this way, use
130+
To start Alumet, use
115131

116132
```bash
117-
alumet-agent --config ./alumet-config.toml
133+
alumet-agent --plugins rapl,procfs,csv
118134
```
119135

120-
Please not that I used the flag **config** with the path of previously defined Alumet config to use it.
121-
122136
On my side, here is the launch of Alumet.
123137

124-
![Alumet started](../images/alumet-start.png)
138+
![Alumet started](./system-monitoring_images/alumet-start.png)
125139

126140
to
127141

128-
![Alumet started](../images/alumet-start2.png)
142+
![Alumet started](./system-monitoring_images/alumet-start2.png)
129143

130144
Here you can see that I enabled 3 plugins, 2 were input one and 1 is output.
131145

132146
Hit `ctrl+c` to stop Alumet and the measures.
133147

134148
## Look for the results
135149

136-
Once Alumet is stop, you can have a look to the created file in current repository: **alumet-output.csv**. The name and path was defined in the configuration file. You can search for **output_path** parameter in the **alumet-config.toml** of the current directory.
150+
Once Alumet is stopped, you can have a look to the created file in current directory: **alumet-output.csv**. The name and path were defined in the configuration file. You can search for **output_path** parameter in the **alumet-config.toml** of the current directory.
137151
And so you have your csv file containing all retrieved measures. You can freely use whatever you want to read this csv, basic file editor will be able to open it, but some will let you sort, filter,... contained lines.
152+
153+
## Learn more
154+
155+
CSV is a very simple output but it could not be adapted for larger data gathering. You could look at the [Influxdb plugins](../plugins/3_outputs/influxdb.md) for a better adapted plugin.
156+
157+
And for a deeper tutorial, please have a look at the [Deeper system monitoring with Alumet](deeper-system-monitoring-tutorial.md) chapter, which show more options for monitoring your system.
67.9 KB
Loading
87.9 KB
Loading

src/images/alumet-systemd-service.png renamed to src/tutorials/system-monitoring_images/alumet-systemd-service.png

File renamed without changes.
20.8 KB
Loading

0 commit comments

Comments
 (0)