d8e2043b2f
The value of the X-Trans-Id-Extra header on the request (if any) will now be appended to the transaction ID. This lets users put their own information into transaction IDs. For example, Glance folks upload images as large objects, so they'd like to be able to tie together all the segment PUTs and the manifest PUT with some operation ID in the logs. This would let them pass in that operation ID as X-Trans-Id-Extra, and then when things went wrong, it'd be much easier to find all the requests in Swift's logs. Also, this aids debuggability when requests fail to receive responses. If a user is sending in their own X-Trans-Id-Extra strings, then that gives operators something to search for in the logs. The normal txid won't work since that's in the response, but the client didn't receive one. Swift will only use the first 32 characters of X-Trans-Id-Extra so that its log lines stay a manageable length. Also, it's URL-quoted so that users cannot inject double quotes into X-Trans-Id-Extra and screw up log parsers. DocImpact Change-Id: I3c51d0c5ac55697ac230001840da219e73a03157
87 lines
3.0 KiB
Python
87 lines
3.0 KiB
Python
# Copyright (c) 2010-2012 OpenStack Foundation
|
|
#
|
|
# 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.
|
|
|
|
from swift import gettext_ as _
|
|
|
|
from swift.common.swob import Request, HTTPServerError
|
|
from swift.common.utils import get_logger, generate_trans_id
|
|
from swift.common.wsgi import WSGIContext
|
|
|
|
|
|
class CatchErrorsContext(WSGIContext):
|
|
|
|
def __init__(self, app, logger, trans_id_suffix=''):
|
|
super(CatchErrorsContext, self).__init__(app)
|
|
self.logger = logger
|
|
self.trans_id_suffix = trans_id_suffix
|
|
|
|
def handle_request(self, env, start_response):
|
|
trans_id_suffix = self.trans_id_suffix
|
|
trans_id_extra = env.get('HTTP_X_TRANS_ID_EXTRA')
|
|
if trans_id_extra:
|
|
trans_id_suffix += '-' + trans_id_extra[:32]
|
|
|
|
trans_id = generate_trans_id(trans_id_suffix)
|
|
env['swift.trans_id'] = trans_id
|
|
self.logger.txn_id = trans_id
|
|
try:
|
|
# catch any errors in the pipeline
|
|
resp = self._app_call(env)
|
|
except: # noqa
|
|
self.logger.exception(_('Error: An error occurred'))
|
|
resp = HTTPServerError(request=Request(env),
|
|
body='An error occurred',
|
|
content_type='text/plain')
|
|
resp.headers['X-Trans-Id'] = trans_id
|
|
return resp(env, start_response)
|
|
|
|
# make sure the response has the trans_id
|
|
if self._response_headers is None:
|
|
self._response_headers = []
|
|
self._response_headers.append(('X-Trans-Id', trans_id))
|
|
start_response(self._response_status, self._response_headers,
|
|
self._response_exc_info)
|
|
return resp
|
|
|
|
|
|
class CatchErrorMiddleware(object):
|
|
"""
|
|
Middleware that provides high-level error handling and ensures that a
|
|
transaction id will be set for every request.
|
|
"""
|
|
|
|
def __init__(self, app, conf):
|
|
self.app = app
|
|
self.logger = get_logger(conf, log_route='catch-errors')
|
|
self.trans_id_suffix = conf.get('trans_id_suffix', '')
|
|
|
|
def __call__(self, env, start_response):
|
|
"""
|
|
If used, this should be the first middleware in pipeline.
|
|
"""
|
|
context = CatchErrorsContext(self.app,
|
|
self.logger,
|
|
self.trans_id_suffix)
|
|
return context.handle_request(env, start_response)
|
|
|
|
|
|
def filter_factory(global_conf, **local_conf):
|
|
conf = global_conf.copy()
|
|
conf.update(local_conf)
|
|
|
|
def except_filter(app):
|
|
return CatchErrorMiddleware(app, conf)
|
|
return except_filter
|