Merge pull request #156 from Helene/prometheus_endpoints

Enable flexible management of Prometheus endpoints

Author: Helene

source/messages.py

@@ -42,6 +42,7 @@
        'MetricErr': 'Metric {0} cannot be found. Please check if the corresponding sensor is configured',
        'InconsistentParams': 'Received parameters {} inconsistent with request parameters {}',
        'SensorDisabled': 'Sensor for metric {} is disabled',
+       'EndpointNotSupported': 'Endpoint {} you try to access is not supported',
        'NoData': 'Empty results received',  # Please check the pmcollector is properly configured and running.
        'NoSensorConfigData': 'No sensor configuration data parsed',
        'NoDataStartNextAttempt': 'No Metadata results received from the pmcollector. Start retry attempt {} in 60s (MAX_ATTEMPTS_COUNT:{})',

source/prometheus.py

@@ -39,6 +39,7 @@ def __init__(self, logger, mdHandler, port, raw_data=False):
         self.raw_data = raw_data
         self.static_sensors_list = ['CPU', 'Memory', 'GPFSFileset']
         self.cache_strategy = False
+        self.endpoints = {}
         self.caching_collectors = []
         if self.cache_strategy:
             self.initialize_cache_collectors()
@@ -148,260 +149,30 @@ def GET(self, **params):
             raise cherrypy.HTTPError(400, MSG[400])
 
         # /update
-        if 'update' in cherrypy.request.script_name:
+        if '/update' == cherrypy.request.script_name:
             # cherrypy.response.headers['Content-Type'] = 'application/json'
             resp = self.md.update()
 
