New upstream version 1.11.0+dfsgupstream/1.11.0+dfsg

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

4 files changed, 443 insertions, 0 deletions

diff --git a/collectors/python.d.plugin/beanstalk/Makefile.inc b/collectors/python.d.plugin/beanstalk/Makefile.inc
new file mode 100644
index 000000000..4bbb7087d
--- /dev/null
+++ b/collectors/python.d.plugin/beanstalk/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       += beanstalk/beanstalk.chart.py
+dist_pythonconfig_DATA += beanstalk/beanstalk.conf
+
+# do not install these files, but include them in the distribution
+dist_noinst_DATA       += beanstalk/README.md beanstalk/Makefile.inc
+
diff --git a/collectors/python.d.plugin/beanstalk/README.md b/collectors/python.d.plugin/beanstalk/README.md
new file mode 100644
index 000000000..c2d7d5787
--- /dev/null
+++ b/collectors/python.d.plugin/beanstalk/README.md
@@ -0,0 +1,103 @@
+# beanstalk
+
+Module provides server and tube-level statistics:
+
+**Requirements:**
+ * `python-beanstalkc`
+
+**Server statistics:**
+
+1. **Cpu usage** in cpu time
+ * user
+ * system
+
+2. **Jobs rate** in jobs/s
+ * total
+ * timeouts
+
+3. **Connections rate** in connections/s
+ * connections
+
+4. **Commands rate** in commands/s
+ * put
+ * peek
+ * peek-ready
+ * peek-delayed
+ * peek-buried
+ * reserve
+ * use
+ * watch
+ * ignore
+ * delete
+ * release
+ * bury
+ * kick
+ * stats
+ * stats-job
+ * stats-tube
+ * list-tubes
+ * list-tube-used
+ * list-tubes-watched
+ * pause-tube
+
+5. **Current tubes** in tubes
+ * tubes
+
+6. **Current jobs** in jobs
+ * urgent
+ * ready
+ * reserved
+ * delayed
+ * buried
+
+7. **Current connections** in connections
+ * written
+ * producers
+ * workers
+ * waiting
+
+8. **Binlog** in records/s
+ * written
+ * migrated
+
+9. **Uptime** in seconds
+ * uptime
+
+**Per tube statistics:**
+
+1. **Jobs rate** in jobs/s
+ * jobs
+
+2. **Jobs** in jobs
+ * using
+ * ready
+ * reserved
+ * delayed
+ * buried
+
+3. **Connections** in connections
+ * using
+ * waiting
+ * watching
+
+4. **Commands** in commands/s
+ * deletes
+ * pauses
+
+5. **Pause** in seconds
+ * since
+ * left
+
+
+### configuration
+
+Sample:
+
+```yaml
+host         : '127.0.0.1'
+port         : 11300
+```
+
+If no configuration is given, module will attempt to connect to beanstalkd on `127.0.0.1:11300` address
+
+---
diff --git a/collectors/python.d.plugin/beanstalk/beanstalk.chart.py b/collectors/python.d.plugin/beanstalk/beanstalk.chart.py
new file mode 100644
index 000000000..1472b4e1a
--- /dev/null
+++ b/collectors/python.d.plugin/beanstalk/beanstalk.chart.py
@@ -0,0 +1,247 @@
+# -*- coding: utf-8 -*-
+# Description: beanstalk netdata python.d module
+# Author: l2isbad
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+try:
+    import beanstalkc
+    BEANSTALKC = True
+except ImportError:
+    BEANSTALKC = False
+
+from bases.FrameworkServices.SimpleService import SimpleService
+from bases.loaders import safe_load
+
+# default module values (can be overridden per job in `config`)
+# update_every = 2
+priority = 60000
+retries = 60
+
+ORDER = ['cpu_usage', 'jobs_rate', 'connections_rate', 'commands_rate', 'current_tubes', 'current_jobs',
+         'current_connections', 'binlog', 'uptime']
+
+CHARTS = {
+    'cpu_usage': {
+        'options': [None, 'Cpu Usage', 'cpu time', 'server statistics', 'beanstalk.cpu_usage', 'area'],
+        'lines': [
+            ['rusage-utime', 'user', 'incremental'],
+            ['rusage-stime', 'system', 'incremental']
+        ]
+    },
+    'jobs_rate': {
+        'options': [None, 'Jobs Rate', 'jobs/s', 'server statistics', 'beanstalk.jobs_rate', 'line'],
+        'lines': [
+            ['total-jobs', 'total', 'incremental'],
+            ['job-timeouts', 'timeouts', 'incremental']
+        ]
+    },
+    'connections_rate': {
+        'options': [None, 'Connections Rate', 'connections/s', 'server statistics', 'beanstalk.connections_rate',
+                    'area'],
+        'lines': [
+            ['total-connections', 'connections', 'incremental']
+        ]
+    },
+    'commands_rate': {
+        'options': [None, 'Commands Rate', 'commands/s', 'server statistics', 'beanstalk.commands_rate', 'stacked'],
+        'lines': [
+            ['cmd-put', 'put', 'incremental'],
+            ['cmd-peek', 'peek', 'incremental'],
+            ['cmd-peek-ready', 'peek-ready', 'incremental'],
+            ['cmd-peek-delayed', 'peek-delayed', 'incremental'],
+            ['cmd-peek-buried', 'peek-buried', 'incremental'],
+            ['cmd-reserve', 'reserve', 'incremental'],
+            ['cmd-use', 'use', 'incremental'],
+            ['cmd-watch', 'watch', 'incremental'],
+            ['cmd-ignore', 'ignore', 'incremental'],
+            ['cmd-delete', 'delete', 'incremental'],
+            ['cmd-release', 'release', 'incremental'],
+            ['cmd-bury', 'bury', 'incremental'],
+            ['cmd-kick', 'kick', 'incremental'],
+            ['cmd-stats', 'stats', 'incremental'],
+            ['cmd-stats-job', 'stats-job', 'incremental'],
+            ['cmd-stats-tube', 'stats-tube', 'incremental'],
+            ['cmd-list-tubes', 'list-tubes', 'incremental'],
+            ['cmd-list-tube-used', 'list-tube-used', 'incremental'],
+            ['cmd-list-tubes-watched', 'list-tubes-watched', 'incremental'],
+            ['cmd-pause-tube', 'pause-tube', 'incremental']
+        ]
+    },
+    'current_tubes': {
+        'options': [None, 'Current Tubes', 'tubes', 'server statistics', 'beanstalk.current_tubes', 'area'],
+        'lines': [
+            ['current-tubes', 'tubes']
+        ]
+    },
+    'current_jobs': {
+        'options': [None, 'Current Jobs', 'jobs', 'server statistics', 'beanstalk.current_jobs', 'stacked'],
+        'lines': [
+            ['current-jobs-urgent', 'urgent'],
+            ['current-jobs-ready', 'ready'],
+            ['current-jobs-reserved', 'reserved'],
+            ['current-jobs-delayed', 'delayed'],
+            ['current-jobs-buried', 'buried']
+        ]
+    },
+    'current_connections': {
+        'options': [None, 'Current Connections', 'connections', 'server statistics',
+                    'beanstalk.current_connections', 'line'],
+        'lines': [
+            ['current-connections', 'written'],
+            ['current-producers', 'producers'],
+            ['current-workers', 'workers'],
+            ['current-waiting', 'waiting']
+        ]
+    },
+    'binlog': {
+        'options': [None, 'Binlog', 'records/s', 'server statistics', 'beanstalk.binlog', 'line'],
+        'lines': [
+            ['binlog-records-written', 'written', 'incremental'],
+            ['binlog-records-migrated', 'migrated', 'incremental']
+        ]
+    },
+    'uptime': {
+        'options': [None, 'Uptime', 'seconds', 'server statistics', 'beanstalk.uptime', 'line'],
+        'lines': [
+            ['uptime'],
+            ]
+    }
+}
+
+
+def tube_chart_template(name):
+    order = [
+        '{0}_jobs_rate'.format(name),
+        '{0}_jobs'.format(name),
+        '{0}_connections'.format(name),
+        '{0}_commands'.format(name),
+        '{0}_pause'.format(name)
+    ]
+    family = 'tube {0}'.format(name)
+
+    charts = {
+        order[0]: {
+            'options': [None, 'Job Rate', 'jobs/s', family, 'beanstalk.jobs_rate', 'area'],
+            'lines': [
+                ['_'.join([name, 'total-jobs']), 'jobs', 'incremental']
+            ]
+        },
+        order[1]: {
+            'options': [None, 'Jobs', 'jobs', family, 'beanstalk.jobs', 'stacked'],
+            'lines': [
+                ['_'.join([name, 'current-jobs-urgent']), 'urgent'],
+                ['_'.join([name, 'current-jobs-ready']), 'ready'],
+                ['_'.join([name, 'current-jobs-reserved']), 'reserved'],
+                ['_'.join([name, 'current-jobs-delayed']), 'delayed'],
+                ['_'.join([name, 'current-jobs-buried']), 'buried']
+            ]
+        },
+        order[2]: {
+            'options': [None, 'Connections', 'connections', family, 'beanstalk.connections', 'stacked'],
+            'lines': [
+                ['_'.join([name, 'current-using']), 'using'],
+                ['_'.join([name, 'current-waiting']), 'waiting'],
+                ['_'.join([name, 'current-watching']), 'watching']
+            ]
+        },
+        order[3]: {
+            'options': [None, 'Commands', 'commands/s', family, 'beanstalk.commands', 'stacked'],
+            'lines': [
+                ['_'.join([name, 'cmd-delete']), 'deletes', 'incremental'],
+                ['_'.join([name, 'cmd-pause-tube']), 'pauses', 'incremental']
+            ]
+        },
+        order[4]: {
+            'options': [None, 'Pause', 'seconds', family, 'beanstalk.pause', 'stacked'],
+            'lines': [
+                ['_'.join([name, 'pause']), 'since'],
+                ['_'.join([name, 'pause-time-left']), 'left']
+            ]
+        }
+    }
+
+    return order, charts
+
+
+class Service(SimpleService):
+    def __init__(self, configuration=None, name=None):
+        SimpleService.__init__(self, configuration=configuration, name=name)
+        self.configuration = configuration
+        self.order = list(ORDER)
+        self.definitions = dict(CHARTS)
+        self.conn = None
+        self.alive = True
+
+    def check(self):
+        if not BEANSTALKC:
+            self.error("'beanstalkc' module is needed to use beanstalk.chart.py")
+            return False
+
+        self.conn = self.connect()
+
+        return True if self.conn else False
+
+    def get_data(self):
+        """
+        :return: dict
+        """
+        if not self.is_alive():
+            return None
+
+        active_charts = self.charts.active_charts()
+        data = dict()
+
+        try:
+            data.update(self.conn.stats())
+
+            for tube in self.conn.tubes():
+                stats = self.conn.stats_tube(tube)
+
+                if tube + '_jobs_rate' not in active_charts:
+                    self.create_new_tube_charts(tube)
+
+                for stat in stats:
+                    data['_'.join([tube, stat])] = stats[stat]
+
+        except beanstalkc.SocketError:
+            self.alive = False
+            return None
+
+        return data or None
+
+    def create_new_tube_charts(self, tube):
+        order, charts = tube_chart_template(tube)
+
+        for chart_name in order:
+            params = [chart_name] + charts[chart_name]['options']
+            dimensions = charts[chart_name]['lines']
+
+            new_chart = self.charts.add_chart(params)
+            for dimension in dimensions:
+                new_chart.add_dimension(dimension)
+
+    def connect(self):
+        host = self.configuration.get('host', '127.0.0.1')
+        port = self.configuration.get('port', 11300)
+        timeout = self.configuration.get('timeout', 1)
+        try:
+            return beanstalkc.Connection(host=host,
+                                         port=port,
+                                         connect_timeout=timeout,
+                                         parse_yaml=safe_load)
+        except beanstalkc.SocketError as error:
+            self.error('Connection to {0}:{1} failed: {2}'.format(host, port, error))
+            return None
+
+    def reconnect(self):
+        try:
+            self.conn.reconnect()
+            self.alive = True
+            return True
+        except beanstalkc.SocketError:
+            return False
+
+    def is_alive(self):
+        if not self.alive:
+            return self.reconnect()
+        return True
diff --git a/collectors/python.d.plugin/beanstalk/beanstalk.conf b/collectors/python.d.plugin/beanstalk/beanstalk.conf
new file mode 100644
index 000000000..940801877
--- /dev/null
+++ b/collectors/python.d.plugin/beanstalk/beanstalk.conf
@@ -0,0 +1,80 @@
+# netdata python.d.plugin configuration for beanstalk
+#
+# 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
+
+# retries sets the number of retries to be made in case of failures.
+# If unset, the default for python.d.plugin is used.
+# Attempts to restore the service are made once every update_every
+# and only if the module has collected values in the past.
+# retries: 60
+
+# 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
+
+# chart_cleanup sets the default chart cleanup interval in iterations.
+# A chart is marked as obsolete if it has not been updated
+# 'chart_cleanup' iterations in a row.
+# When a plugin sends the obsolete flag, the charts are not deleted
+# from netdata immediately.
+# They will be hidden immediately (not offered to dashboard viewer,
+# streamed upstream and archived to backends) and deleted one hour
+# later (configurable from netdata.conf).
+# chart_cleanup: 10
+
+# ----------------------------------------------------------------------
+# 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
+#     retries: 60             # the JOB's number of restoration attempts
+#     autodetection_retry: 0  # the JOB's re-check interval in seconds
+#     chart_cleanup: 10       # the JOB's chart cleanup interval in iterations
+#
+# Additionally to the above, apache also supports the following:
+#
+#     host: 'host'       # Server ip address or hostname. Default: 127.0.0.1
+#     port: port         # Beanstalkd port. Default:
+#
+# ----------------------------------------------------------------------