Class CounterWithTimer

st2common/st2common/metrics/base.py:171–218

Timer and counter context manager for easily sending counter statistics with builtin timer.

class CounterWithTimer(object):
    """
    Timer and counter context manager for easily sending counter statistics
    with builtin timer.
    """

    def __init__(self, key, include_parameter=False):
        check_key(key)
        self.key = key
        self._metrics = get_driver()
        self._include_parameter = include_parameter
        self._start_time = None

    def send_time(self, key=None):
        """
        Send current time from start time.
        """
        time_delta = self.get_time_delta()

        if key:
            check_key(key)
            self._metrics.time(key, time_delta.total_seconds())
        else:
            self._metrics.time(self.key, time_delta.total_seconds())

    def get_time_delta(self):
        """
        Get current time delta.
        """
        return get_datetime_utc_now() - self._start_time

    def __enter__(self):
        self._metrics.inc_counter(self.key)
        self._start_time = get_datetime_utc_now()
        return self

    def __exit__(self, *args):
        self.send_time()

    def __call__(self, func):
        @wraps(func)
        def wrapper(*args, **kw):
            with self as counter_with_timer:
                if self._include_parameter:
                    kw["metrics_counter_with_timer"] = counter_with_timer
                return func(*args, **kw)

        return wrapper


def metrics_initialize():