You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
See more on [Installing Alumet](../start/install.md) chapter.
16
+
17
+
### Important files
24
18
25
19
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:
27
21
**/etc/alumet/alumet-config.toml**, you could add all needed plugins and their configuration.
28
22
29
23
On installation, Alumet add a systemd service.
30
-

24
+

31
25
32
26
As you can see, the service is not enabled and not running. So Alumet is not running for now.
33
27
34
-
## Prepare the configuration
28
+
## Prepare the Configuration
35
29
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:
37
31
- Input plugins
38
32
- RAPL
39
33
- Procfs (system)
40
34
- Output plugins
41
35
- CSV
42
36
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:
Also, you can use the following configuration for a easy-start Alumet monitoring.
65
+
66
+
<details>
67
+
<summary>Show more</summary>
44
68
45
69
```toml
46
70
[plugins.rapl]
@@ -95,43 +119,39 @@ csv_delimiter = ";"
95
119
csv_late_delimiter = ","
96
120
```
97
121
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>
102
123
103
-
```bash
104
-
sudo systemctl start alumet.service
105
-
```
124
+
Learn more about configuration file on the [Configuration file](../start/config.md) chapter.
106
125
107
-
and to stop measurements
126
+
## Run Alumet
108
127
109
-
```bash
110
-
sudo systemctl stop alumet.service
111
-
```
128
+
Once your configuration is done, it's time to run Alumet.
112
129
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
115
131
116
132
```bash
117
-
alumet-agent --config ./alumet-config.toml
133
+
alumet-agent --plugins rapl,procfs,csv
118
134
```
119
135
120
-
Please not that I used the flag **config** with the path of previously defined Alumet config to use it.
Here you can see that I enabled 3 plugins, 2 were input one and 1 is output.
131
145
132
146
Hit `ctrl+c` to stop Alumet and the measures.
133
147
134
148
## Look for the results
135
149
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.
137
151
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.
0 commit comments