Move cache configuration into a homeserver config option, instead of environment variables.
parent
4f5ca455bf
commit
a14831d209
|
@ -0,0 +1 @@
|
|||
Synapse's cache factor can now be configured in `homeserver.yaml` by the `caches.global_factor` setting. Additionally, `caches.per_cache_factors` controls the cache factors for individual caches.
|
|
@ -41,7 +41,7 @@ from synapse.api.errors import (
|
|||
)
|
||||
from synapse.config.server import is_threepid_reserved
|
||||
from synapse.types import UserID
|
||||
from synapse.util.caches import CACHE_SIZE_FACTOR, register_cache
|
||||
from synapse.util.caches import register_cache
|
||||
from synapse.util.caches.lrucache import LruCache
|
||||
from synapse.util.metrics import Measure
|
||||
|
||||
|
@ -77,7 +77,7 @@ class Auth(object):
|
|||
self.store = hs.get_datastore()
|
||||
self.state = hs.get_state_handler()
|
||||
|
||||
self.token_cache = LruCache(CACHE_SIZE_FACTOR * 10000)
|
||||
self.token_cache = LruCache(10000)
|
||||
register_cache("cache", "token_cache", self.token_cache)
|
||||
|
||||
self._account_validity = hs.config.account_validity
|
||||
|
|
|
@ -71,7 +71,6 @@ from synapse.server import HomeServer
|
|||
from synapse.storage import DataStore, are_all_users_on_domain
|
||||
from synapse.storage.engines import IncorrectDatabaseSetup, create_engine
|
||||
from synapse.storage.prepare_database import UpgradeDatabaseException, prepare_database
|
||||
from synapse.util.caches import CACHE_SIZE_FACTOR
|
||||
from synapse.util.httpresourcetree import create_resource_tree
|
||||
from synapse.util.manhole import manhole
|
||||
from synapse.util.module_loader import load_module
|
||||
|
@ -516,7 +515,7 @@ def phone_stats_home(hs, stats, stats_process=_stats_process):
|
|||
|
||||
daily_sent_messages = yield hs.get_datastore().count_daily_sent_messages()
|
||||
stats["daily_sent_messages"] = daily_sent_messages
|
||||
stats["cache_factor"] = CACHE_SIZE_FACTOR
|
||||
stats["cache_factor"] = hs.config.caches.global_factor
|
||||
stats["event_cache_size"] = hs.config.event_cache_size
|
||||
|
||||
#
|
||||
|
|
|
@ -0,0 +1,100 @@
|
|||
# -*- coding: utf-8 -*-
|
||||
# Copyright 2019 Matrix.org Foundation C.I.C.
|
||||
#
|
||||
# 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.
|
||||
|
||||
import os
|
||||
from collections import defaultdict
|
||||
from typing import DefaultDict
|
||||
|
||||
from twisted.logger import Logger
|
||||
|
||||
from ._base import Config, ConfigError
|
||||
|
||||
log = Logger()
|
||||
|
||||
_CACHES = {}
|
||||
DEFAULT_CACHE_SIZE_FACTOR = float(os.environ.get("SYNAPSE_CACHE_FACTOR", 0.5))
|
||||
|
||||
|
||||
_DEFAULT_CONFIG = """\
|
||||
# Cache configuration
|
||||
#
|
||||
# 'global_factor' controls the global cache factor. This overrides the
|
||||
# "SYNAPSE_CACHE_FACTOR" environment variable.
|
||||
#
|
||||
# 'per_cache_factors' is a dictionary of cache name to cache factor for that
|
||||
# individual cache.
|
||||
#
|
||||
#caches:
|
||||
# global_factor: 0.5
|
||||
# per_cache_factors:
|
||||
# get_users_who_share_room_with_user: 2
|
||||
#
|
||||
"""
|
||||
|
||||
|
||||
def add_resizable_cache(cache_name, cache_resize_callback):
|
||||
_CACHES[cache_name.lower()] = cache_resize_callback
|
||||
|
||||
|
||||
class CacheConfig(Config):
|
||||
section = "caches"
|
||||
|
||||
def read_config(self, config, **kwargs):
|
||||
global DEFAULT_CACHE_SIZE_FACTOR
|
||||
|
||||
cache_config = config.get("caches", {})
|
||||
|
||||
self.global_factor = cache_config.get(
|
||||
"global_factor", DEFAULT_CACHE_SIZE_FACTOR
|
||||
)
|
||||
if not isinstance(self.global_factor, (int, float)):
|
||||
raise ConfigError("caches.global_factor must be a number.")
|
||||
|
||||
# Set the global one so that it's reflected in new caches
|
||||
DEFAULT_CACHE_SIZE_FACTOR = self.global_factor
|
||||
|
||||
individual_factors = cache_config.get("per_cache_factors", {}) or {}
|
||||
if not isinstance(individual_factors, dict):
|
||||
raise ConfigError("caches.per_cache_factors must be a dictionary")
|
||||
|
||||
self.cache_factors = defaultdict(
|
||||
lambda: self.global_factor
|
||||
) # type: DefaultDict[str, float]
|
||||
|
||||
for cache, factor in individual_factors.items():
|
||||
if not isinstance(factor, (int, float)):
|
||||
raise ConfigError(
|
||||
"caches.per_cache_factors.%s must be a number" % (cache.lower(),)
|
||||
)
|
||||
self.cache_factors[cache.lower()] = factor
|
||||
|
||||
def resize_caches(self):
|
||||
for cache_name, cache_resize_callback in _CACHES.items():
|
||||
cache_factor = self.cache_factors[cache_name]
|
||||
log.debug(
|
||||
"Setting cache factor for {cache_name} to {new_cache_factor}",
|
||||
cache_name=cache_name,
|
||||
new_cache_factor=cache_factor,
|
||||
)
|
||||
changed = cache_resize_callback(cache_factor)
|
||||
if changed:
|
||||
log.info(
|
||||
"Cache factor for {cache_name} set to {new_cache_factor}",
|
||||
cache_name=cache_name,
|
||||
new_cache_factor=cache_factor,
|
||||
)
|
||||
|
||||
def get_factor_for(self, cache_name):
|
||||
return self.cache_factors[cache_name.lower()]
|
|
@ -17,6 +17,7 @@
|
|||
from ._base import RootConfig
|
||||
from .api import ApiConfig
|
||||
from .appservice import AppServiceConfig
|
||||
from .cache import CacheConfig
|
||||
from .captcha import CaptchaConfig
|
||||
from .cas import CasConfig
|
||||
from .consent_config import ConsentConfig
|
||||
|
@ -80,4 +81,5 @@ class HomeServerConfig(RootConfig):
|
|||
RoomDirectoryConfig,
|
||||
ThirdPartyRulesConfig,
|
||||
TracerConfig,
|
||||
CacheConfig,
|
||||
]
|
||||
|
|
|
@ -49,7 +49,6 @@ from synapse.http.proxyagent import ProxyAgent
|
|||
from synapse.logging.context import make_deferred_yieldable
|
||||
from synapse.logging.opentracing import set_tag, start_active_span, tags
|
||||
from synapse.util.async_helpers import timeout_deferred
|
||||
from synapse.util.caches import CACHE_SIZE_FACTOR
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
|
||||
|
@ -241,7 +240,8 @@ class SimpleHttpClient(object):
|
|||
# tends to do so in batches, so we need to allow the pool to keep
|
||||
# lots of idle connections around.
|
||||
pool = HTTPConnectionPool(self.reactor)
|
||||
pool.maxPersistentPerHost = max((100 * CACHE_SIZE_FACTOR, 5))
|
||||
# XXX: Why does this use the cache factor????
|
||||
pool.maxPersistentPerHost = max((100 * hs.config.caches.global_factor, 5))
|
||||
pool.cachedConnectionTimeout = 2 * 60
|
||||
|
||||
# The default context factory in Twisted 14.0.0 (which we require) is
|
||||
|
|
|
@ -33,6 +33,8 @@ from prometheus_client import REGISTRY
|
|||
|
||||
from twisted.web.resource import Resource
|
||||
|
||||
from synapse.util import caches
|
||||
|
||||
try:
|
||||
from prometheus_client.samples import Sample
|
||||
except ImportError:
|
||||
|
@ -103,13 +105,15 @@ def nameify_sample(sample):
|
|||
|
||||
|
||||
def generate_latest(registry, emit_help=False):
|
||||
|
||||
# Trigger the cache metrics to be rescraped, which updates the common
|
||||
# metrics but do not produce metrics themselves
|
||||
for collector in caches.collectors_by_name.values():
|
||||
collector.collect()
|
||||
|
||||
output = []
|
||||
|
||||
for metric in registry.collect():
|
||||
|
||||
if metric.name.startswith("__unused"):
|
||||
continue
|
||||
|
||||
if not metric.samples:
|
||||
# No samples, don't bother.
|
||||
continue
|
||||
|
|
|
@ -51,6 +51,7 @@ push_rules_delta_state_cache_metric = register_cache(
|
|||
"cache",
|
||||
"push_rules_delta_state_cache_metric",
|
||||
cache=[], # Meaningless size, as this isn't a cache that stores values
|
||||
resizable=False,
|
||||
)
|
||||
|
||||
|
||||
|
@ -67,7 +68,8 @@ class BulkPushRuleEvaluator(object):
|
|||
self.room_push_rule_cache_metrics = register_cache(
|
||||
"cache",
|
||||
"room_push_rule_cache",
|
||||
cache=[], # Meaningless size, as this isn't a cache that stores values
|
||||
cache=[], # Meaningless size, as this isn't a cache that stores values,
|
||||
resizable=False,
|
||||
)
|
||||
|
||||
@defer.inlineCallbacks
|
||||
|
|
|
@ -20,7 +20,7 @@ import re
|
|||
from six import string_types
|
||||
|
||||
from synapse.types import UserID
|
||||
from synapse.util.caches import CACHE_SIZE_FACTOR, register_cache
|
||||
from synapse.util.caches import register_cache
|
||||
from synapse.util.caches.lrucache import LruCache
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
|
@ -149,7 +149,7 @@ class PushRuleEvaluatorForEvent(object):
|
|||
|
||||
|
||||
# Caches (glob, word_boundary) -> regex for push. See _glob_matches
|
||||
regex_cache = LruCache(50000 * CACHE_SIZE_FACTOR)
|
||||
regex_cache = LruCache(50000)
|
||||
register_cache("cache", "regex_push_cache", regex_cache)
|
||||
|
||||
|
||||
|
|
|
@ -14,7 +14,6 @@
|
|||
# limitations under the License.
|
||||
|
||||
from synapse.storage.data_stores.main.client_ips import LAST_SEEN_GRANULARITY
|
||||
from synapse.util.caches import CACHE_SIZE_FACTOR
|
||||
from synapse.util.caches.descriptors import Cache
|
||||
|
||||
from ._base import BaseSlavedStore
|
||||
|
@ -25,7 +24,7 @@ class SlavedClientIpStore(BaseSlavedStore):
|
|||
super(SlavedClientIpStore, self).__init__(db_conn, hs)
|
||||
|
||||
self.client_ip_last_seen = Cache(
|
||||
name="client_ip_last_seen", keylen=4, max_entries=50000 * CACHE_SIZE_FACTOR
|
||||
name="client_ip_last_seen", keylen=4, max_entries=50000
|
||||
)
|
||||
|
||||
def insert_client_ip(self, user_id, access_token, ip, user_agent, device_id):
|
||||
|
|
|
@ -252,6 +252,7 @@ class HomeServer(object):
|
|||
"""
|
||||
for i in self.REQUIRED_ON_MASTER_STARTUP:
|
||||
getattr(self, "get_" + i)()
|
||||
self.config.caches.resize_caches()
|
||||
|
||||
def get_reactor(self):
|
||||
"""
|
||||
|
|
|
@ -33,7 +33,6 @@ from synapse.events.snapshot import EventContext
|
|||
from synapse.logging.utils import log_function
|
||||
from synapse.state import v1, v2
|
||||
from synapse.util.async_helpers import Linearizer
|
||||
from synapse.util.caches import get_cache_factor_for
|
||||
from synapse.util.caches.expiringcache import ExpiringCache
|
||||
from synapse.util.metrics import Measure, measure_func
|
||||
|
||||
|
@ -51,7 +50,6 @@ state_groups_histogram = Histogram(
|
|||
KeyStateTuple = namedtuple("KeyStateTuple", ("context", "type", "state_key"))
|
||||
|
||||
|
||||
SIZE_OF_CACHE = 100000 * get_cache_factor_for("state_cache")
|
||||
EVICTION_TIMEOUT_SECONDS = 60 * 60
|
||||
|
||||
|
||||
|
@ -441,10 +439,11 @@ class StateResolutionHandler(object):
|
|||
self._state_cache = None
|
||||
self.resolve_linearizer = Linearizer(name="state_resolve_lock")
|
||||
|
||||
cache_size = 100000 * hs.config.caches.get_factor_for("state_cache")
|
||||
self._state_cache = ExpiringCache(
|
||||
cache_name="state_cache",
|
||||
clock=self.clock,
|
||||
max_len=SIZE_OF_CACHE,
|
||||
max_len=cache_size,
|
||||
expiry_ms=EVICTION_TIMEOUT_SECONDS * 1000,
|
||||
iterable=True,
|
||||
reset_expiry_on_get=True,
|
||||
|
|
|
@ -22,7 +22,6 @@ from twisted.internet import defer
|
|||
from synapse.metrics.background_process_metrics import wrap_as_background_process
|
||||
from synapse.storage import background_updates
|
||||
from synapse.storage._base import Cache
|
||||
from synapse.util.caches import CACHE_SIZE_FACTOR
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
|
||||
|
@ -366,7 +365,7 @@ class ClientIpStore(ClientIpBackgroundUpdateStore):
|
|||
def __init__(self, db_conn, hs):
|
||||
|
||||
self.client_ip_last_seen = Cache(
|
||||
name="client_ip_last_seen", keylen=4, max_entries=50000 * CACHE_SIZE_FACTOR
|
||||
name="client_ip_last_seen", keylen=4, max_entries=50000
|
||||
)
|
||||
|
||||
super(ClientIpStore, self).__init__(db_conn, hs)
|
||||
|
|
|
@ -31,7 +31,7 @@ from synapse.storage.background_updates import BackgroundUpdateStore
|
|||
from synapse.storage.data_stores.main.events_worker import EventsWorkerStore
|
||||
from synapse.storage.engines import PostgresEngine
|
||||
from synapse.storage.state import StateFilter
|
||||
from synapse.util.caches import get_cache_factor_for, intern_string
|
||||
from synapse.util.caches import intern_string
|
||||
from synapse.util.caches.descriptors import cached, cachedList
|
||||
from synapse.util.caches.dictionary_cache import DictionaryCache
|
||||
from synapse.util.stringutils import to_ascii
|
||||
|
@ -249,11 +249,11 @@ class StateGroupWorkerStore(
|
|||
self._state_group_cache = DictionaryCache(
|
||||
"*stateGroupCache*",
|
||||
# TODO: this hasn't been tuned yet
|
||||
50000 * get_cache_factor_for("stateGroupCache"),
|
||||
50000 * hs.config.caches.get_factor_for("stateGroupCache"),
|
||||
)
|
||||
self._state_group_members_cache = DictionaryCache(
|
||||
"*stateGroupMembersCache*",
|
||||
500000 * get_cache_factor_for("stateGroupMembersCache"),
|
||||
500000 * hs.config.caches.get_factor_for("stateGroupMembersCache"),
|
||||
)
|
||||
|
||||
@defer.inlineCallbacks
|
||||
|
|
|
@ -15,28 +15,17 @@
|
|||
# limitations under the License.
|
||||
|
||||
import logging
|
||||
import os
|
||||
from typing import Dict
|
||||
|
||||
import six
|
||||
from six.moves import intern
|
||||
|
||||
from prometheus_client.core import REGISTRY, Gauge, GaugeMetricFamily
|
||||
from prometheus_client.core import Gauge
|
||||
|
||||
from synapse.config.cache import add_resizable_cache
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
|
||||
CACHE_SIZE_FACTOR = float(os.environ.get("SYNAPSE_CACHE_FACTOR", 0.5))
|
||||
|
||||
|
||||
def get_cache_factor_for(cache_name):
|
||||
env_var = "SYNAPSE_CACHE_FACTOR_" + cache_name.upper()
|
||||
factor = os.environ.get(env_var)
|
||||
if factor:
|
||||
return float(factor)
|
||||
|
||||
return CACHE_SIZE_FACTOR
|
||||
|
||||
|
||||
caches_by_name = {}
|
||||
collectors_by_name = {} # type: Dict
|
||||
|
||||
|
@ -44,6 +33,7 @@ cache_size = Gauge("synapse_util_caches_cache:size", "", ["name"])
|
|||
cache_hits = Gauge("synapse_util_caches_cache:hits", "", ["name"])
|
||||
cache_evicted = Gauge("synapse_util_caches_cache:evicted_size", "", ["name"])
|
||||
cache_total = Gauge("synapse_util_caches_cache:total", "", ["name"])
|
||||
cache_max_size = Gauge("synapse_util_caches_cache_max_size", "", ["name"])
|
||||
|
||||
response_cache_size = Gauge("synapse_util_caches_response_cache:size", "", ["name"])
|
||||
response_cache_hits = Gauge("synapse_util_caches_response_cache:hits", "", ["name"])
|
||||
|
@ -53,8 +43,15 @@ response_cache_evicted = Gauge(
|
|||
response_cache_total = Gauge("synapse_util_caches_response_cache:total", "", ["name"])
|
||||
|
||||
|
||||
def register_cache(cache_type, cache_name, cache, collect_callback=None):
|
||||
"""Register a cache object for metric collection.
|
||||
def register_cache(
|
||||
cache_type,
|
||||
cache_name,
|
||||
cache,
|
||||
collect_callback=None,
|
||||
resizable=True,
|
||||
resize_callback=None,
|
||||
):
|
||||
"""Register a cache object for metric collection and resizing.
|
||||
|
||||
Args:
|
||||
cache_type (str):
|
||||
|
@ -66,13 +63,15 @@ def register_cache(cache_type, cache_name, cache, collect_callback=None):
|
|||
Returns:
|
||||
CacheMetric: an object which provides inc_{hits,misses,evictions} methods
|
||||
"""
|
||||
if resizable:
|
||||
if not resize_callback:
|
||||
resize_callback = getattr(cache, "set_cache_factor")
|
||||
add_resizable_cache(cache_name, resize_callback)
|
||||
|
||||
# Check if the metric is already registered. Unregister it, if so.
|
||||
# This usually happens during tests, as at runtime these caches are
|
||||
# effectively singletons.
|
||||
metric_name = "cache_%s_%s" % (cache_type, cache_name)
|
||||
if metric_name in collectors_by_name.keys():
|
||||
REGISTRY.unregister(collectors_by_name[metric_name])
|
||||
|
||||
class CacheMetric(object):
|
||||
|
||||
|
@ -104,16 +103,15 @@ def register_cache(cache_type, cache_name, cache, collect_callback=None):
|
|||
cache_hits.labels(cache_name).set(self.hits)
|
||||
cache_evicted.labels(cache_name).set(self.evicted_size)
|
||||
cache_total.labels(cache_name).set(self.hits + self.misses)
|
||||
if hasattr(cache, "max_size"):
|
||||
cache_max_size.labels(cache_name).set(cache.max_size)
|
||||
if collect_callback:
|
||||
collect_callback()
|
||||
except Exception as e:
|
||||
logger.warning("Error calculating metrics for %s: %s", cache_name, e)
|
||||
raise
|
||||
|
||||
yield GaugeMetricFamily("__unused", "")
|
||||
|
||||
metric = CacheMetric()
|
||||
REGISTRY.register(metric)
|
||||
caches_by_name[cache_name] = cache
|
||||
collectors_by_name[metric_name] = metric
|
||||
return metric
|
||||
|
|
|
@ -13,6 +13,7 @@
|
|||
# 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.
|
||||
|
||||
import functools
|
||||
import inspect
|
||||
import logging
|
||||
|
@ -30,7 +31,6 @@ from twisted.internet import defer
|
|||
from synapse.logging.context import make_deferred_yieldable, preserve_fn
|
||||
from synapse.util import unwrapFirstError
|
||||
from synapse.util.async_helpers import ObservableDeferred
|
||||
from synapse.util.caches import get_cache_factor_for
|
||||
from synapse.util.caches.lrucache import LruCache
|
||||
from synapse.util.caches.treecache import TreeCache, iterate_tree_cache_entry
|
||||
|
||||
|
@ -81,7 +81,6 @@ class CacheEntry(object):
|
|||
class Cache(object):
|
||||
__slots__ = (
|
||||
"cache",
|
||||
"max_entries",
|
||||
"name",
|
||||
"keylen",
|
||||
"thread",
|
||||
|
@ -111,6 +110,10 @@ class Cache(object):
|
|||
collect_callback=self._metrics_collection_callback,
|
||||
)
|
||||
|
||||
@property
|
||||
def max_entries(self):
|
||||
return self.cache.max_size
|
||||
|
||||
def _on_evicted(self, evicted_count):
|
||||
self.metrics.inc_evictions(evicted_count)
|
||||
|
||||
|
@ -370,8 +373,6 @@ class CacheDescriptor(_CacheDescriptorBase):
|
|||
cache_context=cache_context,
|
||||
)
|
||||
|
||||
max_entries = int(max_entries * get_cache_factor_for(orig.__name__))
|
||||
|
||||
self.max_entries = max_entries
|
||||
self.tree = tree
|
||||
self.iterable = iterable
|
||||
|
|
|
@ -66,7 +66,7 @@ class ExpiringCache(object):
|
|||
|
||||
self.iterable = iterable
|
||||
|
||||
self.metrics = register_cache("expiring", cache_name, self)
|
||||
self.metrics = register_cache("expiring", cache_name, self, resizable=False)
|
||||
|
||||
if not self._expiry_ms:
|
||||
# Don't bother starting the loop if things never expire
|
||||
|
|
|
@ -14,9 +14,11 @@
|
|||
# limitations under the License.
|
||||
|
||||
|
||||
import math
|
||||
import threading
|
||||
from functools import wraps
|
||||
|
||||
from synapse.config import cache as cache_config
|
||||
from synapse.util.caches.treecache import TreeCache
|
||||
|
||||
|
||||
|
@ -76,6 +78,11 @@ class LruCache(object):
|
|||
"""
|
||||
cache = cache_type()
|
||||
self.cache = cache # Used for introspection.
|
||||
|
||||
# Save the original max size, and apply the default size factor.
|
||||
self._original_max_size = max_size
|
||||
self.max_size = math.floor(max_size * cache_config.DEFAULT_CACHE_SIZE_FACTOR)
|
||||
|
||||
list_root = _Node(None, None, None, None)
|
||||
list_root.next_node = list_root
|
||||
list_root.prev_node = list_root
|
||||
|
@ -83,7 +90,7 @@ class LruCache(object):
|
|||
lock = threading.Lock()
|
||||
|
||||
def evict():
|
||||
while cache_len() > max_size:
|
||||
while cache_len() > self.max_size:
|
||||
todelete = list_root.prev_node
|
||||
evicted_len = delete_node(todelete)
|
||||
cache.pop(todelete.key, None)
|
||||
|
@ -236,6 +243,7 @@ class LruCache(object):
|
|||
return key in cache
|
||||
|
||||
self.sentinel = object()
|
||||
self._on_resize = evict
|
||||
self.get = cache_get
|
||||
self.set = cache_set
|
||||
self.setdefault = cache_set_default
|
||||
|
@ -266,3 +274,20 @@ class LruCache(object):
|
|||
|
||||
def __contains__(self, key):
|
||||
return self.contains(key)
|
||||
|
||||
def set_cache_factor(self, factor: float) -> bool:
|
||||
"""
|
||||
Set the cache factor for this individual cache.
|
||||
|
||||
This will trigger a resize if it changes, which may require evicting
|
||||
items from the cache.
|
||||
|
||||
Returns:
|
||||
bool: Whether the cache changed size or not.
|
||||
"""
|
||||
new_size = math.floor(self._original_max_size * factor)
|
||||
if new_size != self.max_size:
|
||||
self.max_size = new_size
|
||||
self._on_resize()
|
||||
return True
|
||||
return False
|
||||
|
|
|
@ -38,7 +38,7 @@ class ResponseCache(object):
|
|||
self.timeout_sec = timeout_ms / 1000.0
|
||||
|
||||
self._name = name
|
||||
self._metrics = register_cache("response_cache", name, self)
|
||||
self._metrics = register_cache("response_cache", name, self, resizable=False)
|
||||
|
||||
def size(self):
|
||||
return len(self.pending_result_cache)
|
||||
|
|
|
@ -14,11 +14,13 @@
|
|||
# limitations under the License.
|
||||
|
||||
import logging
|
||||
import math
|
||||
|
||||
from six import integer_types
|
||||
|
||||
from sortedcontainers import SortedDict
|
||||
|
||||
from synapse.config import cache as cache_config
|
||||
from synapse.util import caches
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
|
@ -35,17 +37,37 @@ class StreamChangeCache(object):
|
|||
"""
|
||||
|
||||
def __init__(self, name, current_stream_pos, max_size=10000, prefilled_cache=None):
|
||||
self._max_size = int(max_size * caches.CACHE_SIZE_FACTOR)
|
||||
self._original_max_size = max_size
|
||||
self.max_size = math.floor(max_size * cache_config.DEFAULT_CACHE_SIZE_FACTOR)
|
||||
self._entity_to_key = {}
|
||||
self._cache = SortedDict()
|
||||
self._earliest_known_stream_pos = current_stream_pos
|
||||
self.name = name
|
||||
self.metrics = caches.register_cache("cache", self.name, self._cache)
|
||||
self.metrics = caches.register_cache(
|
||||
"cache", self.name, self._cache, resize_callback=self.set_cache_factor
|
||||
)
|
||||
|
||||
if prefilled_cache:
|
||||
for entity, stream_pos in prefilled_cache.items():
|
||||
self.entity_has_changed(entity, stream_pos)
|
||||
|
||||
def set_cache_factor(self, factor: float) -> bool:
|
||||
"""
|
||||
Set the cache factor for this individual cache.
|
||||
|
||||
This will trigger a resize if it changes, which may require evicting
|
||||
items from the cache.
|
||||
|
||||
Returns:
|
||||
bool: Whether the cache changed size or not.
|
||||
"""
|
||||
new_size = math.floor(self._original_max_size * factor)
|
||||
if new_size != self.max_size:
|
||||
self.max_size = new_size
|
||||
self._evict()
|
||||
return True
|
||||
return False
|
||||
|
||||
def has_entity_changed(self, entity, stream_pos):
|
||||
"""Returns True if the entity may have been updated since stream_pos
|
||||
"""
|
||||
|
@ -133,13 +155,13 @@ class StreamChangeCache(object):
|
|||
self._cache.pop(old_pos, None)
|
||||
self._cache[stream_pos] = entity
|
||||
self._entity_to_key[entity] = stream_pos
|
||||
self._evict()
|
||||
|
||||
while len(self._cache) > self._max_size:
|
||||
k, r = self._cache.popitem(0)
|
||||
self._earliest_known_stream_pos = max(
|
||||
k, self._earliest_known_stream_pos
|
||||
)
|
||||
self._entity_to_key.pop(r, None)
|
||||
def _evict(self):
|
||||
while len(self._cache) > self.max_size:
|
||||
k, r = self._cache.popitem(0)
|
||||
self._earliest_known_stream_pos = max(k, self._earliest_known_stream_pos)
|
||||
self._entity_to_key.pop(r, None)
|
||||
|
||||
def get_max_pos_of_last_change(self, entity):
|
||||
"""Returns an upper bound of the stream id of the last change to an
|
||||
|
|
|
@ -38,7 +38,7 @@ class TTLCache(object):
|
|||
|
||||
self._timer = timer
|
||||
|
||||
self._metrics = register_cache("ttl", cache_name, self)
|
||||
self._metrics = register_cache("ttl", cache_name, self, resizable=False)
|
||||
|
||||
def set(self, key, value, ttl):
|
||||
"""Add/update an entry in the cache
|
||||
|
|
|
@ -25,8 +25,8 @@ from synapse.util.caches.descriptors import Cache, cached
|
|||
from tests import unittest
|
||||
|
||||
|
||||
class CacheTestCase(unittest.TestCase):
|
||||
def setUp(self):
|
||||
class CacheTestCase(unittest.HomeserverTestCase):
|
||||
def prepare(self, reactor, clock, homeserver):
|
||||
self.cache = Cache("test")
|
||||
|
||||
def test_empty(self):
|
||||
|
@ -96,7 +96,7 @@ class CacheTestCase(unittest.TestCase):
|
|||
cache.get(3)
|
||||
|
||||
|
||||
class CacheDecoratorTestCase(unittest.TestCase):
|
||||
class CacheDecoratorTestCase(unittest.HomeserverTestCase):
|
||||
@defer.inlineCallbacks
|
||||
def test_passthrough(self):
|
||||
class A(object):
|
||||
|
@ -239,7 +239,7 @@ class CacheDecoratorTestCase(unittest.TestCase):
|
|||
callcount2 = [0]
|
||||
|
||||
class A(object):
|
||||
@cached(max_entries=4) # HACK: This makes it 2 due to cache factor
|
||||
@cached(max_entries=2)
|
||||
def func(self, key):
|
||||
callcount[0] += 1
|
||||
return key
|
||||
|
|
|
@ -15,6 +15,7 @@
|
|||
# limitations under the License.
|
||||
|
||||
from synapse.metrics import REGISTRY, InFlightGauge, generate_latest
|
||||
from synapse.util.caches.descriptors import Cache
|
||||
|
||||
from tests import unittest
|
||||
|
||||
|
@ -129,3 +130,36 @@ class BuildInfoTests(unittest.TestCase):
|
|||
self.assertTrue(b"osversion=" in items[0])
|
||||
self.assertTrue(b"pythonversion=" in items[0])
|
||||
self.assertTrue(b"version=" in items[0])
|
||||
|
||||
|
||||
class CacheMetricsTests(unittest.HomeserverTestCase):
|
||||
def test_cache_metric(self):
|
||||
"""
|
||||
Caches produce metrics reflecting their state when scraped.
|
||||
"""
|
||||
CACHE_NAME = "cache_metrics_test_fgjkbdfg"
|
||||
cache = Cache(CACHE_NAME, max_entries=777)
|
||||
|
||||
items = {
|
||||
x.split(b"{")[0].decode("ascii"): x.split(b" ")[1].decode("ascii")
|
||||
for x in filter(
|
||||
lambda x: b"cache_metrics_test_fgjkbdfg" in x,
|
||||
generate_latest(REGISTRY).split(b"\n"),
|
||||
)
|
||||
}
|
||||
|
||||
self.assertEqual(items["synapse_util_caches_cache_size"], "0.0")
|
||||
self.assertEqual(items["synapse_util_caches_cache_max_size"], "777.0")
|
||||
|
||||
cache.prefill("1", "hi")
|
||||
|
||||
items = {
|
||||
x.split(b"{")[0].decode("ascii"): x.split(b" ")[1].decode("ascii")
|
||||
for x in filter(
|
||||
lambda x: b"cache_metrics_test_fgjkbdfg" in x,
|
||||
generate_latest(REGISTRY).split(b"\n"),
|
||||
)
|
||||
}
|
||||
|
||||
self.assertEqual(items["synapse_util_caches_cache_size"], "1.0")
|
||||
self.assertEqual(items["synapse_util_caches_cache_max_size"], "777.0")
|
||||
|
|
|
@ -22,7 +22,7 @@ from synapse.util.caches.treecache import TreeCache
|
|||
from .. import unittest
|
||||
|
||||
|
||||
class LruCacheTestCase(unittest.TestCase):
|
||||
class LruCacheTestCase(unittest.HomeserverTestCase):
|
||||
def test_get_set(self):
|
||||
cache = LruCache(1)
|
||||
cache["key"] = "value"
|
||||
|
|
|
@ -1,11 +1,9 @@
|
|||
from mock import patch
|
||||
|
||||
from synapse.util.caches.stream_change_cache import StreamChangeCache
|
||||
|
||||
from tests import unittest
|
||||
|
||||
|
||||
class StreamChangeCacheTests(unittest.TestCase):
|
||||
class StreamChangeCacheTests(unittest.HomeserverTestCase):
|
||||
"""
|
||||
Tests for StreamChangeCache.
|
||||
"""
|
||||
|
@ -46,7 +44,6 @@ class StreamChangeCacheTests(unittest.TestCase):
|
|||
self.assertTrue(cache.has_entity_changed("user@foo.com", 0))
|
||||
self.assertTrue(cache.has_entity_changed("not@here.website", 0))
|
||||
|
||||
@patch("synapse.util.caches.CACHE_SIZE_FACTOR", 1.0)
|
||||
def test_has_entity_changed_pops_off_start(self):
|
||||
"""
|
||||
StreamChangeCache.entity_has_changed will respect the max size and
|
||||
|
|
|
@ -162,6 +162,7 @@ def default_config(name, parse=False):
|
|||
# disable user directory updates, because they get done in the
|
||||
# background, which upsets the test runner.
|
||||
"update_user_directory": False,
|
||||
"caches": {"global_factor": 1},
|
||||
}
|
||||
|
||||
if parse:
|
||||
|
|
Loading…
Reference in New Issue