summaryrefslogtreecommitdiffstats
path: root/collectors/python.d.plugin/logind/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'collectors/python.d.plugin/logind/README.md')
-rw-r--r--collectors/python.d.plugin/logind/README.md37
1 files changed, 32 insertions, 5 deletions
diff --git a/collectors/python.d.plugin/logind/README.md b/collectors/python.d.plugin/logind/README.md
index 5aa1fa627..3e2d4c190 100644
--- a/collectors/python.d.plugin/logind/README.md
+++ b/collectors/python.d.plugin/logind/README.md
@@ -1,6 +1,12 @@
-# logind
+<!--
+title: "systemd-logind monitoring with Netdata"
+custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/logind/README.md
+sidebar_label: "systemd-logind"
+-->
-This module monitors active sessions, users, and seats tracked by systemd-logind or elogind.
+# Systemd-Logind monitoring with Netdata
+
+Monitors active sessions, users, and seats tracked by `systemd-logind` or `elogind`.
It provides the following charts:
@@ -20,9 +26,22 @@ It provides the following charts:
- Seats
-## configuration
+## Enable the collector
+
+The `logind` collector is disabled by default. To enable it, use `edit-config` from the Netdata [config
+directory](/docs/configure/nodes.md), which is typically at `/etc/netdata`, to edit the `python.d.conf` file.
+
+```bash
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
+sudo ./edit-config python.d.conf
+```
+
+Change the value of the `logind` setting to `yes`. Save the file and restart the Netdata Agent with `sudo systemctl
+restart netdata`, or the appropriate method for your system, to finish enabling the `logind` collector.
-This module needs no configuration. Just make sure the `netdata` user
+## Configuration
+
+This module needs no configuration. Just make sure the `netdata` user
can run the `loginctl` command and get a session list without having to
specify a path.
@@ -35,7 +54,15 @@ specify it using the `command` key like so:
command: '/path/to/other/command'
```
-## notes
+Edit the `python.d/logind.conf` configuration file using `edit-config` from the Netdata [config
+directory](/docs/configure/nodes.md), which is typically at `/etc/netdata`.
+
+```bash
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
+sudo ./edit-config python.d/logind.conf
+```
+
+## Notes
- This module's ability to track logins is dependent on what PAM services
are configured to register sessions with logind. In particular, for