From 608af7bf0232448f73e76e62a75c8a2e77655101 Mon Sep 17 00:00:00 2001
From: Daniel Baumann <daniel.baumann@progress-linux.org>
Date: Thu, 18 Feb 2021 16:22:04 +0100
Subject: Adding upstream version 1.29.2.

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
---
 collectors/python.d.plugin/samba/README.md | 127 +++++++++++++++++------------
 1 file changed, 77 insertions(+), 50 deletions(-)

(limited to 'collectors/python.d.plugin/samba')

diff --git a/collectors/python.d.plugin/samba/README.md b/collectors/python.d.plugin/samba/README.md
index ed26d2871..a5126510f 100644
--- a/collectors/python.d.plugin/samba/README.md
+++ b/collectors/python.d.plugin/samba/README.md
@@ -6,83 +6,110 @@ sidebar_label: "Samba"
 
 # Samba monitoring with Netdata
 
-Monitors the performance metrics of Samba file sharing.
+Monitors the performance metrics of Samba file sharing using `smbstatus` command-line tool.
+
+Executed commands:
+
+- `sudo -n smbstatus -P`
 
 ## Requirements
 
--   `smbstatus` program
--   `sudo` program
--   `smbd` must be compiled with profiling enabled
--   `smbd` must be started either with the `-P 1` option or inside `smb.conf` using `smbd profiling level`
--   `netdata` user needs to be able to sudo the `smbstatus` program without password
+- `smbstatus` program
+- `sudo` program
+- `smbd` must be compiled with profiling enabled
+- `smbd` must be started either with the `-P 1` option or inside `smb.conf` using `smbd profiling level`
 
-It produces the following charts:
+The module uses `smbstatus`, which can only be executed by `root`. It uses
+`sudo` and assumes that it is configured such that the `netdata` user can execute `smbstatus` as root without a
+password.
 
-1.  **Syscall R/Ws** in kilobytes/s
+- Add to your `/etc/sudoers` file:
 
-    -   sendfile
-    -   recvfile
+`which smbstatus` shows the full path to the binary.
 
-2.  **Smb2 R/Ws** in kilobytes/s
+```bash
+netdata ALL=(root)       NOPASSWD: /path/to/smbstatus
+```
 
-    -   readout
-    -   writein
-    -   readin
-    -   writeout
+- Reset Netdata's systemd
+  unit [CapabilityBoundingSet](https://www.freedesktop.org/software/systemd/man/systemd.exec.html#Capabilities) (Linux
+  distributions with systemd)
 
-3.  **Smb2 Create/Close** in operations/s
+The default CapabilityBoundingSet doesn't allow using `sudo`, and is quite strict in general. Resetting is not optimal, but a next-best solution given the inability to execute `smbstatus` using `sudo`.
 
-    -   create
-    -   close
 
-4.  **Smb2 Info** in operations/s
+As the `root` user, do the following:
 
-    -   getinfo
-    -   setinfo
+```cmd
+mkdir /etc/systemd/system/netdata.service.d
+echo -e '[Service]\nCapabilityBoundingSet=~' | tee /etc/systemd/system/netdata.service.d/unset-capability-bounding-set.conf
+systemctl daemon-reload
+systemctl restart netdata.service
+```
 
-5.  **Smb2 Find** in operations/s
+## Charts
 
-    -   find
+1. **Syscall R/Ws** in kilobytes/s
 
-6.  **Smb2 Notify** in operations/s
+    - sendfile
+    - recvfile
 
-    -   notify
+2. **Smb2 R/Ws** in kilobytes/s
 
-7.  **Smb2 Lesser Ops** as counters
+    - readout
+    - writein
+    - readin
+    - writeout
 
-    -   tcon
-    -   negprot
-    -   tdis
-    -   cancel
-    -   logoff
-    -   flush
-    -   lock
-    -   keepalive
-    -   break
-    -   sessetup
+3. **Smb2 Create/Close** in operations/s
 
-## prerequisite
+    - create
+    - close
 
-This module uses `smbstatus` which can only be executed by root.  It uses
-`sudo` and assumes that it is configured such that the `netdata` user can
-execute `smbstatus` as root without password.
+4. **Smb2 Info** in operations/s
 
-Add to `sudoers`:
+    - getinfo
+    - setinfo
 
-```
-netdata ALL=(root)       NOPASSWD: /path/to/smbstatus
-```
+5. **Smb2 Find** in operations/s
 
-## Configuration
+    - find
 
-**samba** is disabled by default. Should be explicitly enabled in `python.d.conf`.
+6. **Smb2 Notify** in operations/s
 
-```yaml
-samba: yes
+    - notify
+
+7. **Smb2 Lesser Ops** as counters
+
+    - tcon
+    - negprot
+    - tdis
+    - cancel
+    - logoff
+    - flush
+    - lock
+    - keepalive
+    - break
+    - sessetup
+
+## Enable the collector
+
+The `samba` 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
 ```
 
-Edit the `python.d/samba.conf` configuration file using `edit-config` from the Netdata [config
-directory](/docs/configure/nodes.md), which is typically at `/etc/netdata`.
+Change the value of the `samba` setting to `yes`. Save the file and restart the Netdata Agent
+with `sudo systemctl restart netdata`, or the appropriate method for your system.
+
+## Configuration
+
+Edit the `python.d/samba.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
-- 
cgit v1.2.3