perf(tracing/request-id): introduce $kong_request_id

.requirements

@@ -6,7 +6,7 @@ OPENSSL=3.1.2
 PCRE=8.45
 LIBEXPAT=2.5.0
 
-LUA_KONG_NGINX_MODULE=8296b70ee1256b2cd59f246137b727f049174787 # 0.7.1
+LUA_KONG_NGINX_MODULE=4fbc3ddc7dcbc706ed286b95344f3cb6da17e637 # 0.8.0
 LUA_RESTY_LMDB=951926f20b674a0622236a0e331b359df1c02d9b # 1.3.0
 LUA_RESTY_EVENTS=8448a92cec36ac04ea522e78f6496ba03c9b1fd8 # 0.2.0
 LUA_RESTY_WEBSOCKET=60eafc3d7153bceb16e6327074e0afc3d94b1316 # 0.4.0

changelog/unreleased/kong/lua_kong_nginx_module_bump.yml

@@ -1,3 +1,3 @@
-message: Bump lua-kong-nginx-module from 0.6.0 to 0.7.1
+message: Bump lua-kong-nginx-module from 0.6.0 to 0.8.0
 type: dependency
 scope: Core

kong/plugins/aws-lambda/request-util.lua

@@ -4,7 +4,8 @@ local ngx_decode_base64 = ngx.decode_base64
 local cjson = require "cjson.safe"
 
 local pl_stringx = require("pl.stringx")
-local date = require "date"
+local date = require("date")
+local get_request_id = require("kong.tracing.request_id").get
 
 local EMPTY = {}
 
@@ -221,7 +222,7 @@ local function aws_serializer(ctx, config)
       sourceIp = var.realip_remote_addr or var.remote_addr,
       userAgent = headers["user-agent"],
     }
-    local requestId = var.request_id
+    local requestId = get_request_id()
     local start_time = ngx_req_start_time()
     -- The CLF-formatted request time (dd/MMM/yyyy:HH:mm:ss +-hhmm).
     local requestTime = date(start_time):fmt("%d/%b/%Y:%H:%M:%S %z")

kong/templates/nginx_kong.lua

