]> arthur.barton.de Git - netdata.git/blobdiff - python.d/phpfpm.chart.py
rename chart fields to avoid conflicts with backends; fixes #1962
[netdata.git] / python.d / phpfpm.chart.py
old mode 100755 (executable)
new mode 100644 (file)
index 31bd2fd..7a98352
 # -*- coding: utf-8 -*-
-# Description: PHP-FPM netdata python.d plugin
+# Description: PHP-FPM netdata python.d module
 # Author: Pawel Krupa (paulfantom)
 
 from base import UrlService
+import json
+import re
 
 # default module values (can be overridden per job in `config`)
 # update_every = 2
-priority = 60000
-# retries = 5
+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'
+#     'url': 'http://localhost/status?full&json'
 # }}
 
 # charts order (can be overridden if you want less charts, or different order)
-ORDER = ['connections', 'requests', 'performance']
+
+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': "'' 'PHP-FPM Active Connections' 'connections' phpfpm phpfpm.connections line",
+        'options': [None, 'PHP-FPM Active Connections', 'connections', 'active connections', 'phpfpm.connections',
+                    'line'],
         'lines': [
-            {"name": "active",
-             "options": "'' absolute 1 1"},
-            {"name": "maxActive",
-             "options": "'max active' absolute 1 1"},
-            {"name": "idle",
-             "options": "'' absolute 1 1"}
+            ['active'],
+            ['maxActive', 'max active'],
+            ['idle']
         ]},
     'requests': {
-        'options': "'' 'PHP-FPM Requests' 'requests/s' phpfpm phpfpm.requests line",
+        'options': [None, 'PHP-FPM Requests', 'requests/s', 'requests', 'phpfpm.requests', 'line'],
         'lines': [
-            {"name": "requests",
-             "options": "'' incremental 1 1"}
+            ['requests', None, 'incremental']
         ]},
     'performance': {
-
-        'options': "'' 'PHP-FPM Performance' 'status' phpfpm phpfpm.performance line",
+        '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': [
-            {"name": "reached",
-             "options": "'max children reached' absolute 1 1"},
-            {"name": "slow",
-             "options": "'slow requests' absolute 1 1"}
+            ['minReqMem', 'min', 'absolute', 1, 1024],
+            ['maxReqMem', 'max', 'absolute', 1, 1024],
+            ['avgReqMem', 'avg', 'absolute', 1, 1024]
         ]}
 }
 
 
 class Service(UrlService):
-    url = "http://localhost/status"
-    order = ORDER
-    charts = CHARTS
-    assignment = {"active processes": 'active',
-                  "max active processes": 'maxActive',
-                  "idle processes": 'idle',
-                  "accepted conn": 'requests',
-                  "max children reached": 'reached',
-                  "slow requests": 'slow'}
-
-    def _formatted_data(self):
+    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_data().split('\n')
-        data = {}
-        for row in raw:
-            tmp = row.split(":")
-            if str(tmp[0]) in self.assignment:
-                try:
-                    data[self.assignment[tmp[0]]] = int(tmp[1])
-                except (IndexError, ValueError) as a:
-                    pass
-        return data
+        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, function in CALC:
+                        to_netdata[name + new_name[1]] = function([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))
+