Merge lp:~lucio.torre/txstatsd/sli-add-size into lp:txstatsd

[Lucio Torre]

add sli size

Add size to sli reporting:

from the client side now you can do:
metrics.sli(path, duration, size) to report multi items slis or just
metrics.sli(path, duration) for single items or
metric.sli_error(path) for errors.

from the txstatsd side ive added the error counter and below and above now also take the optional slope value.

So,
 path => label IF below 5 2
means:
 label incoming metrics from path `path` with label `label` if duration < 5 + 2 * size

[Facundo Batista (facundo)]

Like it

review: Approve

=== modified file 'twisted/plugins/sli_plugin.py'
--- twisted/plugins/sli_plugin.py	2012-06-05 16:21:15 +0000
+++ twisted/plugins/sli_plugin.py	2012-06-18 20:53:18 +0000
@@ -63,11 +63,11 @@
             cobj = method(*cparams.split(" "))
             self.config[head][label] = cobj
 
-    def build_above(self, value):
-        return AboveCondition(float(value))
+    def build_above(self, value, slope=0):
+        return AboveCondition(float(value), float(slope))
 
-    def build_below(self, value):
-        return BelowCondition(float(value))
+    def build_below(self, value, slope=0):
+        return BelowCondition(float(value), float(slope))
 
     def build_between(self, low, hi):
         return BetweenCondition(float(low), float(hi))

=== modified file 'txstatsd/metrics/extendedmetrics.py'
--- txstatsd/metrics/extendedmetrics.py	2011-12-02 17:09:32 +0000
+++ txstatsd/metrics/extendedmetrics.py	2012-06-18 20:53:18 +0000
@@ -51,3 +51,4 @@
                                  sample_rate)
             self._metrics[name] = metric
         self._metrics[name].mark(duration)
+

=== modified file 'txstatsd/metrics/metrics.py'
--- txstatsd/metrics/metrics.py	2012-02-13 21:15:25 +0000
+++ txstatsd/metrics/metrics.py	2012-06-18 20:53:18 +0000
@@ -7,13 +7,15 @@
 
 
 class GenericMetric(Metric):
-    def __init__(self, connection, key, name, sample_rate=1):
-        super(GenericMetric, self).__init__(connection, name,
-                                            sample_rate=sample_rate)
+    def __init__(self, connection, key, name):
+        super(GenericMetric, self).__init__(connection, name)
         self.key = key
 
-    def mark(self, value):
-        self.send("%s|%s" % (value, self.key))
+    def mark(self, value, extra=None):
+        if extra is None:
+            self.send("%s|%s" % (value, self.key))
+        else:
+            self.send("%s|%s|%s" % (value, self.key, extra))
 
 
 class Metrics(object):
@@ -32,7 +34,7 @@
         self._metrics = {}
         self.last_time = 0
 
