b6c4489960
Ensure each exported class has a docstring. Add API to the sphinx docs. Fix a few formatting issues so the rendered docs look OK. Change-Id: Ieef7bae3783a084249169fe9b80ab17518eee15f
41 lines
1.4 KiB
Python
41 lines
1.4 KiB
Python
# Copyright (c) 2013 NEC Corporation
|
|
# All Rights Reserved.
|
|
#
|
|
# 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.
|
|
|
|
import webob.dec
|
|
|
|
from oslo.middleware import base
|
|
from oslo.middleware.openstack.common import context
|
|
|
|
|
|
ENV_REQUEST_ID = 'openstack.request_id'
|
|
HTTP_RESP_HEADER_REQUEST_ID = 'x-openstack-request-id'
|
|
|
|
|
|
class RequestId(base.Middleware):
|
|
"""Middleware that ensures request ID.
|
|
|
|
It ensures to assign request ID for each API request and set it to
|
|
request environment. The request ID is also added to API response.
|
|
"""
|
|
|
|
@webob.dec.wsgify
|
|
def __call__(self, req):
|
|
req_id = context.generate_request_id()
|
|
req.environ[ENV_REQUEST_ID] = req_id
|
|
response = req.get_response(self.application)
|
|
if HTTP_RESP_HEADER_REQUEST_ID not in response.headers:
|
|
response.headers.add(HTTP_RESP_HEADER_REQUEST_ID, req_id)
|
|
return response
|