Closes #11254: Introduce the X-Request-ID HTTP header to annotate the unique ID of each request for change logging

netbox/netbox/middleware.py

@@ -44,6 +44,9 @@ class CoreMiddleware:
         with change_logging(request):
             response = self.get_response(request)
 
+        # Attach the unique request ID as an HTTP header.
+        response['X-Request-ID'] = request.id
+
         # If this is an API request, attach an HTTP header annotating the API version (e.g. '3.5').
         if is_api_request(request):
             response['API-Version'] = settings.REST_FRAMEWORK_VERSION

netbox/netbox/tests/test_api.py

@@ -1,3 +1,5 @@
+import uuid
+
 from django.urls import reverse
 
 from utilities.testing import APITestCase
@@ -5,14 +7,22 @@ from utilities.testing import APITestCase
 
 class AppTest(APITestCase):
 
+    def test_http_headers(self):
+        response = self.client.get(reverse('api-root'), **self.header)
+
+        # Check that all custom response headers are present and valid
+        self.assertEqual(response.status_code, 200)
+        request_id = response.headers['X-Request-ID']
+        uuid.UUID(request_id)
+
     def test_root(self):
         url = reverse('api-root')
-        response = self.client.get('{}?format=api'.format(url), **self.header)
+        response = self.client.get(f'{url}?format=api', **self.header)
 
         self.assertEqual(response.status_code, 200)
 
     def test_status(self):
         url = reverse('api-status')
-        response = self.client.get('{}?format=api'.format(url), **self.header)
+        response = self.client.get(f'{url}?format=api', **self.header)
 
         self.assertEqual(response.status_code, 200)