summary refs log tree commit diff
path: root/synapse/metrics/metric.py
diff options
context:
space:
mode:
authorPaul "LeoNerd" Evans <paul@matrix.org>2015-02-24 16:58:26 +0000
committerPaul "LeoNerd" Evans <paul@matrix.org>2015-03-12 16:24:50 +0000
commite7420a3bef308e12d2b202c7a2c256d15eee0983 (patch)
treeac37f677b04640ff8ec1c9823a3a47996d0bb069 /synapse/metrics/metric.py
parentA trivial 'hello world'-style resource on /_synapse/metrics, with optional co... (diff)
downloadsynapse-e7420a3bef308e12d2b202c7a2c256d15eee0983.tar.xz
Initial tiny attempt at (vectorable) counter metrics
Diffstat (limited to 'synapse/metrics/metric.py')
-rw-r--r--synapse/metrics/metric.py54
1 files changed, 54 insertions, 0 deletions
diff --git a/synapse/metrics/metric.py b/synapse/metrics/metric.py
new file mode 100644
index 0000000000..f5a98763cc
--- /dev/null
+++ b/synapse/metrics/metric.py
@@ -0,0 +1,54 @@
+# -*- coding: utf-8 -*-
+# Copyright 2015 OpenMarket Ltd
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+class CounterMetric(object):
+
+    def __init__(self, name, keys=[]):
+        self.name = name
+        self.keys = keys # OK not to clone as we never write it
+
+        self.counts = {}
+
+        # Scalar metrics are never empty
+        if not len(keys):
+            self.counts[()] = 0
+
+    def inc(self, *values):
+        if len(values) != len(self.keys):
+            raise ValueError("Expected as many values to inc() as keys (%d)" %
+                (len(self.keys))
+            )
+
+        # TODO: should assert that the tag values are all strings
+
+        if values not in self.counts:
+            self.counts[values] = 1
+        else:
+            self.counts[values] += 1
+
+    def fetch(self):
+        return dict(self.counts)
+
+    def _render_key(self, values):
+        # TODO: some kind of value escape
+        return ",".join(["%s=%s" % kv for kv in zip(self.keys, values)])
+
+    def render(self):
+        if not len(self.keys):
+            return ["%s %d" % (self.name, self.counts[()])]
+
+        return ["%s{%s} %d" % (self.name, self._render_key(k), self.counts[k])
+                for k in sorted(self.counts.keys())]