-    def report(self, name, value, metric_type, sample_rate=1):
+    def report(self, name, value, metric_type, extra=None):
         """Report a generic metric.
 
         Used for server side plugins without client support.
@@ -41,10 +43,26 @@
         if not name in self._metrics:
             metric = GenericMetric(self.connection,
                                         metric_type,
-                                        name,
-                                        sample_rate)
+                                        name)
             self._metrics[name] = metric
-        self._metrics[name].mark(value)
+        self._metrics[name].mark(value, extra)
+
+    def sli(self, name, duration, size=None):
+        """Report a service level metric.
+
+        The optional size parameter is used with linear thereshold slis.
+        So for example, to report a download you could use size and the size in
+        bytes of the file.
+        """
+        self.report(name, duration, "sli", size)
+
+    def sli_error(self, name):
+        """Report an error for a service level metric.
+
+        When something that is measures for service level errs (no time or size
+        are required/present) you can use this method to inform it.
+        """
+        self.report(name, "error", "sli")
 
     def gauge(self, name, value, sample_rate=1):
         """Report an instantaneous reading of a particular value."""

=== modified file 'txstatsd/metrics/slimetric.py'
--- txstatsd/metrics/slimetric.py	2012-06-05 14:39:32 +0000
+++ txstatsd/metrics/slimetric.py	2012-06-18 20:53:18 +0000
@@ -3,20 +3,23 @@
 
 class BelowCondition(object):
 
-    def __init__(self, value):
+    def __init__(self, value, slope=0):
         self.value = value
+        self.slope = slope
 
-    def __call__(self, value):
-        return value < self.value
+    def __call__(self, value, size=1):
+        return value < self.value + self.slope * size
 
 
 class AboveCondition(object):
 
-    def __init__(self, value):
+    def __init__(self, value, slope=0):
         self.value = value
-
-    def __call__(self, value):
-        return value > self.value
+        self.slope = slope
+
+    def __call__(self, value, size=1):
+        return value > self.value + self.slope * size
+
 
 class BetweenCondition(object):
 
@@ -24,7 +27,7 @@
         self.low = low
         self.hi = hi
 
-    def __call__(self, value):
+    def __call__(self, value, size=1):
         return self.low < value < self.hi
 
 
@@ -38,16 +41,26 @@
     def clear(self):
         self.counts = dict((k, 0) for k in self.conditions)
         self.count = 0
+        self.error = 0
 
     def process(self, fields):
-        self.update(float(fields[0]))
-
-    def update(self, value):
+        size = 1
+        if len(fields) == 3:
+            size = float(fields[2])
+
+        value = "error"
+        if value != fields[0]:
+            value = float(fields[0])
+        self.update(value, size)
+
+    def update(self, value, size=1):
         self.count += 1
-        for k, condition in self.conditions.items():
-
-            if condition(value):
-                self.counts[k] += 1
+        if value == "error":
+            self.error += 1
+        else:
+            for k, condition in self.conditions.items():
+                if condition(value, size):
+                    self.counts[k] += 1
 
     def flush(self, interval, timestamp):
         metrics = []
@@ -56,6 +69,8 @@
                             value, timestamp))
         metrics.append((self.name + ".count",
                             self.count, timestamp))
+        metrics.append((self.name + ".error",
+                            self.error, timestamp))
 
         self.clear()
         return metrics

=== modified file 'txstatsd/tests/metrics/test_sli.py'
--- txstatsd/tests/metrics/test_sli.py	2012-06-05 16:21:15 +0000
+++ txstatsd/tests/metrics/test_sli.py	2012-06-18 20:53:18 +0000
@@ -7,6 +7,7 @@
 from txstatsd.metrics.slimetric import (
     SLIMetricReporter, BetweenCondition, AboveCondition, BelowCondition)
 from txstatsd import service
+from txstatsd.tests.test_processor import TestMessageProcessor
 
 
 class TestConditions(TestCase):
@@ -27,6 +28,28 @@
         self.assertEquals(c(6), False)
         self.assertEquals(c(2.6), True)
 
+    def test_below_linear(self):
+        c = BelowCondition(5, 1)
+        self.assertEquals(c(5.5, 1), True)
+        self.assertEquals(c(6.5, 2), True)
+        self.assertEquals(c(8.5, 3), False)
+
+    def test_above_linear(self):
+        c = AboveCondition(4, 1)
+        self.assertEquals(c(5.5, 1), True)
+        self.assertEquals(c(6.5, 2), True)
+        self.assertEquals(c(7, 3), False)
+
+
+class TestParsing(TestCase):
+    def setUp(self):
+        self.processor = TestMessageProcessor()
+
+    def test_parse(self):
+        self.processor.process('txstatsd.tests.users:100|sli')
+        self.processor.process('txstatsd.tests.users:100|sli|2')
+        self.processor.process('txstatsd.tests.users:error|sli')
+
 
 class TestMetric(TestCase):
     def setUp(self):
@@ -39,6 +62,13 @@
         self.sli.update(1)
         self.assertEquals(self.sli.count, 2)
 
+    def test_count_error(self):
+        self.sli.update(1)
+        self.sli.update("error")
+        self.assertEquals(self.sli.count, 2)
+        self.assertEquals(self.sli.error, 1)
+        self.assertEquals(self.sli.counts["red"], 1)
+
     def test_count_threshold(self):
         self.assertEquals(self.sli.count, 0)
         self.assertEquals(self.sli.counts["red"], 0)
@@ -55,7 +85,8 @@
         self.assertEquals(
             [("test.count", 6, 0),
             ("test.count_red", 4, 0),
-            ("test.count_yellow", 2, 0)],
+            ("test.count_yellow", 2, 0),
+            ("test.error", 0, 0)],
             rows)
 
     def test_clear(self):
@@ -67,6 +98,23 @@
         self.assertEquals(self.sli.count, 1)
 
 
+class TestMetricLinear(TestCase):
+    def setUp(self):
+        self.sli = SLIMetricReporter('test', {
+                        "red": BelowCondition(5, 1),
+                        "yellow": BelowCondition(3, 1)})
+
+    def test_count_threshold(self):
+        self.assertEquals(self.sli.count, 0)
+        self.assertEquals(self.sli.counts["red"], 0)
+        self.assertEquals(self.sli.counts["yellow"], 0)
+        for i in range(1, 7):
+            self.sli.update(7, i)
+        self.assertEquals(self.sli.count, 6)
+        self.assertEquals(self.sli.counts["red"], 4)
+        self.assertEquals(self.sli.counts["yellow"], 2)
+
+
 class TestFactory(TestCase):
     def test_configure(self):
         class TestOptions(service.OptionsGlue):
@@ -95,3 +143,27 @@
         rc = smr.conditions["red"]
         self.assertTrue(isinstance(rc, AboveCondition))
         self.assertEquals(rc.value, 4)
+
+    def test_configure_linear(self):
+        class TestOptions(service.OptionsGlue):
+            optParameters = [["test", "t", "default", "help"]]
+            config_section = "statsd"
+
+        o = TestOptions()
+        config_file = ConfigParser.RawConfigParser()
+        config_file.readfp(StringIO("[statsd]\n\n[plugin_sli]\n"
+            "rules = \n"
+            "   test => red IF below 5 1\n"
+            "   test => green IF above 3 1\n"))
+        o.configure(config_file)
+        smf = SLIMetricFactory()
+        smf.configure(o)
+        smr = smf.build_metric("", "test")
+        rc = smr.conditions["red"]
+        self.assertTrue(isinstance(rc, BelowCondition))
+        self.assertEquals(rc.value, 5)
+        self.assertEquals(rc.slope, 1)
+        rc = smr.conditions["green"]
+        self.assertTrue(isinstance(rc, AboveCondition))
+        self.assertEquals(rc.value, 3)
+        self.assertEquals(rc.slope, 1)

=== modified file 'txstatsd/tests/test_metrics.py'
--- txstatsd/tests/test_metrics.py	2011-11-28 16:24:39 +0000
+++ txstatsd/tests/test_metrics.py	2012-06-18 20:53:18 +0000
@@ -91,6 +91,12 @@
         self.assertEqual(self.connection.data,
                          'txstatsd.tests.users:pepe|pd')
 
+    def test_generic_extra(self):
+        """Test the GenericMetric class."""
+        self.metrics.report('users', "pepe", "pd", 100)
+        self.assertEqual(self.connection.data,
+                         'txstatsd.tests.users:pepe|pd|100')
+
     def test_empty_namespace(self):
         """Test reporting of an empty namespace."""
         self.metrics.namespace = None
@@ -118,3 +124,16 @@
         self.assertEqual(self.connection.data,
                          'txstatsd.tests.counter:9|c')
 
+    def test_sli(self):
+        """Test SLI call."""
+        self.metrics.sli('users', 100)
+        self.assertEqual(self.connection.data,
+                         'txstatsd.tests.users:100|sli')
+
+        self.metrics.sli('users', 200, 2)
+        self.assertEqual(self.connection.data,
+                         'txstatsd.tests.users:200|sli|2')
+
+        self.metrics.sli_error('users')
+        self.assertEqual(self.connection.data,
+                         'txstatsd.tests.users:error|sli')