Adding upstream version 1.29.3.upstream/1.29.3upstream

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

4 files changed, 354 insertions, 0 deletions

diff --git a/collectors/python.d.plugin/tomcat/Makefile.inc b/collectors/python.d.plugin/tomcat/Makefile.inc
new file mode 100644
index 0000000..940a783
--- /dev/null
+++ b/collectors/python.d.plugin/tomcat/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       += tomcat/tomcat.chart.py
+dist_pythonconfig_DATA += tomcat/tomcat.conf
+
+# do not install these files, but include them in the distribution
+dist_noinst_DATA       += tomcat/README.md tomcat/Makefile.inc
+
diff --git a/collectors/python.d.plugin/tomcat/README.md b/collectors/python.d.plugin/tomcat/README.md
new file mode 100644
index 0000000..f9f2ffe
--- /dev/null
+++ b/collectors/python.d.plugin/tomcat/README.md
@@ -0,0 +1,53 @@
+<!--
+title: "Apache Tomcat monitoring with Netdata"
+custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/tomcat/README.md
+sidebar_label: "Tomcat"
+-->
+
+# Apache Tomcat monitoring with Netdata
+
+Presents memory utilization of tomcat containers.
+
+Charts:
+
+1.  **Requests** per second
+
+    -   accesses
+
+2.  **Volume** in KB/s
+
+    -   volume
+
+3.  **Threads**
+
+    -   current
+    -   busy
+
+4.  **JVM Free Memory** in MB
+
+    -   jvm
+
+## Configuration
+
+Edit the `python.d/tomcat.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/tomcat.conf
+```
+
+```yaml
+localhost:
+  name : 'local'
+  url  : 'http://127.0.0.1:8080/manager/status?XML=true'
+  user : 'tomcat_username'
+  pass : 'secret_tomcat_password'
+```
+
+Without configuration, module attempts to connect to `http://localhost:8080/manager/status?XML=true`, without any credentials.
+So it will probably fail.
+
+---
+
+[![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%2Ftomcat%2FREADME&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)](<>)
diff --git a/collectors/python.d.plugin/tomcat/tomcat.chart.py b/collectors/python.d.plugin/tomcat/tomcat.chart.py
new file mode 100644
index 0000000..90315f8
--- /dev/null
+++ b/collectors/python.d.plugin/tomcat/tomcat.chart.py
@@ -0,0 +1,199 @@
+# -*- coding: utf-8 -*-
+# Description: tomcat netdata python.d module
+# Author: Pawel Krupa (paulfantom)
+# Author: Wei He (Wing924)
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+import re
+import xml.etree.ElementTree as ET
+
+from bases.FrameworkServices.UrlService import UrlService
+
+MiB = 1 << 20
+
+# Regex fix for Tomcat single quote XML attributes
+# affecting Tomcat < 8.5.24 & 9.0.2 running with Java > 9
+# cf. https://bz.apache.org/bugzilla/show_bug.cgi?id=61603
+single_quote_regex = re.compile(r"='([^']+)'([^']+)''")
+
+ORDER = [
+    'accesses',
+    'bandwidth',
+    'processing_time',
+    'threads',
+    'jvm',
+    'jvm_eden',
+    'jvm_survivor',
+    'jvm_tenured',
+]
+
+CHARTS = {
+    'accesses': {
+        'options': [None, 'Requests', 'requests/s', 'statistics', 'tomcat.accesses', 'area'],
+        'lines': [
+            ['requestCount', 'accesses', 'incremental'],
+            ['errorCount', 'errors', 'incremental'],
+        ]
+    },
+    'bandwidth': {
+        'options': [None, 'Bandwidth', 'KiB/s', 'statistics', 'tomcat.bandwidth', 'area'],
+        'lines': [
+            ['bytesSent', 'sent', 'incremental', 1, 1024],
+            ['bytesReceived', 'received', 'incremental', 1, 1024],
+        ]
+    },
+    'processing_time': {
+        'options': [None, 'processing time', 'seconds', 'statistics', 'tomcat.processing_time', 'area'],
+        'lines': [
+            ['processingTime', 'processing time', 'incremental', 1, 1000]
+        ]
+    },
+    'threads': {
+        'options': [None, 'Threads', 'current threads', 'statistics', 'tomcat.threads', 'area'],
+        'lines': [
+            ['currentThreadCount', 'current', 'absolute'],
+            ['currentThreadsBusy', 'busy', 'absolute']
+        ]
+    },
+    'jvm': {
+        'options': [None, 'JVM Memory Pool Usage', 'MiB', 'memory', 'tomcat.jvm', 'stacked'],
+        'lines': [
+            ['free', 'free', 'absolute', 1, MiB],
+            ['eden_used', 'eden', 'absolute', 1, MiB],
+            ['survivor_used', 'survivor', 'absolute', 1, MiB],
+            ['tenured_used', 'tenured', 'absolute', 1, MiB],
+            ['code_cache_used', 'code cache', 'absolute', 1, MiB],
+            ['compressed_used', 'compressed', 'absolute', 1, MiB],
+            ['metaspace_used', 'metaspace', 'absolute', 1, MiB],
+        ]
+    },
+    'jvm_eden': {
+        'options': [None, 'Eden Memory Usage', 'MiB', 'memory', 'tomcat.jvm_eden', 'area'],
+        'lines': [
+            ['eden_used', 'used', 'absolute', 1, MiB],
+            ['eden_committed', 'committed', 'absolute', 1, MiB],
+            ['eden_max', 'max', 'absolute', 1, MiB]
+        ]
+    },
+    'jvm_survivor': {
+        'options': [None, 'Survivor Memory Usage', 'MiB', 'memory', 'tomcat.jvm_survivor', 'area'],
+        'lines': [
+            ['survivor_used', 'used', 'absolute', 1, MiB],
+            ['survivor_committed', 'committed', 'absolute', 1, MiB],
+            ['survivor_max', 'max', 'absolute', 1, MiB],
+        ]
+    },
+    'jvm_tenured': {
+        'options': [None, 'Tenured Memory Usage', 'MiB', 'memory', 'tomcat.jvm_tenured', 'area'],
+        'lines': [
+            ['tenured_used', 'used', 'absolute', 1, MiB],
+            ['tenured_committed', 'committed', 'absolute', 1, MiB],
+            ['tenured_max', 'max', 'absolute', 1, MiB]
+        ]
+    }
+}
+
+
+class Service(UrlService):
+    def __init__(self, configuration=None, name=None):
+        UrlService.__init__(self, configuration=configuration, name=name)
+        self.order = ORDER
+        self.definitions = CHARTS
+        self.url = self.configuration.get('url', 'http://127.0.0.1:8080/manager/status?XML=true')
+        self.connector_name = self.configuration.get('connector_name', None)
+        self.parse = self.xml_parse
+
+    def xml_parse(self, data):
+        try:
+            return ET.fromstring(data)
+        except ET.ParseError:
+            self.debug('%s is not a valid XML page. Please add "?XML=true" to tomcat status page.' % self.url)
+            return None
+
+    def xml_single_quote_fix_parse(self, data):
+        data = single_quote_regex.sub(r"='\g<1>\g<2>'", data)
+        return self.xml_parse(data)
+
+    def check(self):
+        self._manager = self._build_manager()
+
+        raw_data = self._get_raw_data()
+        if not raw_data:
+            return False
+
+        if single_quote_regex.search(raw_data):
+            self.warning('Tomcat status page is returning invalid single quote XML, please consider upgrading '
+                         'your Tomcat installation. See https://bz.apache.org/bugzilla/show_bug.cgi?id=61603')
+            self.parse = self.xml_single_quote_fix_parse
+
+        return self.parse(raw_data) is not None
+
+    def _get_data(self):
+        """
+        Format data received from http request
+        :return: dict
+        """
+        data = None
+        raw_data = self._get_raw_data()
+        if raw_data:
+            xml = self.parse(raw_data)
+            if xml is None:
+                return None
+
+            data = {}
+
+            jvm = xml.find('jvm')
+
+            connector = None
+            if self.connector_name:
+                for conn in xml.findall('connector'):
+                    if self.connector_name in conn.get('name'):
+                        connector = conn
+                        break
+            else:
+                connector = xml.find('connector')
+
+            memory = jvm.find('memory')
+            data['free'] = memory.get('free')
+            data['total'] = memory.get('total')
+
+            for pool in jvm.findall('memorypool'):
+                name = pool.get('name')
+                if 'Eden Space' in name:
+                    data['eden_used'] = pool.get('usageUsed')
+                    data['eden_committed'] = pool.get('usageCommitted')
+                    data['eden_max'] = pool.get('usageMax')
+                elif 'Survivor Space' in name:
+                    data['survivor_used'] = pool.get('usageUsed')
+                    data['survivor_committed'] = pool.get('usageCommitted')
+                    data['survivor_max'] = pool.get('usageMax')
+                elif 'Tenured Gen' in name or 'Old Gen' in name:
+                    data['tenured_used'] = pool.get('usageUsed')
+                    data['tenured_committed'] = pool.get('usageCommitted')
+                    data['tenured_max'] = pool.get('usageMax')
+                elif name == 'Code Cache':
+                    data['code_cache_used'] = pool.get('usageUsed')
+                    data['code_cache_committed'] = pool.get('usageCommitted')
+                    data['code_cache_max'] = pool.get('usageMax')
+                elif name == 'Compressed':
+                    data['compressed_used'] = pool.get('usageUsed')
+                    data['compressed_committed'] = pool.get('usageCommitted')
+                    data['compressed_max'] = pool.get('usageMax')
+                elif name == 'Metaspace':
+                    data['metaspace_used'] = pool.get('usageUsed')
+                    data['metaspace_committed'] = pool.get('usageCommitted')
+                    data['metaspace_max'] = pool.get('usageMax')
+
+            if connector is not None:
+                thread_info = connector.find('threadInfo')
+                data['currentThreadsBusy'] = thread_info.get('currentThreadsBusy')
+                data['currentThreadCount'] = thread_info.get('currentThreadCount')
+
+                request_info = connector.find('requestInfo')
+                data['processingTime'] = request_info.get('processingTime')
+                data['requestCount'] = request_info.get('requestCount')
+                data['errorCount'] = request_info.get('errorCount')
+                data['bytesReceived'] = request_info.get('bytesReceived')
+                data['bytesSent'] = request_info.get('bytesSent')
+
+        return data or None
diff --git a/collectors/python.d.plugin/tomcat/tomcat.conf b/collectors/python.d.plugin/tomcat/tomcat.conf
new file mode 100644
index 0000000..009591b
--- /dev/null
+++ b/collectors/python.d.plugin/tomcat/tomcat.conf
@@ -0,0 +1,89 @@
+# netdata python.d.plugin configuration for tomcat
+#
+# 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, tomcat also supports the following:
+#
+#     url: 'URL'       # the URL to fetch nginx's status stats
+#
+# if the URL is password protected, the following are supported:
+#
+#     user: 'username'
+#     pass: 'password'
+#
+# if you have multiple connectors, the following are supported:
+#
+#     connector_name: 'ajp-bio-8009' # default is null, which use first connector in status XML
+#
+# ----------------------------------------------------------------------
+# AUTO-DETECTION JOBS
+# only one of them will run (they have the same name)
+
+localhost:
+  name : 'local'
+  url  : 'http://localhost:8080/manager/status?XML=true'
+
+localipv4:
+  name : 'local'
+  url  : 'http://127.0.0.1:8080/manager/status?XML=true'
+
+localipv6:
+  name : 'local'
+  url  : 'http://[::1]:8080/manager/status?XML=true'