aboutsummaryrefslogtreecommitdiff
path: root/packet/log_utils.py
blob: 5481bef9a1d078f3bf7c0835d54b0d205a74a9a5 (plain) (blame)
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
"""
General utilities for logging metadata
"""

from functools import wraps
from datetime import datetime

from packet import app, ldap
from packet.context_processors import get_rit_name
from packet.utils import is_freshman_on_floor


def log_time(func):
    """
    Decorator for logging the execution time of a function
    """
    @wraps(func)
    def wrapped_function(*args, **kwargs):
        start = datetime.now()

        result = func(*args, **kwargs)

        seconds = (datetime.now() - start).total_seconds()
        app.logger.info('{}.{}() returned after {} seconds'.format(func.__module__, func.__name__, seconds))

        return result

    return wrapped_function


def _format_cache(func):
    """
    :return: The output of func.cache_info() as a compactly formatted string
    """
    info = func.cache_info()
    return '{}[hits={}, misses={}, size={}/{}]'.format(func.__name__, info.hits, info.misses, info.currsize,
                                                       info.maxsize)


# Tuple of lru_cache functions to log stats from
_caches = (get_rit_name, ldap.get_member, is_freshman_on_floor)


def log_cache(func):
    """
    Decorator for logging cache info
    """

    @wraps(func)
    def wrapped_function(*args, **kwargs):
        result = func(*args, **kwargs)

        app.logger.info('Cache stats: ' + ', '.join(map(_format_cache, _caches)))

        return result

    return wrapped_function