Update default headers

Default headers don't contain `REQUEST_URI` anymore as query params are not filtered. Now `REQUEST_PATH` is sent instead to avoid any PII filtering.
appsignal · Feb 7, 2024 · c76a329 · c76a329
1 parent 4c2845c
commit c76a329
Show file tree

Hide file tree

Showing 5 changed files with 12 additions and 6 deletions.
diff --git a/.changesets/update-default-headers.md b/.changesets/update-default-headers.md
@@ -0,0 +1,6 @@
+---
+bump: "patch"
+type: "change"
+---
+
+Default headers don't contain `REQUEST_URI` anymore as query params are not filtered. Now `REQUEST_PATH` is sent instead to avoid any PII filtering.
diff --git a/lib/appsignal/config.rb b/lib/appsignal/config.rb
@@ -40,7 +40,7 @@ class Config
         HTTP_ACCEPT HTTP_ACCEPT_CHARSET HTTP_ACCEPT_ENCODING
         HTTP_ACCEPT_LANGUAGE HTTP_CACHE_CONTROL HTTP_CONNECTION
         CONTENT_LENGTH PATH_INFO HTTP_RANGE
-        REQUEST_METHOD REQUEST_URI SERVER_NAME SERVER_PORT
+        REQUEST_METHOD REQUEST_PATH SERVER_NAME SERVER_PORT
         SERVER_PROTOCOL
       ],
       :send_environment_metadata => true,

diff --git a/lib/appsignal/demo.rb b/lib/appsignal/demo.rb
@@ -93,7 +93,7 @@ def rack_request
           "SERVER_NAME" => "localhost",
           "SERVER_PORT" => "80",
           "SERVER_PROTOCOL" => "HTTP/1.1",
-          "REQUEST_URI" => "/hello",
+          "REQUEST_PATH" => "/hello",
           "PATH_INFO" => "/hello",
           "HTTP_ACCEPT" => "text/html,application/xhtml+xml",
           "HTTP_ACCEPT_ENCODING" => "gzip, deflate, sdch",

diff --git a/spec/integration/diagnose b/spec/integration/diagnose
diff --git a/spec/support/fixtures/projects/valid/config/appsignal.yml b/spec/support/fixtures/projects/valid/config/appsignal.yml
@@ -5,7 +5,7 @@ default: &defaults
     "HTTP_ACCEPT", "HTTP_ACCEPT_CHARSET", "HTTP_ACCEPT_ENCODING",
     "HTTP_ACCEPT_LANGUAGE", "HTTP_CACHE_CONTROL", "HTTP_CONNECTION",
     "CONTENT_LENGTH", "PATH_INFO", "HTTP_RANGE", "HTTP_REFERER",
-    "REQUEST_METHOD", "REQUEST_URI", "SERVER_NAME", "SERVER_PORT",
+    "REQUEST_METHOD", "REQUEST_PATH", "SERVER_NAME", "SERVER_PORT",
     "SERVER_PROTOCOL", "HTTP_USER_AGENT"
   ]
   enable_minutely_probes: false
@@ -33,7 +33,7 @@ old_config:
     "HTTP_ACCEPT", "HTTP_ACCEPT_CHARSET", "HTTP_ACCEPT_ENCODING",
     "HTTP_ACCEPT_LANGUAGE", "HTTP_CACHE_CONTROL", "HTTP_CONNECTION",
     "CONTENT_LENGTH", "PATH_INFO", "HTTP_RANGE", "HTTP_REFERER",
-    "REQUEST_METHOD", "REQUEST_URI", "SERVER_NAME", "SERVER_PORT",
+    "REQUEST_METHOD", "REQUEST_PATH", "SERVER_NAME", "SERVER_PORT",
     "SERVER_PROTOCOL", "HTTP_USER_AGENT"
   ]
 
@@ -49,7 +49,7 @@ old_config_mixed_with_new_config:
     "HTTP_ACCEPT", "HTTP_ACCEPT_CHARSET", "HTTP_ACCEPT_ENCODING",
     "HTTP_ACCEPT_LANGUAGE", "HTTP_CACHE_CONTROL", "HTTP_CONNECTION",
     "CONTENT_LENGTH", "PATH_INFO", "HTTP_RANGE", "HTTP_REFERER",
-    "REQUEST_METHOD", "REQUEST_URI", "SERVER_NAME", "SERVER_PORT",
+    "REQUEST_METHOD", "REQUEST_PATH", "SERVER_NAME", "SERVER_PORT",
     "SERVER_PROTOCOL", "HTTP_USER_AGENT"
   ]