Adding upstream version 1.29.3.upstream/1.29.3upstream

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

4 files changed, 361 insertions, 0 deletions

diff --git a/collectors/python.d.plugin/squid/Makefile.inc b/collectors/python.d.plugin/squid/Makefile.inc
new file mode 100644
index 0000000..76ecff8
--- /dev/null
+++ b/collectors/python.d.plugin/squid/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       += squid/squid.chart.py
+dist_pythonconfig_DATA += squid/squid.conf
+
+# do not install these files, but include them in the distribution
+dist_noinst_DATA       += squid/README.md squid/Makefile.inc
+
diff --git a/collectors/python.d.plugin/squid/README.md b/collectors/python.d.plugin/squid/README.md
new file mode 100644
index 0000000..e3ed4e0
--- /dev/null
+++ b/collectors/python.d.plugin/squid/README.md
@@ -0,0 +1,58 @@
+<!--
+title: "Squid monitoring with Netdata"
+custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/squid/README.md
+sidebar_label: "Squid"
+-->
+
+# Squid monitoring with Netdata
+
+Monitors one or more squid instances depending on configuration.
+
+It produces following charts:
+
+1.  **Client Bandwidth** in kilobits/s
+
+    -   in
+    -   out
+    -   hits
+
+2.  **Client Requests** in requests/s
+
+    -   requests
+    -   hits
+    -   errors
+
+3.  **Server Bandwidth** in kilobits/s
+
+    -   in
+    -   out
+
+4.  **Server Requests** in requests/s
+
+    -   requests
+    -   errors
+
+## Configuration
+
+Edit the `python.d/squid.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/squid.conf
+```
+
+```yaml
+priority     : 50000
+
+local:
+  request : 'cache_object://localhost:3128/counters'
+  host    : 'localhost'
+  port    : 3128
+```
+
+Without any configuration module will try to autodetect where squid presents its `counters` data
+
+---
+
+[![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%2Fsquid%2FREADME&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)](<>)
diff --git a/collectors/python.d.plugin/squid/squid.chart.py b/collectors/python.d.plugin/squid/squid.chart.py
new file mode 100644
index 0000000..bcae2d8
--- /dev/null
+++ b/collectors/python.d.plugin/squid/squid.chart.py
@@ -0,0 +1,123 @@
+# -*- coding: utf-8 -*-
+# Description: squid netdata python.d module
+# Author: Pawel Krupa (paulfantom)
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+from bases.FrameworkServices.SocketService import SocketService
+
+ORDER = [
+    'clients_net',
+    'clients_requests',
+    'servers_net',
+    'servers_requests',
+]
+
+CHARTS = {
+    'clients_net': {
+        'options': [None, 'Squid Client Bandwidth', 'kilobits/s', 'clients', 'squid.clients_net', 'area'],
+        'lines': [
+            ['client_http_kbytes_in', 'in', 'incremental', 8, 1],
+            ['client_http_kbytes_out', 'out', 'incremental', -8, 1],
+            ['client_http_hit_kbytes_out', 'hits', 'incremental', -8, 1]
+        ]
+    },
+    'clients_requests': {
+        'options': [None, 'Squid Client Requests', 'requests/s', 'clients', 'squid.clients_requests', 'line'],
+        'lines': [
+            ['client_http_requests', 'requests', 'incremental'],
+            ['client_http_hits', 'hits', 'incremental'],
+            ['client_http_errors', 'errors', 'incremental', -1, 1]
+        ]
+    },
+    'servers_net': {
+        'options': [None, 'Squid Server Bandwidth', 'kilobits/s', 'servers', 'squid.servers_net', 'area'],
+        'lines': [
+            ['server_all_kbytes_in', 'in', 'incremental', 8, 1],
+            ['server_all_kbytes_out', 'out', 'incremental', -8, 1]
+        ]
+    },
+    'servers_requests': {
+        'options': [None, 'Squid Server Requests', 'requests/s', 'servers', 'squid.servers_requests', 'line'],
+        'lines': [
+            ['server_all_requests', 'requests', 'incremental'],
+            ['server_all_errors', 'errors', 'incremental', -1, 1]
+        ]
+    }
+}
+
+
+class Service(SocketService):
+    def __init__(self, configuration=None, name=None):
+        SocketService.__init__(self, configuration=configuration, name=name)
+        self._keep_alive = True
+        self.request = ''
+        self.host = 'localhost'
+        self.port = 3128
+        self.order = ORDER
+        self.definitions = CHARTS
+
+    def _get_data(self):
+        """
+        Get data via http request
+        :return: dict
+        """
+        response = self._get_raw_data()
+
+        data = dict()
+        try:
+            raw = ''
+            for tmp in response.split('\r\n'):
+                if tmp.startswith('sample_time'):
+                    raw = tmp
+                    break
+
+            if raw.startswith('<'):
+                self.error('invalid data received')
+                return None
+
+            for row in raw.split('\n'):
+                if row.startswith(('client', 'server.all')):
+                    tmp = row.split('=')
+                    data[tmp[0].replace('.', '_').strip(' ')] = int(tmp[1])
+
+        except (ValueError, AttributeError, TypeError):
+            self.error('invalid data received')
+            return None
+
+        if not data:
+            self.error('no data received')
+            return None
+        return data
+
+    def _check_raw_data(self, data):
+        header = data[:1024].lower()
+
+        if 'connection: keep-alive' in header:
+            self._keep_alive = True
+        else:
+            self._keep_alive = False
+
+        if data[-7:] == '\r\n0\r\n\r\n' and 'transfer-encoding: chunked' in header:  # HTTP/1.1 response
+            self.debug('received full response from squid')
+            return True
+
+        self.debug('waiting more data from squid')
+        return False
+
+    def check(self):
+        """
+        Parse essential configuration, autodetect squid configuration (if needed), and check if data is available
+        :return: boolean
+        """
+        self._parse_config()
+        # format request
+        req = self.request.decode()
+        if not req.startswith('GET'):
+            req = 'GET ' + req
+        if not req.endswith(' HTTP/1.1\r\n\r\n'):
+            req += ' HTTP/1.1\r\n\r\n'
+        self.request = req.encode()
+        if self._get_data() is not None:
+            return True
+        else:
+            return False
diff --git a/collectors/python.d.plugin/squid/squid.conf b/collectors/python.d.plugin/squid/squid.conf
new file mode 100644
index 0000000..b90a52c
--- /dev/null
+++ b/collectors/python.d.plugin/squid/squid.conf
@@ -0,0 +1,167 @@
+# netdata python.d.plugin configuration for squid
+#
+# 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, squid also supports the following:
+#
+#     host   : 'IP or HOSTNAME' # the host to connect to
+#     port   : PORT             # the port to connect to
+#     request: 'URL'            # the URL to request from squid
+#
+
+# ----------------------------------------------------------------------
+# SQUID CONFIGURATION
+#
+# See:
+# http://wiki.squid-cache.org/Features/CacheManager
+#
+# In short, add to your squid configuration these:
+#
+# http_access allow localhost manager
+# http_access deny manager
+#
+# To remotely monitor a squid:
+#
+# acl managerAdmin src 192.0.2.1
+# http_access allow localhost manager
+# http_access allow managerAdmin manager
+# http_access deny manager
+#
+
+# ----------------------------------------------------------------------
+# AUTO-DETECTION JOBS
+# only one of them will run (they have the same name)
+
+tcp3128old:
+  name     : 'local'
+  host     : 'localhost'
+  port     : 3128
+  request  : 'cache_object://localhost:3128/counters'
+
+tcp8080old:
+  name     : 'local'
+  host     : 'localhost'
+  port     : 8080
+  request  : 'cache_object://localhost:3128/counters'
+
+tcp3128new:
+  name     : 'local'
+  host     : 'localhost'
+  port     : 3128
+  request  : '/squid-internal-mgr/counters'
+
+tcp8080new:
+  name     : 'local'
+  host     : 'localhost'
+  port     : 8080
+  request  : '/squid-internal-mgr/counters'
+
+# IPv4
+
+tcp3128oldipv4:
+  name     : 'local'
+  host     : '127.0.0.1'
+  port     : 3128
+  request  : 'cache_object://127.0.0.1:3128/counters'
+
+tcp8080oldipv4:
+  name     : 'local'
+  host     : '127.0.0.1'
+  port     : 8080
+  request  : 'cache_object://127.0.0.1:3128/counters'
+
+tcp3128newipv4:
+  name     : 'local'
+  host     : '127.0.0.1'
+  port     : 3128
+  request  : '/squid-internal-mgr/counters'
+
+tcp8080newipv4:
+  name     : 'local'
+  host     : '127.0.0.1'
+  port     : 8080
+  request  : '/squid-internal-mgr/counters'
+
+# IPv6
+
+tcp3128oldipv6:
+  name     : 'local'
+  host     : '::1'
+  port     : 3128
+  request  : 'cache_object://[::1]:3128/counters'
+
+tcp8080oldipv6:
+  name     : 'local'
+  host     : '::1'
+  port     : 8080
+  request  : 'cache_object://[::1]:3128/counters'
+
+tcp3128newipv6:
+  name     : 'local'
+  host     : '::1'
+  port     : 3128
+  request  : '/squid-internal-mgr/counters'
+
+tcp8080newipv6:
+  name     : 'local'
+  host     : '::1'
+  port     : 8080
+  request  : '/squid-internal-mgr/counters'
+