2015-02-24 16:58:26 +00:00
|
|
|
# -*- 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.
|
|
|
|
|
|
|
|
|
2015-03-04 19:22:14 +00:00
|
|
|
from itertools import chain
|
|
|
|
|
|
|
|
|
|
|
|
# TODO(paul): I can't believe Python doesn't have one of these
|
|
|
|
def map_concat(func, items):
|
|
|
|
# flatten a list-of-lists
|
|
|
|
return list(chain.from_iterable(map(func, items)))
|
|
|
|
|
|
|
|
|
2015-03-04 15:47:23 +00:00
|
|
|
class BaseMetric(object):
|
2015-02-24 16:58:26 +00:00
|
|
|
|
2015-03-06 15:28:06 +00:00
|
|
|
def __init__(self, name, labels=[]):
|
2015-02-24 16:58:26 +00:00
|
|
|
self.name = name
|
2015-03-06 15:28:06 +00:00
|
|
|
self.labels = labels # OK not to clone as we never write it
|
2015-02-24 16:58:26 +00:00
|
|
|
|
2015-03-04 17:53:51 +00:00
|
|
|
def dimension(self):
|
2015-03-06 15:28:06 +00:00
|
|
|
return len(self.labels)
|
2015-03-04 17:53:51 +00:00
|
|
|
|
|
|
|
def is_scalar(self):
|
2015-03-06 15:28:06 +00:00
|
|
|
return not len(self.labels)
|
2015-03-04 17:53:51 +00:00
|
|
|
|
2015-03-06 18:40:20 +00:00
|
|
|
def _render_labelvalue(self, value):
|
|
|
|
# TODO: some kind of value escape
|
|
|
|
return '"%s"' % (value)
|
|
|
|
|
2015-03-04 15:47:23 +00:00
|
|
|
def _render_key(self, values):
|
2015-03-04 19:28:17 +00:00
|
|
|
if self.is_scalar():
|
|
|
|
return ""
|
|
|
|
return "{%s}" % (
|
2015-03-06 18:40:20 +00:00
|
|
|
",".join(["%s=%s" % (k, self._render_labelvalue(v))
|
|
|
|
for k, v in zip(self.labels, values)])
|
2015-03-04 19:28:17 +00:00
|
|
|
)
|
|
|
|
|
|
|
|
def render(self):
|
|
|
|
return map_concat(self.render_item, sorted(self.counts.keys()))
|
2015-03-04 15:47:23 +00:00
|
|
|
|
|
|
|
|
|
|
|
class CounterMetric(BaseMetric):
|
|
|
|
"""The simplest kind of metric; one that stores a monotonically-increasing
|
|
|
|
integer that counts events."""
|
|
|
|
|
|
|
|
def __init__(self, *args, **kwargs):
|
|
|
|
super(CounterMetric, self).__init__(*args, **kwargs)
|
|
|
|
|
2015-02-24 16:58:26 +00:00
|
|
|
self.counts = {}
|
|
|
|
|
|
|
|
# Scalar metrics are never empty
|
2015-03-04 17:53:51 +00:00
|
|
|
if self.is_scalar():
|
2015-02-24 16:58:26 +00:00
|
|
|
self.counts[()] = 0
|
|
|
|
|
|
|
|
def inc(self, *values):
|
2015-03-04 17:53:51 +00:00
|
|
|
if len(values) != self.dimension():
|
2015-03-06 15:28:06 +00:00
|
|
|
raise ValueError("Expected as many values to inc() as labels (%d)" %
|
2015-03-04 17:53:51 +00:00
|
|
|
(self.dimension())
|
2015-02-24 16:58:26 +00:00
|
|
|
)
|
|
|
|
|
|
|
|
# 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
|
|
|
|
|
2015-03-04 19:28:17 +00:00
|
|
|
def render_item(self, k):
|
|
|
|
return ["%s%s %d" % (self.name, self._render_key(k), self.counts[k])]
|
2015-03-04 15:47:23 +00:00
|
|
|
|
|
|
|
|
2015-03-04 16:46:44 +00:00
|
|
|
class CallbackMetric(BaseMetric):
|
|
|
|
"""A metric that returns the numeric value returned by a callback whenever
|
|
|
|
it is rendered. Typically this is used to implement gauges that yield the
|
|
|
|
size or other state of some in-memory object by actively querying it."""
|
|
|
|
|
2015-03-06 15:28:06 +00:00
|
|
|
def __init__(self, name, callback, labels=[]):
|
|
|
|
super(CallbackMetric, self).__init__(name, labels=labels)
|
2015-03-04 16:46:44 +00:00
|
|
|
|
|
|
|
self.callback = callback
|
|
|
|
|
|
|
|
def render(self):
|
2015-03-04 17:58:10 +00:00
|
|
|
value = self.callback()
|
2015-03-04 16:46:44 +00:00
|
|
|
|
2015-03-04 17:58:10 +00:00
|
|
|
if self.is_scalar():
|
|
|
|
return ["%s %d" % (self.name, value)]
|
|
|
|
|
2015-03-04 19:28:17 +00:00
|
|
|
return ["%s%s %d" % (self.name, self._render_key(k), value[k])
|
2015-03-04 17:58:10 +00:00
|
|
|
for k in sorted(value.keys())]
|
2015-03-04 17:53:51 +00:00
|
|
|
|
2015-03-04 19:22:14 +00:00
|
|
|
|
|
|
|
class TimerMetric(CounterMetric):
|
|
|
|
"""A combination of an event counter and a time accumulator, which counts
|
|
|
|
both the number of events and how long each one takes.
|
|
|
|
|
|
|
|
TODO(paul): Try to export some heatmap-style stats?
|
|
|
|
"""
|
|
|
|
|
|
|
|
def __init__(self, *args, **kwargs):
|
|
|
|
super(TimerMetric, self).__init__(*args, **kwargs)
|
|
|
|
|
|
|
|
self.times = {}
|
|
|
|
|
|
|
|
# Scalar metrics are never empty
|
|
|
|
if self.is_scalar():
|
|
|
|
self.times[()] = 0
|
|
|
|
|
|
|
|
def inc_time(self, msec, *values):
|
|
|
|
self.inc(*values)
|
|
|
|
|
|
|
|
if values not in self.times:
|
|
|
|
self.times[values] = msec
|
|
|
|
else:
|
|
|
|
self.times[values] += msec
|
|
|
|
|
2015-03-04 19:28:17 +00:00
|
|
|
def render_item(self, k):
|
|
|
|
keystr = self._render_key(k)
|
2015-03-04 19:22:14 +00:00
|
|
|
|
2015-03-06 15:35:23 +00:00
|
|
|
return ["%s:count%s %d" % (self.name, keystr, self.counts[k]),
|
|
|
|
"%s:msec%s %d" % (self.name, keystr, self.times[k])]
|
2015-03-04 19:22:14 +00:00
|
|
|
|
|
|
|
|
2015-03-04 17:34:23 +00:00
|
|
|
class CacheMetric(object):
|
2015-03-04 15:47:23 +00:00
|
|
|
"""A combination of two CounterMetrics, one to count cache hits and one to
|
2015-03-04 17:34:23 +00:00
|
|
|
count misses, and a callback metric to yield the current size.
|
2015-03-04 15:47:23 +00:00
|
|
|
|
|
|
|
This metric generates standard metric name pairs, so that monitoring rules
|
|
|
|
can easily be applied to measure hit ratio."""
|
|
|
|
|
2015-03-06 15:28:06 +00:00
|
|
|
def __init__(self, name, size_callback, labels=[]):
|
2015-03-04 15:47:23 +00:00
|
|
|
self.name = name
|
|
|
|
|
2015-03-06 15:28:06 +00:00
|
|
|
self.hits = CounterMetric(name + ":hits", labels=labels)
|
|
|
|
self.misses = CounterMetric(name + ":misses", labels=labels)
|
2015-03-04 15:47:23 +00:00
|
|
|
|
2015-03-04 17:34:23 +00:00
|
|
|
self.size = CallbackMetric(name + ":size",
|
|
|
|
callback=size_callback,
|
2015-03-06 15:28:06 +00:00
|
|
|
labels=labels,
|
2015-03-04 17:34:23 +00:00
|
|
|
)
|
|
|
|
|
2015-03-04 15:47:23 +00:00
|
|
|
def inc_hits(self, *values):
|
|
|
|
self.hits.inc(*values)
|
|
|
|
|
|
|
|
def inc_misses(self, *values):
|
|
|
|
self.misses.inc(*values)
|
|
|
|
|
|
|
|
def render(self):
|
2015-03-04 17:34:23 +00:00
|
|
|
return self.hits.render() + self.misses.render() + self.size.render()
|