-        # /metrics_gpfs_disk
-        elif '/metrics_gpfs_disk' == cherrypy.request.script_name:
-            resp = self.metrics(['GPFSDisk'])
-            cherrypy.response.headers['Content-Type'] = 'text/plain'
-            resString = '\n'.join(resp) + '\n'
-            return resString
-
-        # /metrics_gpfs_filesystem
-        elif 'metrics_gpfs_filesystem' in cherrypy.request.script_name:
-            resp = self.metrics(['GPFSFilesystem'])
-            cherrypy.response.headers['Content-Type'] = 'text/plain'
-            resString = '\n'.join(resp) + '\n'
-            return resString
-
-        # /metrics_gpfsnsddisk
-        elif 'metrics_gpfs_nsddisk' in cherrypy.request.script_name:
-            resp = self.metrics(['GPFSNSDDisk'])
-            cherrypy.response.headers['Content-Type'] = 'text/plain'
-            resString = '\n'.join(resp) + '\n'
-            return resString
-
-        # /metrics_gpfs_poolio
-        elif 'metrics_gpfs_poolio' in cherrypy.request.script_name:
-            resp = self.metrics(['GPFSPoolIO'])
-            cherrypy.response.headers['Content-Type'] = 'text/plain'
-            resString = '\n'.join(resp) + '\n'
-            return resString
-
-        # /metrics_gpfs_vfsx
-        elif 'metrics_gpfs_vfsx' in cherrypy.request.script_name:
-            resp = self.metrics(['GPFSVFSX'])
-            cherrypy.response.headers['Content-Type'] = 'text/plain'
-            resString = '\n'.join(resp) + '\n'
-            return resString
-
-        # /metrics_gpfsioc
-        elif 'metrics_gpfsioc' in cherrypy.request.script_name:
-            resp = self.metrics(['GPFSIOC'])
-            cherrypy.response.headers['Content-Type'] = 'text/plain'
-            resString = '\n'.join(resp) + '\n'
-            return resString
-
-        # /metrics_gpfs_vio64
-        elif 'metrics_gpfs_vio64' in cherrypy.request.script_name:
-            resp = self.metrics(['GPFSVIO64'])
-            cherrypy.response.headers['Content-Type'] = 'text/plain'
-            resString = '\n'.join(resp) + '\n'
-            return resString
-
-        # /metrics_gpfs_pddisk
-        elif 'metrics_gpfs_pddisk' in cherrypy.request.script_name:
-            resp = self.metrics(['GPFSPDDisk'])
-            cherrypy.response.headers['Content-Type'] = 'text/plain'
-            resString = '\n'.join(resp) + '\n'
-            return resString
-
-        # /metrics_gpfs_vflush
-        elif 'metrics_gpfs_vflush' in cherrypy.request.script_name:
-            resp = self.metrics(['GPFSvFLUSH'])
-            cherrypy.response.headers['Content-Type'] = 'text/plain'
-            resString = '\n'.join(resp) + '\n'
-            return resString
-
-        # /metrics_gpfs_node
-        elif 'metrics_gpfs_node' in cherrypy.request.script_name:
-            resp = self.metrics(['GPFSNode'])
-            cherrypy.response.headers['Content-Type'] = 'text/plain'
-            resString = '\n'.join(resp) + '\n'
-            return resString
-
-        # /metrics_gpfs_nodeapi
-        elif 'metrics_gpfs_nodeapi' in cherrypy.request.script_name:
-            resp = self.metrics(['GPFSNodeAPI'])
-            cherrypy.response.headers['Content-Type'] = 'text/plain'
-            resString = '\n'.join(resp) + '\n'
-            return resString
-
-        # /metrics_gpfs_filesystemapi
-        elif 'metrics_gpfs_filesystemapi' in cherrypy.request.script_name:
-            resp = self.metrics(['GPFSFilesystemAPI'])
-            cherrypy.response.headers['Content-Type'] = 'text/plain'
-            resString = '\n'.join(resp) + '\n'
-            return resString
-
-        # /metrics_gpfs_lroc
-        elif 'metrics_gpfs_lroc' in cherrypy.request.script_name:
-            resp = self.metrics(['GPFSLROC'])
-            cherrypy.response.headers['Content-Type'] = 'text/plain'
-            resString = '\n'.join(resp) + '\n'
-            return resString
-
-        # /metrics_gpfs_chms
-        elif 'metrics_gpfs_chms' in cherrypy.request.script_name:
-            resp = self.metrics(['GPFSCHMS'])
-            cherrypy.response.headers['Content-Type'] = 'text/plain'
-            resString = '\n'.join(resp) + '\n'
-            return resString
-
-        # /metrics_gpfs_afm
-        elif '/metrics_gpfs_afm' == cherrypy.request.script_name:
-            resp = self.metrics(['GPFSAFM'])
-            cherrypy.response.headers['Content-Type'] = 'text/plain'
-            resString = '\n'.join(resp) + '\n'
-            return resString
-
-        # /metrics_gpfs_afmfs
-        elif '/metrics_gpfs_afmfs' == cherrypy.request.script_name:
-            resp = self.metrics(['GPFSAFMFS'])
-            cherrypy.response.headers['Content-Type'] = 'text/plain'
-            resString = '\n'.join(resp) + '\n'
-            return resString
-
-        # /metrics_gpfs_afmfset
-        elif '/metrics_gpfs_afmfset' == cherrypy.request.script_name:
-            resp = self.metrics(['GPFSAFMFSET'])
-            cherrypy.response.headers['Content-Type'] = 'text/plain'
-            resString = '\n'.join(resp) + '\n'
-            return resString
-
-        # /metrics_gpfs_rpcs
-        elif 'metrics_gpfs_rpcs' in cherrypy.request.script_name:
-            resp = self.metrics(['GPFSRPCS'])
-            cherrypy.response.headers['Content-Type'] = 'text/plain'
-            resString = '\n'.join(resp) + '\n'
-            return resString
-
-        # /metrics_gpfs_filesetquota
-        elif 'metrics_gpfs_filesetquota' in cherrypy.request.script_name:
-            resp = self.metrics(['GPFSFilesetQuota'])
-            cherrypy.response.headers['Content-Type'] = 'text/plain'
-            resString = '\n'.join(resp) + '\n'
-            return resString
-
-        # /metrics_gpfs_fileset
-        elif 'metrics_gpfs_fileset' in cherrypy.request.script_name:
-            resp = self.metrics(['GPFSFileset'])
-            cherrypy.response.headers['Content-Type'] = 'text/plain'
-            resString = '\n'.join(resp) + '\n'
-            return resString
-
-        # /metrics_gpfs_pool
-        elif 'metrics_gpfs_pool' in cherrypy.request.script_name:
-            resp = self.metrics(['GPFSPool'])
-            cherrypy.response.headers['Content-Type'] = 'text/plain'
-            resString = '\n'.join(resp) + '\n'
-            return resString
-
-        # /metrics_gpfs_diskcap
-        elif '/metrics_gpfs_diskcap' == cherrypy.request.script_name:
-            resp = self.metrics(['GPFSDiskCap'])
-            cherrypy.response.headers['Content-Type'] = 'text/plain'
-            resString = '\n'.join(resp) + '\n'
-            return resString
-
-        # /metrics_gpfs_waiters
-        elif 'metrics_gpfs_waiters' in cherrypy.request.script_name:
-            resp = self.metrics(['GPFSWaiters'])
-            cherrypy.response.headers['Content-Type'] = 'text/plain'
-            resString = '\n'.join(resp) + '\n'
-            return resString
-
-        # /metrics_gpfs_event_producer
-        elif 'metrics_gpfs_event_producer' in cherrypy.request.script_name:
-            resp = self.metrics(['GPFSEventProducer'])
-            cherrypy.response.headers['Content-Type'] = 'text/plain'
-            resString = '\n'.join(resp) + '\n'
-            return resString
-
-        # /metrics_gpfs_mutex
-        elif 'metrics_gpfs_mutex' in cherrypy.request.script_name:
-            resp = self.metrics(['GPFSMutex'])
-            cherrypy.response.headers['Content-Type'] = 'text/plain'
-            resString = '\n'.join(resp) + '\n'
-            return resString
-
-        # /metrics_gpfs_condvar
-        elif 'metrics_gpfs_condvar' in cherrypy.request.script_name:
-            resp = self.metrics(['GPFSCondvar'])
-            cherrypy.response.headers['Content-Type'] = 'text/plain'
-            resString = '\n'.join(resp) + '\n'
-            return resString
-
-        # /metrics_gpfs_qos
-        elif 'metrics_gpfs_qos' in cherrypy.request.script_name:
-            resp = self.metrics(['GPFSQoS'])
-            cherrypy.response.headers['Content-Type'] = 'text/plain'
-            resString = '\n'.join(resp) + '\n'
-            return resString
-
-        # /metrics_gpfs_fcm
-        elif 'metrics_gpfs_fcm' in cherrypy.request.script_name:
-            resp = self.metrics(['GPFSFCM'])
-            cherrypy.response.headers['Content-Type'] = 'text/plain'
-            resString = '\n'.join(resp) + '\n'
-            return resString
-
-        # /metrics_nfsio
-        elif 'metrics_nfsio' in cherrypy.request.script_name:
-            resp = self.metrics(['NFSIO'])
-            cherrypy.response.headers['Content-Type'] = 'text/plain'
-            resString = '\n'.join(resp) + '\n'
-            return resString
-
-        # /metrics_smb_stats
-        elif 'metrics_smb_stats' in cherrypy.request.script_name:
-            resp = self.metrics(['SMBStats'])
-            cherrypy.response.headers['Content-Type'] = 'text/plain'
-            resString = '\n'.join(resp) + '\n'
-            return resString
-
-        # /metrics_smb_globalstats
-        elif 'metrics_smb_globalstats' in cherrypy.request.script_name:
-            resp = self.metrics(['SMBGlobalStats'])
-            cherrypy.response.headers['Content-Type'] = 'text/plain'
-            resString = '\n'.join(resp) + '\n'
-            return resString
-
-        # /metrics_ctdb_stats
-        elif 'metrics_ctdb_stats' in cherrypy.request.script_name:
-            resp = self.metrics(['CTDBStats'])
-            cherrypy.response.headers['Content-Type'] = 'text/plain'
-            resString = '\n'.join(resp) + '\n'
-            return resString
-
-        # /metrics_ctdb_dbstats
-        elif 'metrics_ctdb_dbstats' in cherrypy.request.script_name:
-            resp = self.metrics(['CTDBDBStats'])
+        elif self.endpoints and self.endpoints.get(cherrypy.request.script_name,
+                                                   None):
+            sensor = self.endpoints[cherrypy.request.script_name]
+            resp = self.metrics([sensor])
             cherrypy.response.headers['Content-Type'] = 'text/plain'
             resString = '\n'.join(resp) + '\n'
             return resString
 
         # /metrics