@@ -54,11 +54,10 @@ exit_worker_by_lua_block {
 log_format kong_log_format '$remote_addr - $remote_user [$time_local] '
                            '"$request" $status $body_bytes_sent '
                            '"$http_referer" "$http_user_agent" '
-                           'kong_request_id: "$request_id"';
+                           'kong_request_id: "$kong_request_id"';
 
 # Load variable indexes
 lua_kong_load_var_index default;
-lua_kong_load_var_index $request_id;
 lua_kong_load_var_index $http_x_kong_request_debug;
 lua_kong_load_var_index $http_x_kong_request_debug_token;
 lua_kong_load_var_index $http_x_kong_request_debug_log;
@@ -87,7 +86,7 @@ server {
 
     # Append the kong request id to the error log
     # https://github.com/Kong/lua-kong-nginx-module#lua_kong_error_log_request_id
-    lua_kong_error_log_request_id $request_id;
+    lua_kong_error_log_request_id $kong_request_id;
 
 > if proxy_access_log_enabled then
     access_log ${{PROXY_ACCESS_LOG}} kong_log_format;

kong/tools/request_aware_table.lua

@@ -1,8 +1,9 @@
 --- NOTE: tool is designed to assist with **detecting** request contamination
 -- issues on CI, during test runs. It does not offer security safeguards.
 
-local table_new = require "table.new"
-local table_clear = require "table.clear"
+local table_new = require("table.new")
+local table_clear = require("table.clear")
+local get_request_id = require("kong.tracing.request_id").get
 
 local is_not_debug_mode = (kong.configuration.log_level ~= "debug")
 
@@ -11,7 +12,6 @@ local error        = error
 local rawset       = rawset
 local setmetatable = setmetatable
 local get_phase    = ngx.get_phase
-local var          = ngx.var
 
 
 local NGX_VAR_PHASES = {
@@ -35,7 +35,7 @@ local function enforce_sequential_access(table)
     return
   end
 
-  local curr_request_id = var.request_id
+  local curr_request_id = get_request_id()
   local allowed_request_id = rawget(table, ALLOWED_REQUEST_ID_K)
   if not allowed_request_id then
     -- first access. Set allowed request ID and allow access

kong/tracing/request_id.lua

@@ -1,4 +1,6 @@
 local ngx = ngx
+local var = ngx.var
+local get_phase = ngx.get_phase
 
 local NGX_VAR_PHASES = {
   set           = true,
@@ -21,14 +23,14 @@ local function get()
   local rid = get_ctx_request_id()
 
   if not rid then
-    local phase = ngx.get_phase()
+    local phase = get_phase()
     if not NGX_VAR_PHASES[phase] then
       return nil, "cannot access ngx.var in " .. phase .. " phase"
     end
 
     -- first access to the request id for this request:
-    -- initialize with the value of $request_id
-    rid = ngx.var.request_id
+    -- initialize with the value of $kong_request_id
+    rid = var.kong_request_id
     ngx.ctx.request_id = rid
   end
 

spec/01-unit/10-log_serializer_spec.lua

@@ -22,7 +22,7 @@ describe("kong.log.serialize", function()
           },
         },
         var = {
-          request_id = "1234",
+          kong_request_id = "1234",
           request_uri = "/request_uri",
           upstream_uri = "/upstream_uri",
           scheme = "http",

spec/01-unit/26-tracing/03-request-id_spec.lua

@@ -1,9 +1,13 @@
-local request_id = require "kong.tracing.request_id"
+local function reload_module(name)
+  package.loaded[name] = nil
+  return require(name)
+end
+
 
 local function reset_globals(id)
   _G.ngx.ctx = {}
   _G.ngx.var = {
-    request_id = id,
+    kong_request_id = id,
   }
   _G.ngx.get_phase = function() -- luacheck: ignore
     return "access"
@@ -43,6 +47,9 @@ describe("Request ID unit tests", function()
     end)
 
     it("returns the expected Request ID and caches it in ctx", function()
+
+      local request_id = reload_module("kong.tracing.request_id")
+
       local id, err = request_id.get()
       assert.is_nil(err)
       assert.equal(ngx_var_request_id, id)
@@ -54,6 +61,8 @@ describe("Request ID unit tests", function()
     it("fails if accessed from phase that cannot read ngx.var", function()
       _G.ngx.get_phase = function() return "init" end
 
+      local request_id = reload_module("kong.tracing.request_id")
+
       local id, err = request_id.get()
       assert.is_nil(id)
       assert.equal("cannot access ngx.var in init phase", err)

spec/03-plugins/27-aws-lambda/05-aws-serializer_spec.lua

@@ -7,6 +7,15 @@ describe("[AWS Lambda] aws-gateway input", function()
   local old_ngx
   local aws_serialize
 
+
+  local function reload_module()
+    -- make sure to reload the module
+    package.loaded["kong.tracing.request_id"] = nil
+    package.loaded["kong.plugins.aws-lambda.request-util"] = nil
+    aws_serialize = require "kong.plugins.aws-lambda.request-util".aws_serializer
+  end
+
+
   setup(function()
     old_ngx = ngx
     local body_data
@@ -20,18 +29,16 @@ describe("[AWS Lambda] aws-gateway input", function()
         start_time = function() return mock_request.start_time end,
       },
       log = function() end,
+      get_phase = function() -- luacheck: ignore
+        return "access"
+      end,
       encode_base64 = old_ngx.encode_base64
     }, {
       -- look up any unknown key in the mock request, eg. .var and .ctx tables
       __index = function(self, key)
         return mock_request and mock_request[key]
       end,
     })
-
-
-    -- make sure to reload the module
-    package.loaded["kong.plugins.aws-lambda.request-util"] = nil
-    aws_serialize = require "kong.plugins.aws-lambda.request-util".aws_serializer
   end)
 
   teardown(function()
@@ -60,7 +67,7 @@ describe("[AWS Lambda] aws-gateway input", function()
       var = {
         request_method = "GET",
         upstream_uri = "/123/strip/more?boolean=;multi-query=first;single-query=hello%20world;multi-query=second",
-        request_id = "1234567890",
+        kong_request_id = "1234567890",
         host = "abc.myhost.com",
         remote_addr = "123.123.123.123"
       },
@@ -76,6 +83,8 @@ describe("[AWS Lambda] aws-gateway input", function()
       },
     }
 
+    reload_module()
+
     local out = aws_serialize()
 
     assert.same({
@@ -140,7 +149,7 @@ describe("[AWS Lambda] aws-gateway input", function()
       var = {
         request_method = "GET",
         upstream_uri = "/plain/strip/more?boolean=;multi-query=first;single-query=hello%20world;multi-query=second",
-        request_id = "1234567890",
+        kong_request_id = "1234567890",
         host = "def.myhost.com",
         remote_addr = "123.123.123.123"
       },
@@ -151,6 +160,8 @@ describe("[AWS Lambda] aws-gateway input", function()
       },
     }
 
+    reload_module()
+
     local out = aws_serialize()
 
     assert.same({
@@ -235,7 +246,7 @@ describe("[AWS Lambda] aws-gateway input", function()
             request_method = "GET",
             upstream_uri = "/plain/strip/more",
             http_content_type = tdata.ct,
-            request_id = "1234567890",
+            kong_request_id = "1234567890",
             host = "def.myhost.com",
             remote_addr = "123.123.123.123"
           },
@@ -246,6 +257,8 @@ describe("[AWS Lambda] aws-gateway input", function()
           },
         }
 
+        reload_module()
+
         local out = aws_serialize()
 
         assert.same({