logging speedup flag -m added

Author: s-m-e

CHANGES.rst

@@ -4,7 +4,7 @@ Changes
 0.0.4 (2019-XX-XX)
 ------------------
 
-* (TBD)
+* FEATURE: New flag ``-m``, explicitly excluding all operations from the log that do not have the potential to change the filesystem. Added for convenience.
 
 0.0.3 (2019-05-01)
 ------------------

src/loggedfs/_core/cli.py

@@ -82,11 +82,16 @@
 	help = 'Run in library mode. DO NOT USE THIS FROM THE COMMAND LINE!',
 	hidden = True
 	)
+@click.option(
+	'-m', '--only-modify-operations',
+	is_flag = True,
+	help = 'Exclude logging of all operations that can not cause changes in the filesystem. Convenience flag for accelerated logging.'
+	)
 @click.argument(
 	'directory',
 	type = click.Path(exists = True, file_okay = False, dir_okay = True, resolve_path = True)
 	)
-def cli_entry(f, p, c, s, l, json, buffers, lib, directory):
+def cli_entry(f, p, c, s, l, json, buffers, lib, only_modify_operations, directory):
 	"""LoggedFS-python is a transparent fuse-filesystem which allows to log
 	every operation that happens in the backend filesystem. Logs can be written
 	to syslog, to a file, or to the standard output. LoggedFS-python allows to specify an XML
@@ -97,7 +102,7 @@ def cli_entry(f, p, c, s, l, json, buffers, lib, directory):
 
 	loggedfs_factory(
 		directory,
-		**__process_config__(c, l, s, f, p, json, buffers, lib)
+		**__process_config__(c, l, s, f, p, json, buffers, lib, only_modify_operations)
 		)
 
 
@@ -109,7 +114,8 @@ def __process_config__(
 	fuse_allowother,
 	log_json,
 	log_buffers,
-	lib_mode
+	lib_mode,
+	log_only_modify_operations
 	):
 
 	if config_fh is not None:
@@ -135,6 +141,7 @@ def __process_config__(
 		'log_file': log_file,
 		'log_filter': filter_obj,
 		'log_json': log_json,
+		'log_only_modify_operations': log_only_modify_operations,
 		'log_printprocessname': log_printprocessname,
 		'log_syslog': not log_syslog_off
 		}

src/loggedfs/_core/defaults.py

@@ -37,5 +37,6 @@
 LOG_BUFFERS_DEFAULT = False
 LOG_ENABLED_DEFAULT = True
 LOG_JSON_DEFAULT = False
+LOG_ONLYMODIFYOPERATIONS_DEFAULT = False
 LOG_PRINTPROCESSNAME_DEFAULT = True
 LOG_SYSLOG_DEFAULT = False

src/loggedfs/_core/fs.py

@@ -53,6 +53,7 @@
 	LOG_BUFFERS_DEFAULT,
 	LOG_ENABLED_DEFAULT,
 	LOG_JSON_DEFAULT,
+	LOG_ONLYMODIFYOPERATIONS_DEFAULT,
 	LOG_PRINTPROCESSNAME_DEFAULT,
 	LOG_SYSLOG_DEFAULT
 	)
@@ -131,6 +132,7 @@ def __init__(self,
 		log_file = None,
 		log_filter = None,
 		log_json = LOG_JSON_DEFAULT,
+		log_only_modify_operations = LOG_ONLYMODIFYOPERATIONS_DEFAULT,
 		log_printprocessname = LOG_PRINTPROCESSNAME_DEFAULT,
 		log_syslog = LOG_SYSLOG_DEFAULT,
 		**kwargs
@@ -169,6 +171,8 @@ def __init__(self,
 			raise TypeError('log_buffers must be of type bool')
 		if not isinstance(lib_mode, bool):
 			raise TypeError('lib_mode must be of type bool')
+		if not isinstance(log_only_modify_operations, bool):
+			raise TypeError('log_only_modify_operations must be of type bool')
 
 		if not isinstance(fuse_foreground, bool):
 			raise TypeError('fuse_foreground must be of type bool')
@@ -181,6 +185,7 @@ def __init__(self,
 		self._log_buffers = log_buffers
 		self._log_filter = log_filter
 		self._lib_mode = lib_mode
+		self._log_only_modify_operations = log_only_modify_operations
 
 		self._logger = get_logger('LoggedFS-python', log_enabled, log_file, log_syslog, self._log_json)
 

src/loggedfs/_core/out.py

@@ -183,6 +183,23 @@ def _log_event_(
 	ret_status, ret_value
 	):
 
+	if self._log_only_modify_operations:
+		if func.__name__ not in (
+			'chmod',
+			'chown',
+			'link',
+			'mkdir',
+			'mknod',
+			'rename',
+			'rmdir',
+			'symlink',
+			'truncate',
+			'unlink',
+			'utimens',
+			'write'
+			):
+			return
+
 	uid, gid, pid = fuse_get_context()
 
 	p_cmdname = ''