49d83e356a
x-openstack-request-id is the common header name for request ID going forward. Nova, cinder, and neutron return this header. Using the request_id middleware is a convenient way to ensure this header is in the response. We will also be using the middleware to generate the request ID. The ID will be generated by the middleware and is inserted into the request environment. The current code generates the request ID in the constructor of RequestContext; with this change, the ID is generated beforehand and passed in to the RequestContext constructor. Not much different here: a request ID is generated and is available for use in the handling of the request. On the response end, the middleware is again used, this time to attach the x-openstack-request-id header, using the value of the generated request ID. For v3, we will be using the request_id middleware provided in oslo. For v2, nova-specific middleware (compute_request_id.py) is used. Therefore, v3 responses will have the header x-openstack-request-id, and v2 responses will have the header x-compute-request-id (no change). It is necessary to move the existing code out into middleware, so that the old header is not attached to v3 responses. UpgradeImpact: api-paste.ini is modified DocImpact: v3 responses of the API will only include x-openstack-request-id Implements: blueprint cross-service-request-id Change-Id: I5e370fd3de5ee2f8a8d13553015d88910ff5ea87
46 lines
1.5 KiB
Python
46 lines
1.5 KiB
Python
# Copyright (c) 2014 IBM Corp.
|
|
# 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.
|
|
|
|
"""Middleware that ensures x-compute-request-id
|
|
|
|
Using this middleware provides a convenient way to attach the
|
|
x-compute-request-id to only v2 responses. Previously, this header was set in
|
|
api/openstack/wsgi.py
|
|
|
|
Responses for APIv3 are taken care of by the request_id middleware provided
|
|
in oslo.
|
|
"""
|
|
|
|
import webob.dec
|
|
|
|
from nova.openstack.common import context
|
|
from nova.openstack.common.middleware import base
|
|
|
|
|
|
ENV_REQUEST_ID = 'openstack.request_id'
|
|
HTTP_RESP_HEADER_REQUEST_ID = 'x-compute-request-id'
|
|
|
|
|
|
class ComputeReqIdMiddleware(base.Middleware):
|
|
|
|
@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
|