Chris Dent
76b53798b6
In the review of I4215cc69cedae5637102b75e0b54fd26acb1826c there were some suggested improvements that did not get implemented because we needed the better logging sooner than later. This change implements those cleanups including: * use ',' instead of '%' for string interpolation in calls to LOG * add microversion information to log string, if present Change-Id: I6682215d72b644217b5122073d993a99f7830e5b Closes-Bug: #1619690
83 lines
2.9 KiB
Python
83 lines
2.9 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.
|
|
"""Simple middleware for request logging."""
|
|
|
|
from oslo_log import log as logging
|
|
|
|
from nova.api.openstack.placement import microversion
|
|
|
|
LOG = logging.getLogger(__name__)
|
|
|
|
|
|
class RequestLog(object):
|
|
"""WSGI Middleware to write a simple request log to.
|
|
|
|
Borrowed from Paste Translogger
|
|
"""
|
|
|
|
format = ('%(REMOTE_ADDR)s "%(REQUEST_METHOD)s %(REQUEST_URI)s" '
|
|
'status: %(status)s len: %(bytes)s '
|
|
'microversion: %(microversion)s')
|
|
|
|
def __init__(self, application):
|
|
self.application = application
|
|
|
|
def __call__(self, environ, start_response):
|
|
LOG.debug('Starting request: %s "%s %s"',
|
|
environ['REMOTE_ADDR'], environ['REQUEST_METHOD'],
|
|
self._get_uri(environ))
|
|
if LOG.isEnabledFor(logging.INFO):
|
|
return self._log_app(environ, start_response)
|
|
else:
|
|
return self.application(environ, start_response)
|
|
|
|
@staticmethod
|
|
def _get_uri(environ):
|
|
req_uri = (environ.get('SCRIPT_NAME', '')
|
|
+ environ.get('PATH_INFO', ''))
|
|
if environ.get('QUERY_STRING'):
|
|
req_uri += '?' + environ['QUERY_STRING']
|
|
return req_uri
|
|
|
|
def _log_app(self, environ, start_response):
|
|
req_uri = self._get_uri(environ)
|
|
|
|
def replacement_start_response(status, headers, exc_info=None):
|
|
"""We need to gaze at the content-length, if set, to
|
|
write log info.
|
|
"""
|
|
size = None
|
|
for name, value in headers:
|
|
if name.lower() == 'content-length':
|
|
size = value
|
|
self.write_log(environ, req_uri, status, size)
|
|
return start_response(status, headers, exc_info)
|
|
|
|
return self.application(environ, replacement_start_response)
|
|
|
|
def write_log(self, environ, req_uri, status, size):
|
|
"""Write the log info out in a formatted form to ``LOG.info``.
|
|
"""
|
|
if size is None:
|
|
size = '-'
|
|
log_format = {
|
|
'REMOTE_ADDR': environ.get('REMOTE_ADDR', '-'),
|
|
'REQUEST_METHOD': environ['REQUEST_METHOD'],
|
|
'REQUEST_URI': req_uri,
|
|
'status': status.split(None, 1)[0],
|
|
'bytes': size,
|
|
'microversion': environ.get(
|
|
microversion.MICROVERSION_ENVIRON, '-'),
|
|
}
|
|
LOG.info(self.format, log_format)
|