1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57
|
from __future__ import absolute_import
import abc
class AbstractMetricsReporter(object):
"""
An abstract class to allow things to listen as new metrics
are created so they can be reported.
"""
__metaclass__ = abc.ABCMeta
@abc.abstractmethod
def init(self, metrics):
"""
This is called when the reporter is first registered
to initially register all existing metrics
Arguments:
metrics (list of KafkaMetric): All currently existing metrics
"""
raise NotImplementedError
@abc.abstractmethod
def metric_change(self, metric):
"""
This is called whenever a metric is updated or added
Arguments:
metric (KafkaMetric)
"""
raise NotImplementedError
@abc.abstractmethod
def metric_removal(self, metric):
"""
This is called whenever a metric is removed
Arguments:
metric (KafkaMetric)
"""
raise NotImplementedError
@abc.abstractmethod
def configure(self, configs):
"""
Configure this class with the given key-value pairs
Arguments:
configs (dict of {str, ?})
"""
raise NotImplementedError
@abc.abstractmethod
def close(self):
"""Called when the metrics repository is closed."""
raise NotImplementedError
|