-        elif 'metrics' in cherrypy.request.script_name:
+        elif '/metrics' == cherrypy.request.script_name:
             resp = self.metrics()
             cherrypy.response.headers['Content-Type'] = 'text/plain'
             resString = '\n'.join(resp) + '\n'
             return resString
 
-        elif 'aggregators' in cherrypy.request.script_name:
-            resp = ["noop", "sum", "avg", "max", "min", "rate"]
-
-        elif 'config/filters' in cherrypy.request.script_name:
-            supportedFilters = {}
-            filterDesc = {}
-            filterDesc['description'] = '''Accepts an exact value or a regular expressions and matches against
-            values for the given tag. The value can be omitted if the filter is used to specify groupBy on the tag only.'''
-            filterDesc['examples'] = '''node=pm_filter(machine1), node=pm_filter(machine[1-6]), node=pm_filter(m1|m2),
-            node=pm_filter(mac.*), node=pm_filter((?!^z).*)'''
-            supportedFilters['pm_filter'] = filterDesc
-            resp = supportedFilters
+        else:
+            self.logger.error(MSG['EndpointNotSupported'].format(sensor))
+            raise cherrypy.HTTPError(400,
+                                     MSG['EndpointNotSupported'].format(
+                                         cherrypy.request.script_name))
 
         del cherrypy.response.headers['Allow']
         cherrypy.response.headers['Access-Control-Allow-Origin'] = '*'

