openstack/openstacksdk
Code Issues Proposed changes

Log request ids when debug logging is enabled

Browse Source 
If debug logging is enabled, it's fairly likely that's because a user
wants to debug things. Often times having the request id in the log is a
useful part of that.

Also, while we're in there, don't try to log information about the
object returned when there is no object to query. And log a useful
message on lists, and when we get objects from nova.

Change-Id: I02579227f3475a952006689182f6ca112fa1f7ed
This commit is contained in:
Monty Taylor 2017-01-09 09:42:00 -06:00
parent 68a8d513dd
commit 28e2b4c694
No known key found for this signature in database
GPG Key ID: 7BAE94BC7141A594
2 changed files with 20 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
shade/__init__.py
View File

@ -44,9 +44,9 @@ def simple_logging(debug=False, http_debug=False):
log = _log.setup_logging('keystoneauth')
log.addHandler(logging.StreamHandler())
log.setLevel(log_level)
# Simple case - we do not care about request id log
# Simple case - we only care about request id log during debug
log = _log.setup_logging('shade.request_ids')
log.setLevel(logging.INFO)
log.setLevel(log_level)
log = _log.setup_logging('shade')
log.addHandler(logging.StreamHandler())
log.setLevel(log_level)

23
shade/meta.py
View File

@ -429,12 +429,19 @@ def _log_request_id(obj, request_id):
if request_ids:
request_id = request_ids[0]
if request_id:
log = _log.setup_logging('shade.request_ids')
# Log the request id and object id in a specific logger. This way
# someone can turn it on if they're interested in this kind of tracing.
log.debug("Retreived object %(id)s. Request ID %(request_id)s",
{'id': obj.get('id', obj.get('uuid')),
'request_id': request_id})
log = _log.setup_logging('shade.request_ids')
obj_id = None
if isinstance(obj, dict):
obj_id = obj.get('id', obj.get('uuid'))
if obj_id:
log.debug("Retrieved object %(id)s. Request ID %(request_id)s",
{'id': obj.get('id', obj.get('uuid')),
'request_id': request_id})
else:
log.debug("Retrieved a response. Request ID %(request_id)s",
{'request_id': request_id})
return obj
@ -487,8 +494,14 @@ def obj_list_to_dict(obj_list, request_id=None):
the conversion to lists of dictonaries.
"""
new_list = []
if not request_id:
request_id = getattr(obj_list, 'request_ids', [None])[0]
if request_id:
log = _log.setup_logging('shade.request_ids')
log.debug("Retrieved a list. Request ID %(request_id)s",
{'request_id': request_id})
for obj in obj_list:
new_list.append(obj_to_dict(obj, request_id=request_id))
new_list.append(obj_to_dict(obj))
return new_list