IntenseWebs/freeipa
3
0
Fork 0
mirror of https://salsa.debian.org/freeipa-team/freeipa.git synced 2025-02-25 18:55:28 -06:00
Code Issues Packages Projects Releases Wiki Activity

Add switch for LDAP cache debug output

Browse Source 
The LDAP cache log is rather chatty and a bit overwhelming when
looking for error messages. Disable it by default but allow it
to be enabled when a new config option, ldap_cache_debug, is
enabled.

Fixes: https://pagure.io/freeipa/issue/9180

Signed-off-by: Rob Crittenden <rcritten@redhat.com>
Reviewed-By: Alexander Bokovoy <abokovoy@redhat.com>
This commit is contained in:
Rob Crittenden 2022-06-13 14:32:04 -04:00 committed by Alexander Bokovoy
parent 7572174175
commit 05d96e16dc
4 changed files with 10 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
client/man/default.conf.5
View File

@ -119,6 +119,9 @@ Enable a per-request LDAP cache. The default is True.
.B ldap_cache_size <integer> .B ldap_cache_size <integer>
The maximum number of entries cached if ldap_cache is True. Since this cache is per-request it is not expected to be very large. The default is 100. Setting the value < 1 effectively disables the cache regardless of the ldap_cache setting The maximum number of entries cached if ldap_cache is True. Since this cache is per-request it is not expected to be very large. The default is 100. Setting the value < 1 effectively disables the cache regardless of the ldap_cache setting
.TP .TP
.B ldap_cache_debug <boolean>
Log details on hits, misses, etc. for the LDAP cache if the cache is enabled.
.TP
.B ldap_uri <URI> .B ldap_uri <URI>
Specifies the URI of the IPA LDAP server to connect to. The URI scheme may be one of \fBldap\fR or \fBldapi\fR. The default is to use ldapi, e.g. ldapi://%2fvar%2frun%2fslapd\-EXAMPLE\-COM.socket Specifies the URI of the IPA LDAP server to connect to. The URI scheme may be one of \fBldap\fR or \fBldapi\fR. The default is to use ldapi, e.g. ldapi://%2fvar%2frun%2fslapd\-EXAMPLE\-COM.socket
.TP .TP

1
ipalib/constants.py
View File

@ -170,6 +170,7 @@ DEFAULT_CONFIG = (
('ldap_cache', True), ('ldap_cache', True),
('ldap_cache_size', 100), ('ldap_cache_size', 100),
('ldap_cache_debug', False),
# Define an inclusive range of SSL/TLS version support # Define an inclusive range of SSL/TLS version support
('tls_version_min', TLS_VERSION_DEFAULT_MIN), ('tls_version_min', TLS_VERSION_DEFAULT_MIN),

7
ipapython/ipaldap.py
View File

@ -1768,15 +1768,18 @@ class LDAPCache(LDAPClient):
def __init__(self, ldap_uri, start_tls=False, force_schema_updates=False, def __init__(self, ldap_uri, start_tls=False, force_schema_updates=False,
no_schema=False, decode_attrs=True, cacert=None, no_schema=False, decode_attrs=True, cacert=None,
sasl_nocanon=True, enable_cache=True, cache_size=100): sasl_nocanon=True, enable_cache=True, cache_size=100,
debug_cache=False):
self.cache = OrderedDict() self.cache = OrderedDict()
self._enable_cache = True # initialize to zero to satisfy pylint self._enable_cache = True # initialize to zero to satisfy pylint
self._debug_cache = False # initialize to zero to satisfy pylint
object.__setattr__(self, '_cache_misses', 0) object.__setattr__(self, '_cache_misses', 0)
object.__setattr__(self, '_cache_hits', 0) object.__setattr__(self, '_cache_hits', 0)
object.__setattr__(self, '_enable_cache', object.__setattr__(self, '_enable_cache',
enable_cache and cache_size > 0) enable_cache and cache_size > 0)
object.__setattr__(self, '_debug_cache', debug_cache)
object.__setattr__(self, '_cache_size', cache_size) object.__setattr__(self, '_cache_size', cache_size)
super(LDAPCache, self).__init__( super(LDAPCache, self).__init__(
@ -1797,7 +1800,7 @@ class LDAPCache(LDAPClient):
return self._cache_size # pylint: disable=no-member return self._cache_size # pylint: disable=no-member
def emit(self, msg, *args, **kwargs): def emit(self, msg, *args, **kwargs):
if self._enable_cache: if self._enable_cache and self._debug_cache:
logger.debug(msg, *args, **kwargs) logger.debug(msg, *args, **kwargs)
def copy_entry(self, dn, entry, attrs=[]): def copy_entry(self, dn, entry, attrs=[]):

1
ipaserver/plugins/ldap2.py
View File

@ -66,6 +66,7 @@ class ldap2(CrudBackend, LDAPCache):
force_schema_updates=force_schema_updates, force_schema_updates=force_schema_updates,
enable_cache=api.env.ldap_cache and not force_schema_updates, enable_cache=api.env.ldap_cache and not force_schema_updates,
cache_size=api.env.ldap_cache_size, cache_size=api.env.ldap_cache_size,
debug_cache=api.env.ldap_cache_debug,
) )
self._time_limit = float(LDAPCache.time_limit) self._time_limit = float(LDAPCache.time_limit)