openstack/ironic-python-agent
Code Issues Proposed changes

Merge "Fix confusing logging when running asynchronous commands"

Browse Source
This commit is contained in:
Zuul 2020-06-29 22:40:02 +00:00 committed by Gerrit Code Review
commit f97f8e2c06
2 changed files with 14 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
ironic_python_agent/extensions/base.py
View File

@ -164,7 +164,7 @@ class AsyncCommandResult(BaseCommandResult):
if isinstance(result, (bytes, str)): if isinstance(result, (bytes, str)):
result = {'result': '{}: {}'.format(self.command_name, result)} result = {'result': '{}: {}'.format(self.command_name, result)}
LOG.info('Command: %(name)s, result: %(result)s', LOG.info('Asynchronous command %(name)s completed: %(result)s',
{'name': self.command_name, {'name': self.command_name,
'result': utils.remove_large_keys(result)}) 'result': utils.remove_large_keys(result)})
with self.command_state_lock: with self.command_state_lock:
@ -270,9 +270,6 @@ class ExecuteCommandMixin(object):
# recorded as a failed SyncCommandResult with an error message # recorded as a failed SyncCommandResult with an error message
LOG.exception('Command execution error: %s', e) LOG.exception('Command execution error: %s', e)
result = SyncCommandResult(command_name, kwargs, False, e) result = SyncCommandResult(command_name, kwargs, False, e)
LOG.info('Command %(name)s completed: %(result)s',
{'name': command_name,
'result': utils.remove_large_keys(result)})
self.command_results[result.id] = result self.command_results[result.id] = result
return result return result
@ -299,10 +296,13 @@ def async_command(command_name, validator=None):
# know about the mode # know about the mode
bound_func = functools.partial(func, self) bound_func = functools.partial(func, self)
return AsyncCommandResult(command_name, ret = AsyncCommandResult(command_name,
command_params, command_params,
bound_func, bound_func,
agent=self.agent).start() agent=self.agent).start()
LOG.info('Asynchronous command %(name)s started execution',
{'name': command_name})
return ret
return wrapper return wrapper
return async_decorator return async_decorator
@ -325,6 +325,9 @@ def sync_command(command_name, validator=None):
validator(self, **command_params) validator(self, **command_params)
result = func(self, **command_params) result = func(self, **command_params)
LOG.info('Synchronous command %(name)s completed: %(result)s',
{'name': command_name,
'result': utils.remove_large_keys(result)})
return SyncCommandResult(command_name, return SyncCommandResult(command_name,
command_params, command_params,
True, True,

5
ironic_python_agent/utils.py
View File

@ -634,10 +634,9 @@ _LARGE_KEYS = frozenset(['configdrive', 'system_logs'])
def remove_large_keys(var): def remove_large_keys(var):
"""Remove specific keys from the var, recursing into dicts and lists.""" """Remove specific keys from the var, recursing into dicts and lists."""
if isinstance(var, abc.Mapping): if isinstance(var, abc.Mapping):
return var.__class__( return {key: (remove_large_keys(value)
(key, remove_large_keys(value)
if key not in _LARGE_KEYS else '<...>') if key not in _LARGE_KEYS else '<...>')
for key, value in var.items()) for key, value in var.items()}
elif isinstance(var, abc.Sequence) and not isinstance(var, str): elif isinstance(var, abc.Sequence) and not isinstance(var, str):
return var.__class__(map(remove_large_keys, var)) return var.__class__(map(remove_large_keys, var))
else: else: