Metrics Improvements (Part 1) (#72)

* Refactor the Metrics Classes
* Update Metrics Documentation
* Add basic metrics tests
* Add InfluxDB metrics class

Author: barryorourke

CHANGELOG.md

@@ -4,8 +4,15 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 This CHANGELOG follows the format listed [here](https://github.com/sensu-plugins/community/blob/master/HOW_WE_CHANGELOG.md)
 
 # [Unreleased]
+### Added
+
+- Add new class SensuPluginMetricsGeneric, this will be extended in future to act in a similar way to its Ruby counterpart. (@borourke) 
+- Added a new class SensuPluginMetricInfluxdb, which outputs the results in influxdb line format. (@borourke)
+- Add basic tests for the Metrics classes. (@borourke)
+
 ### Fixed
 
+- Refactor metrics classes, they should now function properly when passed an exception, empty status or a status message. (@borourke)
 - Update tests so that they run with pytest > 4.0. (@borourke)
 
 # [0.7.1]

README.md

@@ -72,42 +72,56 @@ The check submits the check in json format.  Arbitrary extra fields can be added
 
 ## Metrics
 
-### JSON
+For a metric you can subclass one of the following;
 
-    from sensu_plugin import SensuPluginMetricJSON
+* SensuPluginMetricGraphite
+* SensuPluginMetricInfluxdb
+* SensuPluginMetricJSON
+* SensuPluginMetricStatsd
+
+### Graphite
 
-    class FooBarBazMetricJSON(SensuPluginMetricJSON):
+    from sensu_plugin import SensuPluginMetricGraphite
+
+    class MyGraphiteMetric (SensuPluginMetricGraphite):
         def run(self):
-            self.ok({'foo': 1, 'bar': { 'baz': 'stuff' } })
+            self.ok('sensu', 1)
 
     if __name__ == "__main__":
-    f = FooBarBazMetricJSON()
+        metric = MyGraphiteMetric()
 
-### Graphite
+### Influxdb
 
-    from sensu_plugin import SensuPluginMetricGraphite
+    from sensu_plugin import SensuPluginMetricInfluxdb
+
+    class MyInfluxdbMetric (SensuPluginMetricInfluxdb):
+        def run(self):
+            self.ok('sensu', 'baz=42', 'env=prod,location=us-midwest')
+
+    if __name__ == "__main__":
+        metric = MyInfluxdbMetric()
+
+### JSON
+
+    from sensu_plugin import SensuPluginMetricJSON
 
-    class FooBarBazMetricGraphite(SensuPluginMetricGraphite):
+    class MyJSONMetric(OLDSensuPluginMetricJSON):
         def run(self):
-            self.output('a', 1)
-            self.output('b', 2)
-            self.ok()
+            self.ok({'foo': 1, 'bar': 'anything'})
 
     if __name__ == "__main__":
-    f = FooBarBazMetricGraphite()
+        metric = MyJSONMetric()
 
 ### StatsD
 
     from sensu_plugin import SensuPluginMetricStatsd
 
-    class FooBarBazMetricStatsd(SensuPluginMetricStatsd):
+    class MyStatsdMetric(SensuPluginMetricStatsd):
         def run(self):
-            self.output('a', 1, 'ms')
-            self.output('b.c.d', 15)
-            self.ok()
+            self.ok('sensu.baz', 42, 'g')
 
     if __name__ == "__main__":
-    f = FooBarBazMetricStatsd()
+        metric = MyStatsdMetric()
 
 ## License
 

pylint.rc

@@ -42,7 +42,7 @@ load-plugins=
 #    W0221: arguments-differ
 # BOR-TODO: look into W0211 more
 # BOR-TODO: remove R0205 when we drop python 2.7 support
-disable=E1101,R0201,W0212,C0111,R0903,E0602,R0204,W0221,R0205,R0912,R0801
+disable=E1101,R0201,W0212,C0111,R0903,E0602,R0204,W0221,R0205,R0912,R0801,inconsistent-return-statements
 
 
 

sensu_plugin/__init__.py

@@ -1,8 +1,10 @@
 """This module provides helpers for writing Sensu plugins"""
 from sensu_plugin.plugin import SensuPlugin
 from sensu_plugin.check import SensuPluginCheck
-from sensu_plugin.metric import SensuPluginMetricJSON
+from sensu_plugin.metric import SensuPluginMetricGeneric
 from sensu_plugin.metric import SensuPluginMetricGraphite
+from sensu_plugin.metric import SensuPluginMetricInfluxdb
+from sensu_plugin.metric import SensuPluginMetricJSON
 from sensu_plugin.metric import SensuPluginMetricStatsd
 from sensu_plugin.handler import SensuHandler
 import sensu_plugin.pushevent

sensu_plugin/metric.py

@@ -13,40 +13,80 @@
 from sensu_plugin.compat import compat_basestring
 
 
-class SensuPluginMetricJSON(SensuPlugin):
+class SensuPluginMetricGeneric(SensuPlugin):
+    def sanitise_arguments(self, args):
+        # check whether the arguments have been passed by a dynamic status code
+        # or if the output method is being called directly
+        # extract the required tuple if called using dynamic function
+        if len(args) == 1 and isinstance(args[0], tuple):
+            args = args[0]
+        # check to see whether output is running after being called by an empty
+        # dynamic function.
+        if args[0] is None:
+            pass
+        # check to see whether output is running after being called by a
+        # dynamic whilst containing a message.
+        elif isinstance(args[0], Exception) or len(args) == 1:
+            print(args[0])
+        else:
+            return args
+
+
+class SensuPluginMetricGraphite(SensuPluginMetricGeneric):
+    def output(self, *args):
+        # sanitise the arguments
+        args = self.sanitise_arguments(args)
+        if args:
+            # convert the arguments to a list
+            args = list(args)
+            # add the timestamp if required
+            if len(args) < 3:
+                args.append(None)
+            if args[2] is None:
+                args[2] = (int(time.time()))
+            # produce the output
+            print(" ".join(str(s) for s in args[0:3]))
+
+
+class SensuPluginMetricInfluxdb(SensuPluginMetricGeneric):
+    def output(self, *args):
+        # sanitise the arguments
+        args = self.sanitise_arguments(args)
+        if args:
+            # determine whether a single value has been passed
+            # as fields and if so give it a name.
+            fields = args[1]
+            if fields.isdigit():
+                fields = "value={}".format(args[1])
+            # append tags on to the measurement name if they exist
+            measurement = args[0]
+            if len(args) > 2:
+                measurement = "{},{}".format(args[0], args[2])
+            # create a timestamp
+            timestamp = int(time.time())
+            # produce the output
+            print("{} {} {}".format(measurement, fields, timestamp))
+
+
+class SensuPluginMetricJSON(SensuPluginMetricGeneric):
     def output(self, args):
         obj = args[0]
         if isinstance(obj, (Exception, compat_basestring)):
-            print(obj)
+            print(obj[0])
         elif isinstance(obj, (dict, list)):
             print(json.dumps(obj))
 
 
-class SensuPluginMetricGraphite(SensuPlugin):
-    def output(self, *args):
-        if args[0] is None:
-            print()
-        elif isinstance(args[0], Exception) or args[1] is None:
-            print(args[0])
-        else:
-            l_args = list(args)
-            if len(l_args) < 3:
-                l_args.append(None)
-            if l_args[2] is None:
-                l_args[2] = int(time.time())
-            print("\t".join(str(s) for s in l_args[0:3]))
-
-
-class SensuPluginMetricStatsd(SensuPlugin):
+class SensuPluginMetricStatsd(SensuPluginMetricGeneric):
     def output(self, *args):
-        if args[0] is None:
-            print()
-        elif isinstance(args[0], Exception) or args[1] is None:
-            print(args[0])
-        else:
-            l_args = list(args)
-            if len(l_args) < 3 or l_args[2] is None:
+        # sanitise the arguments
+        args = self.sanitise_arguments(args)
+        if args:
+            # convert the arguments to a list
+            args = list(args)
+            if len(args) < 3 or args[2] is None:
                 stype = 'kv'
             else:
-                stype = l_args[2]
-            print("|".join([":".join(str(s) for s in l_args[0:2]), stype]))
+                stype = args[2]
+            # produce the output
+            print("|".join([":".join(str(s) for s in args[0:2]), stype]))

sensu_plugin/tests/test_metric.py

@@ -0,0 +1,104 @@
+import json
+
+from sensu_plugin import SensuPluginMetricGraphite
+from sensu_plugin import SensuPluginMetricInfluxdb
+from sensu_plugin import SensuPluginMetricJSON
+from sensu_plugin import SensuPluginMetricStatsd
+
+try:
+    from unittest.mock import Mock, patch
+except ImportError:
+    from mock import Mock, patch
+
+try:
+    from StringIO import StringIO
+except ImportError:
+    from io import StringIO
+
+
+class TestSensuPluginMetricGraphite(object):
+    def __init__(self):
+        self.sensu_plugin_metric = None
+
+    def setup(self):
+        '''
+        Instantiate a fresh SensuPluginMetricGraphite before each test.
+        '''
+        self.sensu_plugin_metric = SensuPluginMetricGraphite(autorun=False)
+
+    @patch('sensu_plugin.plugin.sys.exit', Mock())
+    @patch('sys.stdout', new_callable=StringIO)
+    def test_output_ok(self, out):
+        self.sensu_plugin_metric.ok('sensu', 1)
+        output = out.getvalue().split()
+        assert output[0] == 'sensu'
+        assert output[1] == '1'
+
+
+class TestSensuPluginMetricInfluxdb(object):
+    def __init__(self):
+        self.sensu_plugin_metric = None
+
+    def setup(self):
+        '''
+        Instantiate a fresh SensuPluginMetricInfluxdb before each test.
+        '''
+        self.sensu_plugin_metric = SensuPluginMetricInfluxdb(autorun=False)
+
+    @patch('sensu_plugin.plugin.sys.exit', Mock())
+    @patch('sys.stdout', new_callable=StringIO)
+    def test_output_ok(self, out):
+        self.sensu_plugin_metric.ok('sensu', 'baz=42',
+                                    'env=prod,location=us-midwest')
+        output = out.getvalue().split()
+        assert output[0] == 'sensu,env=prod,location=us-midwest'
+        assert output[1] == 'baz=42'
+
+    @patch('sensu_plugin.plugin.sys.exit', Mock())
+    @patch('sys.stdout', new_callable=StringIO)
+    def test_output_ok_no_key(self, out):
+        self.sensu_plugin_metric.ok('sensu', '42',
+                                    'env=prod,location=us-midwest')
+        output = out.getvalue().split()
+        assert output[0] == 'sensu,env=prod,location=us-midwest'
+        assert output[1] == 'value=42'
+
+
+class TestSensuPluginMetricJSON(object):
+    def __init__(self):
+        self.sensu_plugin_metric = None
+
+    def setup(self):
+        '''
+        Instantiate a fresh SensuPluginMetricJSON before each test.
+        '''
+        self.sensu_plugin_metric = SensuPluginMetricJSON(autorun=False)
+
+    @patch('sensu_plugin.plugin.sys.exit', Mock())
+    @patch('sys.stdout', new_callable=StringIO)
+    def test_output_ok(self, out):
+        self.sensu_plugin_metric.ok({'foo': 1, 'bar': 'anything'})
+        assert json.loads(out.getvalue())
+
+
+class TestSensuPluginMetricStatsd(object):
+    def __init__(self):
+        self.sensu_plugin_metric = None
+
+    def setup(self):
+        '''
+        Instantiate a fresh SensuPluginMetricStatsd before each test.
+        '''
+        self.sensu_plugin_metric = SensuPluginMetricStatsd(autorun=False)
+
+    @patch('sensu_plugin.plugin.sys.exit', Mock())
+    @patch('sys.stdout', new_callable=StringIO)
+    def test_output_ok(self, out):
+        self.sensu_plugin_metric.ok('sensu.baz', 42, 'g')
+        assert out.getvalue() == "sensu.baz:42|g\n"
+
+    @patch('sensu_plugin.plugin.sys.exit', Mock())
+    @patch('sys.stdout', new_callable=StringIO)
+    def test_output_ok_two(self, out):
+        self.sensu_plugin_metric.ok('sensu.baz', 42)
+        assert out.getvalue() == "sensu.baz:42|kv\n"