diff --git a/synapse/util/caches/__init__.py b/synapse/util/caches/__init__.py
index da5077b471..dd356bf156 100644
--- a/synapse/util/caches/__init__.py
+++ b/synapse/util/caches/__init__.py
@@ -1,6 +1,6 @@
# -*- coding: utf-8 -*-
# Copyright 2015, 2016 OpenMarket Ltd
-# Copyright 2019 The Matrix.org Foundation C.I.C.
+# Copyright 2019, 2020 The 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.
@@ -15,28 +15,16 @@
# limitations under the License.
import logging
-import os
-from typing import Dict
+from sys import intern
+from typing import Callable, Dict, Optional
-import six
-from six.moves import intern
+import attr
+from prometheus_client.core import Gauge
-from prometheus_client.core import REGISTRY, Gauge, GaugeMetricFamily
+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 +32,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,67 +42,82 @@ 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.
+@attr.s
+class CacheMetric(object):
+
+ _cache = attr.ib()
+ _cache_type = attr.ib(type=str)
+ _cache_name = attr.ib(type=str)
+ _collect_callback = attr.ib(type=Optional[Callable])
+
+ hits = attr.ib(default=0)
+ misses = attr.ib(default=0)
+ evicted_size = attr.ib(default=0)
+
+ def inc_hits(self):
+ self.hits += 1
+
+ def inc_misses(self):
+ self.misses += 1
+
+ def inc_evictions(self, size=1):
+ self.evicted_size += size
+
+ def describe(self):
+ return []
+
+ def collect(self):
+ try:
+ if self._cache_type == "response_cache":
+ response_cache_size.labels(self._cache_name).set(len(self._cache))
+ response_cache_hits.labels(self._cache_name).set(self.hits)
+ response_cache_evicted.labels(self._cache_name).set(self.evicted_size)
+ response_cache_total.labels(self._cache_name).set(
+ self.hits + self.misses
+ )
+ else:
+ cache_size.labels(self._cache_name).set(len(self._cache))
+ cache_hits.labels(self._cache_name).set(self.hits)
+ cache_evicted.labels(self._cache_name).set(self.evicted_size)
+ cache_total.labels(self._cache_name).set(self.hits + self.misses)
+ if getattr(self._cache, "max_size", None):
+ cache_max_size.labels(self._cache_name).set(self._cache.max_size)
+ if self._collect_callback:
+ self._collect_callback()
+ except Exception as e:
+ logger.warning("Error calculating metrics for %s: %s", self._cache_name, e)
+ raise
+
+
+def register_cache(
+ cache_type: str,
+ cache_name: str,
+ cache,
+ collect_callback: Optional[Callable] = None,
+ resizable: bool = True,
+ resize_callback: Optional[Callable] = None,
+) -> CacheMetric:
+ """Register a cache object for metric collection and resizing.
Args:
- cache_type (str):
- cache_name (str): name of the cache
- cache (object): cache itself
- collect_callback (callable|None): if not None, a function which is called during
- metric collection to update additional metrics.
+ cache_type
+ cache_name: name of the cache
+ cache: cache itself
+ collect_callback: If given, a function which is called during metric
+ collection to update additional metrics.
+ resizable: Whether this cache supports being resized.
+ resize_callback: A function which can be called to resize the cache.
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 = CacheMetric(cache, cache_type, cache_name, collect_callback)
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):
-
- hits = 0
- misses = 0
- evicted_size = 0
-
- def inc_hits(self):
- self.hits += 1
-
- def inc_misses(self):
- self.misses += 1
-
- def inc_evictions(self, size=1):
- self.evicted_size += size
-
- def describe(self):
- return []
-
- def collect(self):
- try:
- if cache_type == "response_cache":
- response_cache_size.labels(cache_name).set(len(cache))
- response_cache_hits.labels(cache_name).set(self.hits)
- response_cache_evicted.labels(cache_name).set(self.evicted_size)
- response_cache_total.labels(cache_name).set(self.hits + self.misses)
- else:
- cache_size.labels(cache_name).set(len(cache))
- 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 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
@@ -148,9 +152,6 @@ def intern_string(string):
return None
try:
- if six.PY2:
- string = string.encode("ascii")
-
return intern(string)
except UnicodeEncodeError:
return string
|
