New upstream version 1.11.0+dfsgupstream/1.11.0+dfsg

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

4 files changed, 320 insertions, 0 deletions

diff --git a/collectors/python.d.plugin/phpfpm/Makefile.inc b/collectors/python.d.plugin/phpfpm/Makefile.inc
new file mode 100644
index 000000000..ff312fe18
--- /dev/null
+++ b/collectors/python.d.plugin/phpfpm/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       += phpfpm/phpfpm.chart.py
+dist_pythonconfig_DATA += phpfpm/phpfpm.conf
+
+# do not install these files, but include them in the distribution
+dist_noinst_DATA       += phpfpm/README.md phpfpm/Makefile.inc
+
diff --git a/collectors/python.d.plugin/phpfpm/README.md b/collectors/python.d.plugin/phpfpm/README.md
new file mode 100644
index 000000000..66930463f
--- /dev/null
+++ b/collectors/python.d.plugin/phpfpm/README.md
@@ -0,0 +1,40 @@
+# phpfpm
+
+This module will monitor one or more php-fpm instances depending on configuration.
+
+**Requirements:**
+ * php-fpm with enabled `status` page
+ * access to `status` page via web server
+
+It produces following charts:
+
+1. **Active Connections**
+ * active
+ * maxActive
+ * idle
+
+2. **Requests** in requests/s
+ * requests
+
+3. **Performance**
+ * reached
+ * slow
+
+### configuration
+
+Needs only `url` to server's `status`
+
+Here is an example for local instance:
+
+```yaml
+update_every : 3
+priority     : 90100
+
+local:
+  url     : 'http://localhost/status'
+  retries : 10
+```
+
+Without configuration, module attempts to connect to `http://localhost/status`
+
+---
diff --git a/collectors/python.d.plugin/phpfpm/phpfpm.chart.py b/collectors/python.d.plugin/phpfpm/phpfpm.chart.py
new file mode 100644
index 000000000..a3f0963fc
--- /dev/null
+++ b/collectors/python.d.plugin/phpfpm/phpfpm.chart.py
@@ -0,0 +1,177 @@
+# -*- coding: utf-8 -*-
+# Description: PHP-FPM netdata python.d module
+# Author: Pawel Krupa (paulfantom)
+# Author: Ilya Mashchenko (l2isbad)
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+import json
+import re
+
+from bases.FrameworkServices.UrlService import UrlService
+
+# default module values (can be overridden per job in `config`)
+# update_every = 2
+priority = 60000
+retries = 60
+
+# default job configuration (overridden by python.d.plugin)
+# config = {'local': {
+#     'update_every': update_every,
+#     'retries': retries,
+#     'priority': priority,
+#     'url': 'http://localhost/status?full&json'
+# }}
+
+# charts order (can be overridden if you want less charts, or different order)
+
+POOL_INFO = [
+    ('active processes', 'active'),
+    ('max active processes', 'maxActive'),
+    ('idle processes', 'idle'),
+    ('accepted conn', 'requests'),
+    ('max children reached', 'reached'),
+    ('slow requests', 'slow')
+]
+
+PER_PROCESS_INFO = [
+    ('request duration', 'ReqDur'),
+    ('last request cpu', 'ReqCpu'),
+    ('last request memory', 'ReqMem')
+]
+
+
+def average(collection):
+    return sum(collection, 0.0) / max(len(collection), 1)
+
+
+CALC = [
+    ('min', min),
+    ('max', max),
+    ('avg', average)
+]
+
+ORDER = ['connections', 'requests', 'performance', 'request_duration', 'request_cpu', 'request_mem']
+
+CHARTS = {
+    'connections': {
+        'options': [None, 'PHP-FPM Active Connections', 'connections', 'active connections', 'phpfpm.connections',
+                    'line'],
+        'lines': [
+            ['active'],
+            ['maxActive', 'max active'],
+            ['idle']
+        ]
+    },
+    'requests': {
+        'options': [None, 'PHP-FPM Requests', 'requests/s', 'requests', 'phpfpm.requests', 'line'],
+        'lines': [
+            ['requests', None, 'incremental']
+        ]
+    },
+    'performance': {
+        'options': [None, 'PHP-FPM Performance', 'status', 'performance', 'phpfpm.performance', 'line'],
+        'lines': [
+            ['reached', 'max children reached'],
+            ['slow', 'slow requests']
+        ]
+    },
+    'request_duration': {
+        'options': [None, 'PHP-FPM Request Duration', 'milliseconds', 'request duration', 'phpfpm.request_duration',
+                    'line'],
+        'lines': [
+            ['minReqDur', 'min', 'absolute', 1, 1000],
+            ['maxReqDur', 'max', 'absolute', 1, 1000],
+            ['avgReqDur', 'avg', 'absolute', 1, 1000]
+        ]
+    },
+    'request_cpu': {
+        'options': [None, 'PHP-FPM Request CPU', 'percent', 'request CPU', 'phpfpm.request_cpu', 'line'],
+        'lines': [
+            ['minReqCpu', 'min'],
+            ['maxReqCpu', 'max'],
+            ['avgReqCpu', 'avg']
+        ]
+    },
+    'request_mem': {
+        'options': [None, 'PHP-FPM Request Memory', 'kilobytes', 'request memory', 'phpfpm.request_mem', 'line'],
+        'lines': [
+            ['minReqMem', 'min', 'absolute', 1, 1024],
+            ['maxReqMem', 'max', 'absolute', 1, 1024],
+            ['avgReqMem', 'avg', 'absolute', 1, 1024]
+        ]
+    }
+}
+
+
+class Service(UrlService):
+    def __init__(self, configuration=None, name=None):
+        UrlService.__init__(self, configuration=configuration, name=name)
+        self.url = self.configuration.get('url', 'http://localhost/status?full&json')
+        self.order = ORDER
+        self.definitions = CHARTS
+        self.regex = re.compile(r'([a-z][a-z ]+): ([\d.]+)')
+        self.json = '&json' in self.url or '?json' in self.url
+        self.json_full = self.url.endswith(('?full&json', '?json&full'))
+        self.if_all_processes_running = dict([(c_name + p_name, 0) for c_name, func in CALC
+                                              for metric, p_name in PER_PROCESS_INFO])
+
+    def _get_data(self):
+        """
+        Format data received from http request
+        :return: dict
+        """
+        raw = self._get_raw_data()
+        if not raw:
+            return None
+
+        raw_json = parse_raw_data_(is_json=self.json, regex=self.regex, raw_data=raw)
+
+        # Per Pool info: active connections, requests and performance charts
+        to_netdata = fetch_data_(raw_data=raw_json, metrics_list=POOL_INFO)
+
+        # Per Process Info: duration, cpu and memory charts (min, max, avg)
+        if self.json_full:
+            p_info = dict()
+            to_netdata.update(self.if_all_processes_running)  # If all processes are in running state
+            # Metrics are always 0 if the process is not in Idle state because calculation is done
+            #  when the request processing has terminated
+            for process in [p for p in raw_json['processes'] if p['state'] == 'Idle']:
+                p_info.update(fetch_data_(raw_data=process, metrics_list=PER_PROCESS_INFO, pid=str(process['pid'])))
+
+            if p_info:
+                for new_name in PER_PROCESS_INFO:
+                    for name, func in CALC:
+                        to_netdata[name + new_name[1]] = func([p_info[k] for k in p_info if new_name[1] in k])
+
+        return to_netdata or None
+
+
+def fetch_data_(raw_data, metrics_list, pid=''):
+    """
+    :param raw_data: dict
+    :param metrics_list: list
+    :param pid: str
+    :return: dict
+    """
+    result = dict()
+    for metric, new_name in metrics_list:
+        if metric in raw_data:
+            result[new_name + pid] = float(raw_data[metric])
+    return result
+
+
+def parse_raw_data_(is_json, regex, raw_data):
+    """
+    :param is_json: bool
+    :param regex: compiled regular expr
+    :param raw_data: dict
+    :return: dict
+    """
+    if is_json:
+        try:
+            return json.loads(raw_data)
+        except ValueError:
+            return dict()
+    else:
+        raw_data = ' '.join(raw_data.split())
+        return dict(regex.findall(raw_data))
diff --git a/collectors/python.d.plugin/phpfpm/phpfpm.conf b/collectors/python.d.plugin/phpfpm/phpfpm.conf
new file mode 100644
index 000000000..571eb9156
--- /dev/null
+++ b/collectors/python.d.plugin/phpfpm/phpfpm.conf
@@ -0,0 +1,90 @@
+# netdata python.d.plugin configuration for PHP-FPM
+#
+# 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
+
+# ----------------------------------------------------------------------
+# 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
+#
+# Additionally to the above, PHP-FPM also supports the following:
+#
+#     url: 'URL'       # the URL to fetch nginx's status stats
+#                      # Be sure and include ?full&status at the end of the url
+#
+# if the URL is password protected, the following are supported:
+#
+#     user: 'username'
+#     pass: 'password'
+#
+
+# ----------------------------------------------------------------------
+# AUTO-DETECTION JOBS
+# only one of them will run (they have the same name)
+
+localhost:
+  name : 'local'
+  url  : "http://localhost/status?full&json"
+
+localipv4:
+  name : 'local'
+  url  : "http://127.0.0.1/status?full&json"
+
+localipv6:
+  name : 'local'
+  url  : "http://[::1]/status?full&json"
+