source/prometheus_endpoints.json

@@ -0,0 +1,33 @@
+{
+    "/metrics_gpfs_disk": "GPFSDisk",
+    "/metrics_gpfs_filesystem": "GPFSFilesystem",
+    "/metrics_gpfs_nsddisk": "GPFSNSDDisk",
+    "/metrics_gpfs_poolio": "GPFSPoolIO",
+    "/metrics_gpfs_vfsx": "GPFSVFSX",
+    "/metrics_gpfsioc": "GPFSIOC",
+    "/metrics_gpfs_vio64": "GPFSVIO64",
+    "/metrics_gpfs_pddisk": "GPFSPDDisk",
+    "/metrics_gpfs_vflush": "GPFSvFLUSH",
+    "/metrics_gpfs_node": "GPFSNode",
+    "/metrics_gpfs_nodeapi": "GPFSNodeAPI",
+    "/metrics_gpfs_filesystemapi": "GPFSFilesystemAPI",
+    "/metrics_gpfs_lroc": "GPFSLROC",
+    "/metrics_gpfs_chms": "GPFSCHMS",
+    "/metrics_gpfs_afm": "GPFSAFM",
+    "/metrics_gpfs_afmfs": "GPFSAFMFS",
+    "/metrics_gpfs_afmfset": "GPFSAFMFSET",
+    "/metrics_gpfs_filesetquota": "GPFSFilesetQuota",
+    "/metrics_gpfs_fileset": "GPFSFileset",
+    "/metrics_gpfs_pool": "GPFSPool",
+    "/metrics_gpfs_diskcap": "GPFSDiskCap",
+    "/metrics_gpfs_event_producer": "GPFSEventProducer",
+    "/metrics_gpfs_mutex": "GPFSMutex",
+    "/metrics_gpfs_condvar": "GPFSCondvar",
+    "/metrics_gpfs_qos": "GPFSQoS",
+    "/metrics_gpfs_fcm": "GPFSFCM",
+    "/metrics_nfsio": "NFSIO",
+    "/metrics_smb_stats": "SMBStats",
+    "/metrics_smb_globalstats": "SMBGlobalStats",
+    "/metrics_ctdb_stats": "CTDBStats",
+    "/metrics_ctdb_dbstats": "CTDBDBStats"
+}