Adding upstream version 1.37.1.upstream/1.37.1upstream

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

4 files changed, 338 insertions, 0 deletions

diff --git a/collectors/python.d.plugin/samba/Makefile.inc b/collectors/python.d.plugin/samba/Makefile.inc
new file mode 100644
index 0000000..230a8ba
--- /dev/null
+++ b/collectors/python.d.plugin/samba/Makefile.inc
@@ -0,0 +1,13 @@
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+# THIS IS NOT A COMPLETE Makefile
+# IT IS INCLUDED BY ITS PARENT'S Makefile.am
+# IT IS REQUIRED TO REFERENCE ALL FILES RELATIVE TO THE PARENT
+
+# install these files
+dist_python_DATA       += samba/samba.chart.py
+dist_pythonconfig_DATA += samba/samba.conf
+
+# do not install these files, but include them in the distribution
+dist_noinst_DATA       += samba/README.md samba/Makefile.inc
+
diff --git a/collectors/python.d.plugin/samba/README.md b/collectors/python.d.plugin/samba/README.md
new file mode 100644
index 0000000..767df12
--- /dev/null
+++ b/collectors/python.d.plugin/samba/README.md
@@ -0,0 +1,121 @@
+<!--
+title: "Samba monitoring with Netdata"
+custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/samba/README.md
+sidebar_label: "Samba"
+-->
+
+# Samba monitoring with Netdata
+
+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`
+
+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
+systemctl daemon-reload
+systemctl restart netdata.service
+```
+
+## Charts
+
+1. **Syscall R/Ws** in kilobytes/s
+
+    - sendfile
+    - recvfile
+
+2. **Smb2 R/Ws** in kilobytes/s
+
+    - readout
+    - writein
+    - readin
+    - writeout
+
+3. **Smb2 Create/Close** in operations/s
+
+    - create
+    - close
+
+4. **Smb2 Info** in operations/s
+
+    - getinfo
+    - setinfo
+
+5. **Smb2 Find** in operations/s
+
+    - find
+
+6. **Smb2 Notify** in operations/s
+
+    - 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
+```
+
+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](/docs/configure/start-stop-restart.md) 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
+sudo ./edit-config python.d/samba.conf
+```
+
+---
+
+
diff --git a/collectors/python.d.plugin/samba/samba.chart.py b/collectors/python.d.plugin/samba/samba.chart.py
new file mode 100644
index 0000000..8eebcd6
--- /dev/null
+++ b/collectors/python.d.plugin/samba/samba.chart.py
@@ -0,0 +1,144 @@
+# -*- coding: utf-8 -*-
+# Description:  samba netdata python.d module
+# Author: Christopher Cox <chris_cox@endlessnow.com>
+# SPDX-License-Identifier: GPL-3.0-or-later
+#
+# The netdata user needs to be able to be able to sudo the smbstatus program
+# without password:
+# netdata ALL=(ALL)       NOPASSWD: /usr/bin/smbstatus -P
+#
+# This makes calls to smbstatus -P
+#
+# This just looks at a couple of values out of syscall, and some from smb2.
+#
+# The Lesser Ops chart is merely a display of current counter values.  They
+# didn't seem to change much to me.  However, if you notice something changing
+# a lot there, bring one or more out into its own chart and make it incremental
+# (like find and notify... good examples).
+
+import re
+import os
+
+from bases.FrameworkServices.ExecutableService import ExecutableService
+from bases.collection import find_binary
+
+disabled_by_default = True
+
+update_every = 5
+
+ORDER = [
+    'syscall_rw',
+    'smb2_rw',
+    'smb2_create_close',
+    'smb2_info',
+    'smb2_find',
+    'smb2_notify',
+    'smb2_sm_count'
+]
+
+CHARTS = {
+    'syscall_rw': {
+        'options': [None, 'R/Ws', 'KiB/s', 'syscall', 'syscall.rw', 'area'],
+        'lines': [
+            ['syscall_sendfile_bytes', 'sendfile', 'incremental', 1, 1024],
+            ['syscall_recvfile_bytes', 'recvfile', 'incremental', -1, 1024]
+        ]
+    },
+    'smb2_rw': {
+        'options': [None, 'R/Ws', 'KiB/s', 'smb2', 'smb2.rw', 'area'],
+        'lines': [
+            ['smb2_read_outbytes', 'readout', 'incremental', 1, 1024],
+            ['smb2_write_inbytes', 'writein', 'incremental', -1, 1024],
+            ['smb2_read_inbytes', 'readin', 'incremental', 1, 1024],
+            ['smb2_write_outbytes', 'writeout', 'incremental', -1, 1024]
+        ]
+    },
+    'smb2_create_close': {
+        'options': [None, 'Create/Close', 'operations/s', 'smb2', 'smb2.create_close', 'line'],
+        'lines': [
+            ['smb2_create_count', 'create', 'incremental', 1, 1],
+            ['smb2_close_count', 'close', 'incremental', -1, 1]
+        ]
+    },
+    'smb2_info': {
+        'options': [None, 'Info', 'operations/s', 'smb2', 'smb2.get_set_info', 'line'],
+        'lines': [
+            ['smb2_getinfo_count', 'getinfo', 'incremental', 1, 1],
+            ['smb2_setinfo_count', 'setinfo', 'incremental', -1, 1]
+        ]
+    },
+    'smb2_find': {
+        'options': [None, 'Find', 'operations/s', 'smb2', 'smb2.find', 'line'],
+        'lines': [
+            ['smb2_find_count', 'find', 'incremental', 1, 1]
+        ]
+    },
+    'smb2_notify': {
+        'options': [None, 'Notify', 'operations/s', 'smb2', 'smb2.notify', 'line'],
+        'lines': [
+            ['smb2_notify_count', 'notify', 'incremental', 1, 1]
+        ]
+    },
+    'smb2_sm_count': {
+        'options': [None, 'Lesser Ops', 'count', 'smb2', 'smb2.sm_counters', 'stacked'],
+        'lines': [
+            ['smb2_tcon_count', 'tcon', 'absolute', 1, 1],
+            ['smb2_negprot_count', 'negprot', 'absolute', 1, 1],
+            ['smb2_tdis_count', 'tdis', 'absolute', 1, 1],
+            ['smb2_cancel_count', 'cancel', 'absolute', 1, 1],
+            ['smb2_logoff_count', 'logoff', 'absolute', 1, 1],
+            ['smb2_flush_count', 'flush', 'absolute', 1, 1],
+            ['smb2_lock_count', 'lock', 'absolute', 1, 1],
+            ['smb2_keepalive_count', 'keepalive', 'absolute', 1, 1],
+            ['smb2_break_count', 'break', 'absolute', 1, 1],
+            ['smb2_sessetup_count', 'sessetup', 'absolute', 1, 1]
+        ]
+    }
+}
+
+SUDO = 'sudo'
+SMBSTATUS = 'smbstatus'
+
+
+class Service(ExecutableService):
+    def __init__(self, configuration=None, name=None):
+        ExecutableService.__init__(self, configuration=configuration, name=name)
+        self.order = ORDER
+        self.definitions = CHARTS
+        self.rgx_smb2 = re.compile(r'(smb2_[^:]+|syscall_.*file_bytes):\s+(\d+)')
+
+    def check(self):
+        smbstatus_binary = find_binary(SMBSTATUS)
+        if not smbstatus_binary:
+            self.error("can't locate '{0}' binary".format(SMBSTATUS))
+            return False
+
+        if os.getuid() == 0:
+            self.command = ' '.join([smbstatus_binary, '-P'])
+            return ExecutableService.check(self)
+        
+        sudo_binary = find_binary(SUDO)
+        if not sudo_binary:
+            self.error("can't locate '{0}' binary".format(SUDO))
+            return False
+        command = [sudo_binary, '-n', '-l', smbstatus_binary, '-P']
+        smbstatus = '{0} -P'.format(smbstatus_binary)
+        allowed = self._get_raw_data(command=command)
+        if not (allowed and allowed[0].strip() == smbstatus):
+            self.error("not allowed to run sudo for command '{0}'".format(smbstatus))
+            return False
+        self.command = ' '.join([sudo_binary, '-n', smbstatus_binary, '-P'])
+        return ExecutableService.check(self)
+
+    def _get_data(self):
+        """
+        Format data received from shell command
+        :return: dict
+        """
+        raw_data = self._get_raw_data()
+        if not raw_data:
+            return None
+
+        parsed = self.rgx_smb2.findall(' '.join(raw_data))
+
+        return dict(parsed) or None
diff --git a/collectors/python.d.plugin/samba/samba.conf b/collectors/python.d.plugin/samba/samba.conf
new file mode 100644
index 0000000..db15d4e
--- /dev/null
+++ b/collectors/python.d.plugin/samba/samba.conf
@@ -0,0 +1,60 @@
+# netdata python.d.plugin configuration for samba
+#
+# This file is in YaML format. Generally the format is:
+#
+# name: value
+#
+# There are 2 sections:
+#  - global variables
+#  - one or more JOBS
+#
+# JOBS allow you to collect values from multiple sources.
+# Each source will have its own set of charts.
+#
+# JOB parameters have to be indented (using spaces only, example below).
+
+# ----------------------------------------------------------------------
+# Global Variables
+# These variables set the defaults for all JOBs, however each JOB
+# may define its own, overriding the defaults.
+
+# update_every sets the default data collection frequency.
+# If unset, the python.d.plugin default is used.
+update_every: 5
+
+# priority controls the order of charts at the netdata dashboard.
+# Lower numbers move the charts towards the top of the page.
+# If unset, the default for python.d.plugin is used.
+# priority: 60000
+
+# penalty indicates whether to apply penalty to update_every in case of failures.
+# Penalty will increase every 5 failed updates in a row. Maximum penalty is 10 minutes.
+# penalty: yes
+
+# autodetection_retry sets the job re-check interval in seconds.
+# The job is not deleted if check fails.
+# Attempts to start the job are made once every autodetection_retry.
+# This feature is disabled by default.
+# autodetection_retry: 0
+
+# ----------------------------------------------------------------------
+# JOBS (data collection sources)
+#
+# The default JOBS share the same *name*. JOBS with the same name
+# are mutually exclusive. Only one of them will be allowed running at
+# any time. This allows autodetection to try several alternatives and
+# pick the one that works.
+#
+# Any number of jobs is supported.
+#
+# All python.d.plugin JOBS (for all its modules) support a set of
+# predefined parameters. These are:
+#
+# job_name:
+#     name: myname            # the JOB's name as it will appear at the
+#                             # dashboard (by default is the job_name)
+#                             # JOBs sharing a name are mutually exclusive
+#     update_every: 1         # the JOB's data collection frequency
+#     priority: 60000         # the JOB's order on the dashboard
+#     penalty: yes            # the JOB's penalty
+#     autodetection_retry: 0  # the JOB's re-check interval in seconds
\ No newline at end of file