keystone/keystone/cmd/doctor/caching.py

61 lines
2.0 KiB
Python

# 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.
from keystone.common import cache
import keystone.conf
CONF = keystone.conf.CONF
def symptom_caching_disabled():
"""`keystone.conf [cache] enabled` is not enabled.
Caching greatly improves the performance of keystone, and it is highly
recommended that you enable it.
"""
return not CONF.cache.enabled
def symptom_caching_enabled_without_a_backend():
"""Caching is not completely configured.
Although caching is enabled in `keystone.conf [cache] enabled`, the default
backend is still set to the no-op backend. Instead, configure keystone to
point to a real caching backend like memcached.
"""
return CONF.cache.enabled and CONF.cache.backend == 'dogpile.cache.null'
def symptom_connection_to_memcached():
"""Memcached isn't reachable.
Caching is enabled and the `keystone.conf [cache] backend` option is
configured but one or more Memcached servers are not reachable or marked
as dead. Please ensure `keystone.conf [cache] memcache_servers` is
configured properly.
"""
memcached_drivers = [
'dogpile.cache.memcached',
'oslo_cache.memcache_pool'
]
if CONF.cache.enabled and CONF.cache.backend in memcached_drivers:
cache.configure_cache()
cache_stats = cache.CACHE_REGION.actual_backend.client.get_stats()
memcached_server_count = len(CONF.cache.memcache_servers)
if len(cache_stats) != memcached_server_count:
return True
else:
return False
else:
return False