Adding upstream version 1.37.1.upstream/1.37.1upstream

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

4 files changed, 378 insertions, 0 deletions

diff --git a/collectors/python.d.plugin/gearman/Makefile.inc b/collectors/python.d.plugin/gearman/Makefile.inc
new file mode 100644
index 0000000..275adf1
--- /dev/null
+++ b/collectors/python.d.plugin/gearman/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       += gearman/gearman.chart.py
+dist_pythonconfig_DATA += gearman/gearman.conf
+
+# do not install these files, but include them in the distribution
+dist_noinst_DATA       += gearman/README.md gearman/Makefile.inc
+
diff --git a/collectors/python.d.plugin/gearman/README.md b/collectors/python.d.plugin/gearman/README.md
new file mode 100644
index 0000000..34ea584
--- /dev/null
+++ b/collectors/python.d.plugin/gearman/README.md
@@ -0,0 +1,50 @@
+<!--
+title: "Gearman monitoring with Netdata"
+custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/gearman/README.md
+sidebar_label: "Gearman"
+-->
+
+# Gearman monitoring with Netdata
+
+Monitors Gearman worker statistics. A chart is shown for each job as well as one showing a summary of all workers.
+
+Note: Charts may show as a line graph rather than an area 
+graph if you load Netdata with no jobs running. To change 
+this go to "Settings" > "Which dimensions to show?" and 
+select "All".
+
+Plugin can obtain data from tcp socket **OR** unix socket.
+
+**Requirement:**
+Socket MUST be readable by netdata user.
+
+It produces:
+
+ * Workers queued
+ * Workers idle
+ * Workers running
+
+## Configuration
+
+Edit the `python.d/gearman.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/gearman.conf
+```
+
+```yaml
+localhost:
+  name     : 'local'
+  host     : 'localhost'
+  port     : 4730
+  
+  # TLS information can be provided as well
+  tls      : no
+  cert     : /path/to/cert
+  key      : /path/to/key
+```
+
+When no configuration file is found, module tries to connect to TCP/IP socket: `localhost:4730`.
+
diff --git a/collectors/python.d.plugin/gearman/gearman.chart.py b/collectors/python.d.plugin/gearman/gearman.chart.py
new file mode 100644
index 0000000..5e280a4
--- /dev/null
+++ b/collectors/python.d.plugin/gearman/gearman.chart.py
@@ -0,0 +1,243 @@
+# Description: dovecot netdata python.d module
+# Author: Kyle Agronick (agronick)
+# SPDX-License-Identifier: GPL-3.0+
+
+# Gearman Netdata Plugin
+
+from copy import deepcopy
+
+from bases.FrameworkServices.SocketService import SocketService
+
+CHARTS = {
+    'total_workers': {
+        'options': [None, 'Total Jobs', 'Jobs', 'Total Jobs', 'gearman.total_jobs', 'line'],
+        'lines': [
+            ['total_pending', 'Pending', 'absolute'],
+            ['total_running', 'Running', 'absolute'],
+        ]
+    },
+}
+
+
+def job_chart_template(job_name):
+    return {
+        'options': [None, job_name, 'Jobs', 'Activity by Job', 'gearman.single_job', 'stacked'],
+        'lines': [
+            ['{0}_pending'.format(job_name), 'Pending', 'absolute'],
+            ['{0}_idle'.format(job_name), 'Idle', 'absolute'],
+            ['{0}_running'.format(job_name), 'Running', 'absolute'],
+        ]
+    }
+
+
+def build_result_dict(job):
+    """
+    Get the status for each job
+    :return: dict
+    """
+
+    total, running, available = job['metrics']
+
+    idle = available - running
+    pending = total - running
+
+    return {
+        '{0}_pending'.format(job['job_name']): pending,
+        '{0}_idle'.format(job['job_name']): idle,
+        '{0}_running'.format(job['job_name']): running,
+    }
+
+
+def parse_worker_data(job):
+    job_name = job[0]
+    job_metrics = job[1:]
+
+    return {
+        'job_name': job_name,
+        'metrics': job_metrics,
+    }
+
+
+class GearmanReadException(BaseException):
+    pass
+
+
+class Service(SocketService):
+    def __init__(self, configuration=None, name=None):
+        super(Service, self).__init__(configuration=configuration, name=name)
+        self.request = "status\n"
+        self._keep_alive = True
+
+        self.host = self.configuration.get('host', 'localhost')
+        self.port = self.configuration.get('port', 4730)
+
+        self.tls = self.configuration.get('tls', False)
+        self.cert = self.configuration.get('cert', None)
+        self.key = self.configuration.get('key', None)
+
+        self.active_jobs = set()
+        self.definitions = deepcopy(CHARTS)
+        self.order = ['total_workers']
+
+    def _get_data(self):
+        """
+        Format data received from socket
+        :return: dict
+        """
+
+        try:
+            active_jobs = self.get_active_jobs()
+        except GearmanReadException:
+            return None
+
+        found_jobs, job_data = self.process_jobs(active_jobs)
+        self.remove_stale_jobs(found_jobs)
+        return job_data
+
+    def get_active_jobs(self):
+        active_jobs = []
+
+        for job in self.get_worker_data():
+            parsed_job = parse_worker_data(job)
+
+            # Gearman does not clean up old jobs
+            # We only care about jobs that have
+            # some relevant data
+            if not any(parsed_job['metrics']):
+                continue
+
+            active_jobs.append(parsed_job)
+
+        return active_jobs
+
+    def get_worker_data(self):
+        """
+        Split the data returned from Gearman
+        into a list of lists
+
+        This returns the same output that you
+        would get from a gearadmin --status
+        command.
+
+        Example output returned from
+        _get_raw_data():
+        prefix generic_worker4 78      78      500
+        generic_worker2 78      78      500
+        generic_worker3 0       0       760
+        generic_worker1 0       0       500
+
+        :return: list
+        """
+
+        try:
+            raw = self._get_raw_data()
+        except (ValueError, AttributeError):
+            raise GearmanReadException()
+
+        if raw is None:
+            self.debug("Gearman returned no data")
+            raise GearmanReadException()
+
+        workers = list()
+
+        for line in raw.splitlines()[:-1]:
+            parts = line.split()
+            if not parts:
+                continue
+
+            name = '_'.join(parts[:-3])
+            try:
+                values = [int(w) for w in parts[-3:]]
+            except ValueError:
+                continue
+
+            w = [name]
+            w.extend(values)
+            workers.append(w)
+
+        return workers
+
+    def process_jobs(self, active_jobs):
+
+        output = {
+            'total_pending': 0,
+            'total_idle': 0,
+            'total_running': 0,
+        }
+        found_jobs = set()
+
+        for parsed_job in active_jobs:
+
+            job_name = self.add_job(parsed_job)
+            found_jobs.add(job_name)
+            job_data = build_result_dict(parsed_job)
+
+            for sum_value in ('pending', 'running', 'idle'):
+                output['total_{0}'.format(sum_value)] += job_data['{0}_{1}'.format(job_name, sum_value)]
+
+            output.update(job_data)
+
+        return found_jobs, output
+
+    def remove_stale_jobs(self, active_job_list):
+        """
+        Removes jobs that have no workers, pending jobs,
+        or running jobs
+        :param active_job_list: The latest list of active jobs
+        :type active_job_list: iterable
+        :return: None
+        """
+
+        for to_remove in self.active_jobs - active_job_list:
+            self.remove_job(to_remove)
+
+    def add_job(self, parsed_job):
+        """
+        Adds a job to the list of active jobs
+        :param parsed_job: A parsed job dict
+        :type parsed_job: dict
+        :return: None
+        """
+
+        def add_chart(job_name):
+            """
+            Adds a new job chart
+            :param job_name: The name of the job to add
+            :type job_name: string
+            :return: None
+            """
+
+            job_key = 'job_{0}'.format(job_name)
+            template = job_chart_template(job_name)
+            new_chart = self.charts.add_chart([job_key] + template['options'])
+            for dimension in template['lines']:
+                new_chart.add_dimension(dimension)
+
+        if parsed_job['job_name'] not in self.active_jobs:
+            add_chart(parsed_job['job_name'])
+            self.active_jobs.add(parsed_job['job_name'])
+
+        return parsed_job['job_name']
+
+    def remove_job(self, job_name):
+        """
+        Removes a job to the list of active jobs
+        :param job_name: The name of the job to remove
+        :type job_name: string
+        :return: None
+        """
+
+        def remove_chart(job_name):
+            """
+            Removes a job chart
+            :param job_name: The name of the job to remove
+            :type job_name: string
+            :return: None
+            """
+
+            job_key = 'job_{0}'.format(job_name)
+            self.charts[job_key].obsolete()
+            del self.charts[job_key]
+
+        remove_chart(job_name)
+        self.active_jobs.remove(job_name)
diff --git a/collectors/python.d.plugin/gearman/gearman.conf b/collectors/python.d.plugin/gearman/gearman.conf
new file mode 100644
index 0000000..c41fd9f
--- /dev/null
+++ b/collectors/python.d.plugin/gearman/gearman.conf
@@ -0,0 +1,72 @@
+# netdata python.d.plugin configuration for gearman
+#
+# 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: 1
+
+# 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
+#
+# Additionally to the above, gearman also supports the following:
+#
+#     hostname: localhost     # The host running the Gearman server
+#     port: 4730              # Port of the Gearman server
+# ----------------------------------------------------------------------
+# AUTO-DETECTION JOB
+
+localhost:
+  name     : 'local'
+  host     : 'localhost'
+  port     : 4730
\ No newline at end of file