Adding upstream version 1.37.1.upstream/1.37.1upstream

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

4 files changed, 383 insertions, 0 deletions

diff --git a/collectors/python.d.plugin/openldap/Makefile.inc b/collectors/python.d.plugin/openldap/Makefile.inc
new file mode 100644
index 0000000..dc947e2
--- /dev/null
+++ b/collectors/python.d.plugin/openldap/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       += openldap/openldap.chart.py
+dist_pythonconfig_DATA += openldap/openldap.conf
+
+# do not install these files, but include them in the distribution
+dist_noinst_DATA       += openldap/README.md openldap/Makefile.inc
+
diff --git a/collectors/python.d.plugin/openldap/README.md b/collectors/python.d.plugin/openldap/README.md
new file mode 100644
index 0000000..b0cd1db
--- /dev/null
+++ b/collectors/python.d.plugin/openldap/README.md
@@ -0,0 +1,79 @@
+<!--
+title: "OpenLDAP monitoring with Netdata"
+custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/openldap/README.md
+sidebar_label: "OpenLDAP"
+-->
+
+# OpenLDAP monitoring with Netdata
+
+Provides statistics information from openldap (slapd) server.
+Statistics are taken from LDAP monitoring interface. Manual page, slapd-monitor(5) is available.
+
+**Requirement:**
+
+-   Follow instructions from <https://www.openldap.org/doc/admin24/monitoringslapd.html> to activate monitoring interface.
+-   Install python ldap module `pip install ldap` or `yum install python-ldap`
+-   Modify openldap.conf with your credentials
+
+### Module gives information with following charts:
+
+1.  **connections**
+
+    -   total connections number
+
+2.  **Bytes**
+
+    -   sent
+
+3.  **operations**
+
+    -   completed
+    -   initiated
+
+4.  **referrals**
+
+    -   sent
+
+5.  **entries**
+
+    -   sent
+
+6.  **ldap operations**
+
+    -   bind
+    -   search
+    -   unbind 
+    -   add
+    -   delete
+    -   modify
+    -   compare
+
+7.  **waiters**
+
+    -   read
+    -   write
+
+## Configuration
+
+Edit the `python.d/openldap.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/openldap.conf
+```
+
+Sample:
+
+```yaml
+openldap:
+  name     : 'local'
+  username : "cn=monitor,dc=superb,dc=eu"
+  password : "testpass"
+  server   : 'localhost'
+  port     : 389
+```
+
+---
+
+
diff --git a/collectors/python.d.plugin/openldap/openldap.chart.py b/collectors/python.d.plugin/openldap/openldap.chart.py
new file mode 100644
index 0000000..aba1439
--- /dev/null
+++ b/collectors/python.d.plugin/openldap/openldap.chart.py
@@ -0,0 +1,216 @@
+# -*- coding: utf-8 -*-
+# Description: openldap netdata python.d module
+# Author: Manolis Kartsonakis (ekartsonakis)
+# SPDX-License-Identifier: GPL-3.0+
+
+try:
+    import ldap
+
+    HAS_LDAP = True
+except ImportError:
+    HAS_LDAP = False
+
+from bases.FrameworkServices.SimpleService import SimpleService
+
+DEFAULT_SERVER = 'localhost'
+DEFAULT_PORT = '389'
+DEFAULT_TLS = False
+DEFAULT_CERT_CHECK = True
+DEFAULT_TIMEOUT = 1
+DEFAULT_START_TLS = False
+
+ORDER = [
+    'total_connections',
+    'bytes_sent',
+    'operations',
+    'referrals_sent',
+    'entries_sent',
+    'ldap_operations',
+    'waiters'
+]
+
+CHARTS = {
+    'total_connections': {
+        'options': [None, 'Total Connections', 'connections/s', 'ldap', 'openldap.total_connections', 'line'],
+        'lines': [
+            ['total_connections', 'connections', 'incremental']
+        ]
+    },
+    'bytes_sent': {
+        'options': [None, 'Traffic', 'KiB/s', 'ldap', 'openldap.traffic_stats', 'line'],
+        'lines': [
+            ['bytes_sent', 'sent', 'incremental', 1, 1024]
+        ]
+    },
+    'operations': {
+        'options': [None, 'Operations Status', 'ops/s', 'ldap', 'openldap.operations_status', 'line'],
+        'lines': [
+            ['completed_operations', 'completed', 'incremental'],
+            ['initiated_operations', 'initiated', 'incremental']
+        ]
+    },
+    'referrals_sent': {
+        'options': [None, 'Referrals', 'referrals/s', 'ldap', 'openldap.referrals', 'line'],
+        'lines': [
+            ['referrals_sent', 'sent', 'incremental']
+        ]
+    },
+    'entries_sent': {
+        'options': [None, 'Entries', 'entries/s', 'ldap', 'openldap.entries', 'line'],
+        'lines': [
+            ['entries_sent', 'sent', 'incremental']
+        ]
+    },
+    'ldap_operations': {
+        'options': [None, 'Operations', 'ops/s', 'ldap', 'openldap.ldap_operations', 'line'],
+        'lines': [
+            ['bind_operations', 'bind', 'incremental'],
+            ['search_operations', 'search', 'incremental'],
+            ['unbind_operations', 'unbind', 'incremental'],
+            ['add_operations', 'add', 'incremental'],
+            ['delete_operations', 'delete', 'incremental'],
+            ['modify_operations', 'modify', 'incremental'],
+            ['compare_operations', 'compare', 'incremental']
+        ]
+    },
+    'waiters': {
+        'options': [None, 'Waiters', 'waiters/s', 'ldap', 'openldap.waiters', 'line'],
+        'lines': [
+            ['write_waiters', 'write', 'incremental'],
+            ['read_waiters', 'read', 'incremental']
+        ]
+    },
+}
+
+# Stuff to gather - make tuples of DN dn and attrib to get
+SEARCH_LIST = {
+    'total_connections': (
+        'cn=Total,cn=Connections,cn=Monitor', 'monitorCounter',
+    ),
+    'bytes_sent': (
+        'cn=Bytes,cn=Statistics,cn=Monitor', 'monitorCounter',
+    ),
+    'completed_operations': (
+        'cn=Operations,cn=Monitor', 'monitorOpCompleted',
+    ),
+    'initiated_operations': (
+        'cn=Operations,cn=Monitor', 'monitorOpInitiated',
+    ),
+    'referrals_sent': (
+        'cn=Referrals,cn=Statistics,cn=Monitor', 'monitorCounter',
+    ),
+    'entries_sent': (
+        'cn=Entries,cn=Statistics,cn=Monitor', 'monitorCounter',
+    ),
+    'bind_operations': (
+        'cn=Bind,cn=Operations,cn=Monitor', 'monitorOpCompleted',
+    ),
+    'unbind_operations': (
+        'cn=Unbind,cn=Operations,cn=Monitor', 'monitorOpCompleted',
+    ),
+    'add_operations': (
+        'cn=Add,cn=Operations,cn=Monitor', 'monitorOpInitiated',
+    ),
+    'delete_operations': (
+        'cn=Delete,cn=Operations,cn=Monitor', 'monitorOpCompleted',
+    ),
+    'modify_operations': (
+        'cn=Modify,cn=Operations,cn=Monitor', 'monitorOpCompleted',
+    ),
+    'compare_operations': (
+        'cn=Compare,cn=Operations,cn=Monitor', 'monitorOpCompleted',
+    ),
+    'search_operations': (
+        'cn=Search,cn=Operations,cn=Monitor', 'monitorOpCompleted',
+    ),
+    'write_waiters': (
+        'cn=Write,cn=Waiters,cn=Monitor', 'monitorCounter',
+    ),
+    'read_waiters': (
+        'cn=Read,cn=Waiters,cn=Monitor', 'monitorCounter',
+    ),
+}
+
+
+class Service(SimpleService):
+    def __init__(self, configuration=None, name=None):
+        SimpleService.__init__(self, configuration=configuration, name=name)
+        self.order = ORDER
+        self.definitions = CHARTS
+        self.server = configuration.get('server', DEFAULT_SERVER)
+        self.port = configuration.get('port', DEFAULT_PORT)
+        self.username = configuration.get('username')
+        self.password = configuration.get('password')
+        self.timeout = configuration.get('timeout', DEFAULT_TIMEOUT)
+        self.use_tls = configuration.get('use_tls', DEFAULT_TLS)
+        self.cert_check = configuration.get('cert_check', DEFAULT_CERT_CHECK)
+        self.use_start_tls = configuration.get('use_start_tls', DEFAULT_START_TLS)
+        self.alive = False
+        self.conn = None
+
+    def disconnect(self):
+        if self.conn:
+            self.conn.unbind()
+            self.conn = None
+            self.alive = False
+
+    def connect(self):
+        try:
+            if self.use_tls:
+                self.conn = ldap.initialize('ldaps://%s:%s' % (self.server, self.port))
+            else:
+                self.conn = ldap.initialize('ldap://%s:%s' % (self.server, self.port))
+            self.conn.set_option(ldap.OPT_NETWORK_TIMEOUT, self.timeout)
+            if (self.use_tls or self.use_start_tls) and not self.cert_check:
+                self.conn.set_option(ldap.OPT_X_TLS_REQUIRE_CERT, ldap.OPT_X_TLS_NEVER)
+            if self.use_start_tls or self.use_tls:
+                self.conn.set_option(ldap.OPT_X_TLS_NEWCTX, 0)
+            if self.use_start_tls:
+                self.conn.protocol_version = ldap.VERSION3
+                self.conn.start_tls_s()
+            if self.username and self.password:
+                self.conn.simple_bind(self.username, self.password)
+        except ldap.LDAPError as error:
+            self.error(error)
+            return False
+
+        self.alive = True
+        return True
+
+    def reconnect(self):
+        self.disconnect()
+        return self.connect()
+
+    def check(self):
+        if not HAS_LDAP:
+            self.error("'python-ldap' package is needed")
+            return None
+
+        return self.connect() and self.get_data()
+
+    def get_data(self):
+        if not self.alive and not self.reconnect():
+            return None
+
+        data = dict()
+        for key in SEARCH_LIST:
+            dn = SEARCH_LIST[key][0]
+            attr = SEARCH_LIST[key][1]
+            try:
+                num = self.conn.search(dn, ldap.SCOPE_BASE, 'objectClass=*', [attr, ])
+                result_type, result_data = self.conn.result(num, 1)
+            except ldap.LDAPError as error:
+                self.error("Empty result. Check bind username/password. Message: ", error)
+                self.alive = False
+                return None
+
+            if result_type != 101:
+                continue
+
+            try:
+                data[key] = int(list(result_data[0][1].values())[0][0])
+            except (ValueError, IndexError) as error:
+                self.debug(error)
+                continue
+
+        return data
diff --git a/collectors/python.d.plugin/openldap/openldap.conf b/collectors/python.d.plugin/openldap/openldap.conf
new file mode 100644
index 0000000..5fd99a5
--- /dev/null
+++ b/collectors/python.d.plugin/openldap/openldap.conf
@@ -0,0 +1,75 @@
+# netdata python.d.plugin configuration for openldap
+#
+# 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.
+# postfix is slow, so once every 10 seconds
+update_every: 10
+
+# 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
+#
+# ----------------------------------------------------------------------
+# OPENLDAP EXTRA PARAMETERS
+
+# Set here your LDAP connection settings
+
+#username     : "cn=admin,dc=example,dc=com"   # The bind user with right to access monitor statistics
+#password     : "yourpass"                     # The password for the binded user
+#server       : 'localhost'                    # The listening address of the LDAP server. In case of TLS, use the hostname which the certificate is published for.
+#port         : 389                            # The listening port of the LDAP server. Change to 636 port in case of TLS connection
+#use_tls      : False                          # Make True if a TLS connection is used over ldaps://
+#use_start_tls: False                          # Make True if a TLS connection is used over ldap://
+#cert_check   : True                           # False if you want to ignore certificate check
+#timeout      : 1                              # Seconds to timeout if no connection exi