aws_xray_sdk/core/sampling/rule_cache.py

import threading
from operator import attrgetter

TTL = 60 * 60  # The cache expires 1 hour after the last refresh time.


class RuleCache:
    """
    Cache sampling rules and quota retrieved by ``TargetPoller``
    and ``RulePoller``. It will not return anything if it expires.
    """
    def __init__(self):

        self._last_updated = None
        self._rules = []
        self._lock = threading.Lock()

    def get_matched_rule(self, sampling_req, now):
        if self._is_expired(now):
            return None
        matched_rule = None
        for rule in self.rules:
            if(not matched_rule and rule.match(sampling_req)):
                matched_rule = rule
            if(not matched_rule and rule.is_default()):
                matched_rule = rule
        return matched_rule

    def load_rules(self, rules):
        # Record the old rules for later merging.
        with self._lock:
            self._load_rules(rules)

    def load_targets(self, targets_dict):
        with self._lock:
            self._load_targets(targets_dict)

    def _load_rules(self, rules):
        oldRules = {}
        for rule in self.rules:
            oldRules[rule.name] = rule

        # Update the rules in the cache.
        self.rules = rules

        # Transfer state information to refreshed rules.
        for rule in self.rules:
            old = oldRules.get(rule.name, None)
            if old:
                rule.merge(old)

        # The cache should maintain the order of the rules based on
        # priority. If priority is the same we sort name by alphabet
        # as rule name is unique.
        self.rules.sort(key=attrgetter('priority', 'name'))

    def _load_targets(self, targets_dict):
        for rule in self.rules:
            target = targets_dict.get(rule.name, None)
            if target:
                rule.reservoir.load_quota(target['quota'],
                                          target['TTL'],
                                          target['interval'])
                rule.rate = target['rate']

    def _is_expired(self, now):
        # The cache is treated as expired if it is never loaded.
        if not self._last_updated:
            return True
        return now > self.last_updated + TTL

    @property
    def rules(self):
        return self._rules

    @rules.setter
    def rules(self, v):
        self._rules = v

    @property
    def last_updated(self):
        return self._last_updated

    @last_updated.setter
    def last_updated(self, v):
        self._last_updated = v