Adding upstream version 1.12.0.upstream/1.12.0upstream

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

4 files changed, 226 insertions, 0 deletions

diff --git a/collectors/python.d.plugin/spigotmc/Makefile.inc b/collectors/python.d.plugin/spigotmc/Makefile.inc
new file mode 100644
index 0000000..f9fa8b6
--- /dev/null
+++ b/collectors/python.d.plugin/spigotmc/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       += spigotmc/spigotmc.chart.py
+dist_pythonconfig_DATA += spigotmc/spigotmc.conf
+
+# do not install these files, but include them in the distribution
+dist_noinst_DATA       += spigotmc/README.md spigotmc/Makefile.inc
+
diff --git a/collectors/python.d.plugin/spigotmc/README.md b/collectors/python.d.plugin/spigotmc/README.md
new file mode 100644
index 0000000..c389305
--- /dev/null
+++ b/collectors/python.d.plugin/spigotmc/README.md
@@ -0,0 +1,24 @@
+# spigotmc
+
+This module does some really basic monitoring for Spigot Minecraft servers.
+
+It provides two charts, one tracking server-side ticks-per-second in
+1, 5 and 15 minute averages, and one tracking the number of currently
+active users.
+
+This is not compatible with Spigot plugins which change the format of
+the data returned by the `tps` or `list` console commands.
+
+### configuration
+
+```yaml
+host: localhost
+port: 25575
+password: pass
+```
+
+By default, a connection to port 25575 on the local system is attempted with an empty password.
+
+---
+
+[![analytics](https://www.google-analytics.com/collect?v=1&aip=1&t=pageview&_s=1&ds=github&dr=https%3A%2F%2Fgithub.com%2Fnetdata%2Fnetdata&dl=https%3A%2F%2Fmy-netdata.io%2Fgithub%2Fcollectors%2Fpython.d.plugin%2Fspigotmc%2FREADME&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)]()
diff --git a/collectors/python.d.plugin/spigotmc/spigotmc.chart.py b/collectors/python.d.plugin/spigotmc/spigotmc.chart.py
new file mode 100644
index 0000000..09674f5
--- /dev/null
+++ b/collectors/python.d.plugin/spigotmc/spigotmc.chart.py
@@ -0,0 +1,123 @@
+# -*- coding: utf-8 -*-
+# Description: spigotmc netdata python.d module
+# Author: Austin S. Hemmelgarn (Ferroin)
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+import socket
+import platform
+
+from bases.FrameworkServices.SimpleService import SimpleService
+
+from third_party import mcrcon
+
+# Update only every 5 seconds because collection takes in excess of
+# 100ms sometimes, and mos tpeople won't care about second-by-second data.
+update_every = 5
+
+PRECISION = 100
+
+ORDER = [
+    'tps',
+    'users',
+]
+
+CHARTS = {
+    'tps': {
+        'options': [None, 'Spigot Ticks Per Second', 'ticks', 'spigotmc', 'spigotmc.tps', 'line'],
+        'lines': [
+            ['tps1', '1 Minute Average', 'absolute', 1, PRECISION],
+            ['tps5', '5 Minute Average', 'absolute', 1, PRECISION],
+            ['tps15', '15 Minute Average', 'absolute', 1, PRECISION]
+        ]
+    },
+    'users': {
+        'options': [None, 'Minecraft Users', 'users', 'spigotmc', 'spigotmc.users', 'area'],
+        'lines': [
+            ['users', 'Users', 'absolute', 1, 1]
+        ]
+    }
+}
+
+
+class Service(SimpleService):
+    def __init__(self, configuration=None, name=None):
+        SimpleService.__init__(self, configuration=configuration, name=name)
+        self.order = ORDER
+        self.definitions = CHARTS
+        self.host = self.configuration.get('host', 'localhost')
+        self.port = self.configuration.get('port', 25575)
+        self.password = self.configuration.get('password', '')
+        self.console = mcrcon.MCRcon()
+        self.alive = True
+
+    def check(self):
+        if platform.system() != 'Linux':
+            self.error('Only supported on Linux.')
+            return False
+        try:
+            self.connect()
+        except (mcrcon.MCRconException, socket.error) as err:
+            self.error('Error connecting.')
+            self.error(repr(err))
+            return False
+        return True
+
+    def connect(self):
+        self.console.connect(self.host, self.port, self.password)
+
+    def reconnect(self):
+        try:
+            try:
+                self.console.disconnect()
+            except mcrcon.MCRconException:
+                pass
+            self.console.connect(self.host, self.port, self.password)
+            self.alive = True
+        except (mcrcon.MCRconException, socket.error) as err:
+            self.error('Error connecting.')
+            self.error(repr(err))
+            return False
+        return True
+
+    def is_alive(self):
+        if (not self.alive) or \
+           self.console.socket.getsockopt(socket.IPPROTO_TCP, socket.TCP_INFO, 0) != 1:
+            return self.reconnect()
+        return True
+
+    def _get_data(self):
+        if not self.is_alive():
+            return None
+        data = {}
+        try:
+            raw = self.console.command('tps')
+            # The above command returns a string that looks like this:
+            # '§6TPS from last 1m, 5m, 15m: §a19.99, §a19.99, §a19.99\n'
+            # The values we care about are the three numbers after the :
+            tmp = raw.split(':')[1].split(',')
+            data['tps1'] = float(tmp[0].lstrip(u' §a*')) * PRECISION
+            data['tps5'] = float(tmp[1].lstrip(u' §a*')) * PRECISION
+            data['tps15'] = float(tmp[2].lstrip(u' §a*').rstrip()) * PRECISION
+        except mcrcon.MCRconException:
+            self.error('Unable to fetch TPS values.')
+        except socket.error:
+            self.error('Connection is dead.')
+            self.alive = False
+            return None
+        except (TypeError, LookupError):
+            self.error('Unable to process TPS values.')
+        try:
+            raw = self.console.command('list')
+            # The above command returns a string that looks like this:
+            # 'There are 0/20 players online:'
+            # We care about the first number here.
+            data['users'] = int(raw.split()[2].split('/')[0])
+        except mcrcon.MCRconException:
+            self.error('Unable to fetch user counts.')
+        except socket.error:
+            self.error('Connection is dead.')
+            self.alive = False
+            return None
+        except (TypeError, LookupError):
+            self.error('Unable to process user counts.')
+        return data
diff --git a/collectors/python.d.plugin/spigotmc/spigotmc.conf b/collectors/python.d.plugin/spigotmc/spigotmc.conf
new file mode 100644
index 0000000..ccb5e26
--- /dev/null
+++ b/collectors/python.d.plugin/spigotmc/spigotmc.conf
@@ -0,0 +1,66 @@
+# netdata python.d.plugin configuration for spigotmc
+#
+# 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
+#
+# In addition to the above, spigotmc supports the following:
+#
+#     host: localhost         # The host to connect to.  Defaults to the local system.
+#     port: 25575             # THe port the remote console is listening on.
+#     password: ''            # The remote console password.  Most be set correctly.