Adding upstream version 1.43.0.upstream/1.43.0

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

1 files changed, 25 insertions, 16 deletions

diff --git a/collectors/python.d.plugin/samba/metadata.yaml b/collectors/python.d.plugin/samba/metadata.yaml
index 43bca208e..ec31e0475 100644
--- a/collectors/python.d.plugin/samba/metadata.yaml
+++ b/collectors/python.d.plugin/samba/metadata.yaml
@@ -23,9 +23,9 @@ modules:
         metrics_description: "This collector monitors the performance metrics of Samba file sharing."
         method_description: |
           It is using the `smbstatus` command-line tool.
-          
+
           Executed commands:
-          
+
           - `sudo -n smbstatus -P`
       supported_platforms:
         include: []
@@ -44,32 +44,41 @@ modules:
     setup:
       prerequisites:
         list:
+          - title: Enable the samba collector
+            description: |
+              The `samba` collector is disabled by default. To enable it, use `edit-config` from the Netdata [config directory](https://github.com/netdata/netdata/blob/master/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 `samba` setting to `yes`. Save the file and restart the Netdata Agent with `sudo systemctl restart netdata`, or the [appropriate method](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md) for your system.
           - title: Permissions and programs
             description: |
               To run the collector you need:
-              
+
               - `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`
-              
+
               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.
-              
+
               - add to your `/etc/sudoers` file:
-              
+
                 `which smbstatus` shows the full path to the binary.
-              
+
                 ```bash
                 netdata ALL=(root)       NOPASSWD: /path/to/smbstatus
                 ```
-              
+
               - Reset Netdata's systemd unit [CapabilityBoundingSet](https://www.freedesktop.org/software/systemd/man/systemd.exec.html#Capabilities) (Linux distributions with systemd)
-              
+
                 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`.
-              
-              
+
+
                 As the `root` user, do the following:
-              
+
                 ```cmd
                 mkdir /etc/systemd/system/netdata.service.d
                 echo -e '[Service]\nCapabilityBoundingSet=~' | tee /etc/systemd/system/netdata.service.d/unset-capability-bounding-set.conf
@@ -82,14 +91,14 @@ modules:
         options:
           description: |
             There are 2 sections:
-            
+
             * Global variables
             * One or more JOBS that can define multiple different instances to monitor.
-            
+
             The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.
-            
+
             Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
-            
+
             Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
           folding:
             title: "Config options"