docs(system-monitoring): add a new tutorial by AngeCyp · Pull Request #27 · alumet-dev/user-book

AngeCyp · 2026-06-17T14:51:28Z

add tutorial on how to monitor the current system in markdown book.

TheElectronWill

I have suggested some modifications for the beginning.
It's important to introduce things gradually:

install (very short, don't waste time on it here)
systemd service, because system monitoring
configuration file
start/enable example

TheElectronWill · 2026-06-19T14:01:38Z

put the images in a dedicated dir, e.g. images/tutorials/system-monitoring

TheElectronWill · 2026-06-19T14:06:18Z

+### important files
+
+Once installed, let's take a quick look at the files.
+The configuration file of alumet could be found under:
+**/etc/alumet/alumet-config.toml**, you could add all needed plugins and their configuration.
+
+On installation, Alumet add a systemd service.
+![systemd service of Alumet](../images/alumet-systemd-service.png)
+
+As you can see, the service is not enabled and not running. So Alumet is not running for now.


Suggested change

### important files

Once installed, let's take a quick look at the files.

The configuration file of alumet could be found under:

**/etc/alumet/alumet-config.toml**, you could add all needed plugins and their configuration.

On installation, Alumet add a systemd service.

![systemd service of Alumet](../images/alumet-systemd-service.png)

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

### Systemd Service

For a system-wide monitoring, we'll use the **systemd service** that comes with the alumet package you've just installed.

![systemd service of Alumet](../images/alumet-systemd-service.png)

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

TheElectronWill · 2026-06-19T14:07:44Z

+## Prepare the configuration
+


Suggested change

## Prepare the configuration

## Prepare the Configuration

The alumet-agent started by the systemd service uses a global configuration file, located at `/etc/alumet/alumet-config.toml`.

What should we put in this file to get an effective system monitoring?

TheElectronWill · 2026-06-19T14:08:48Z

+to start Alumet
+
+```bash
+sudo systemctl start alumet.service


This will not enable the service, is it intended?

You have to explain this somewhere:

systemctl enable (--now) alumet.service

titouanj · 2026-06-23T11:34:28Z

+![Alumet config regen](./system-monitoring_images/config-regen.png)
+
+If you want, you can disable some plugin, going under the config file and replacing:
+**enabled = true** by **enabled = false** wherever you want to disable the plugin.


Not in your example config

And it's enable not enabled

change, but both work 😬

titouanj · 2026-06-25T09:11:30Z

Do we really need a screenshot for a piece of toml file?

it's to show an example, when words are not enough

Can agree on that for logs in other screenshots, but not for this one

TheElectronWill

I think the objective of this guide is not clear enough.
Is it (1) for admins who want to use a systemd service, or (2) for a local experiments?

If (1), talk about the systemd service and how to enable it.
If (2), don't talk about the service, make the user generate a local config and start alumet-agent manually.

AngeCyp · 2026-07-03T10:36:55Z

More on option 2

…ystem in markdown book

Fyspeed · 2026-08-07T07:39:11Z

+Like this:
+![Disable RAPL plugin](system-monitoring_images/rapl_disable.png)
+
+Also, you can use the following configuration for a easy-start Alumet monitoring.


Suggested change

Also, you can use the following configuration for a easy-start Alumet monitoring.

Also, you can use the following configuration for an easy-start Alumet monitoring.

Fyspeed · 2026-08-07T07:44:09Z

+### RAPL
+
+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).
+
+### Procfs
+
+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).
+
+### CSV
+
+This plugin writes the measurements sent to Alumet in [CSV format](https://en.wikipedia.org/wiki/Comma-separated_values).
+


You could add a link to each plugin user book page, in case people want to take a deeper look at each of them

Use the following link instead: ../plugins/3_outputs/csv.md
Same for the others

AngeCyp requested a review from TheElectronWill June 17, 2026 14:53

titouanj requested changes Jun 17, 2026

View reviewed changes

Comment thread src/tutorials/system-monitoring.md

Comment thread src/tutorials/system-monitoring.md

Comment thread src/tutorials/system-monitoring.md Outdated

Comment thread theme/index.hbs

Comment thread src/tutorials/system-monitoring_images/alumet-systemd-service.png Outdated

TheElectronWill requested changes Jun 18, 2026

View reviewed changes

Comment thread theme/index.hbs

TheElectronWill requested changes Jun 19, 2026

View reviewed changes

AngeCyp force-pushed the docs/add-system-monitoring-tutorial branch 3 times, most recently from 2e6df9a to ba1697a Compare June 22, 2026 16:31

titouanj reviewed Jun 23, 2026

View reviewed changes

AngeCyp force-pushed the docs/add-system-monitoring-tutorial branch from ba1697a to 586bab5 Compare June 23, 2026 12:15

AngeCyp requested review from TheElectronWill and titouanj June 24, 2026 15:09

titouanj reviewed Jun 25, 2026

View reviewed changes

AngeCyp force-pushed the docs/add-system-monitoring-tutorial branch from 586bab5 to 4e18095 Compare June 26, 2026 08:20

AngeCyp requested a review from titouanj June 26, 2026 08:22

AngeCyp force-pushed the docs/add-system-monitoring-tutorial branch from 4e18095 to 97f3c06 Compare July 3, 2026 10:10

TheElectronWill requested changes Jul 3, 2026

View reviewed changes

AngeCyp force-pushed the docs/add-system-monitoring-tutorial branch from 97f3c06 to af9bb8f Compare July 3, 2026 10:36

TheElectronWill reviewed Jul 3, 2026

View reviewed changes

Comment thread src/tutorials/deeper-system-monitoring-tutorial.md Outdated

AngeCyp force-pushed the docs/add-system-monitoring-tutorial branch from af9bb8f to 37c121f Compare July 3, 2026 12:43

AngeCyp requested a review from TheElectronWill July 6, 2026 14:40

docs(system-monitoring): add tutorial on how to monitor the current s…

7bdb235

…ystem in markdown book

AngeCyp force-pushed the docs/add-system-monitoring-tutorial branch from 37c121f to e3a07bc Compare August 6, 2026 15:08

Fyspeed reviewed Aug 7, 2026

View reviewed changes

docs(system-monitoring): update plugin tuto and move some pictures

55ea476

AngeCyp force-pushed the docs/add-system-monitoring-tutorial branch from e3a07bc to 55ea476 Compare August 7, 2026 08:02

-## Prepare the configuration
+## Prepare the Configuration
+The alumet-agent started by the systemd service uses a global configuration file, located at `/etc/alumet/alumet-config.toml`.
+What should we put in this file to get an effective system monitoring?

	Also, you can use the following configuration for a easy-start Alumet monitoring.
	Also, you can use the following configuration for an easy-start Alumet monitoring.

Uh oh!

Conversation

AngeCyp commented Jun 17, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

TheElectronWill left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

TheElectronWill left a comment

Choose a reason for hiding this comment

Uh oh!

AngeCyp commented Jul 3, 2026

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants