feat(reports) custom immutable items

kong/core/reports.lua

@@ -50,6 +50,24 @@ local function log(lvl, ...)
 end
 
 
+local function serialize_report_value(v)
+  if type(v) == "function" then
+    v = v()
+  end
+
+  if type(v) == "table" then
+    local json, err = cjson.encode(v)
+    if err then
+      log(ERR, "could not JSON encode given table entity: ", err)
+    end
+
+    v = json
+  end
+
+  return v ~= nil and tostring(v) or nil
+end
+
+
 -- UDP logger
 
 
@@ -74,22 +92,10 @@ local function send_report(signal_type, t, host, port)
 
   for k, v in pairs(t) do
     if k == "unique_id" or (k ~= "created_at" and sub(k, -2) ~= "id") then
-      if type(v) == "function" then
-        v = v()
-      end
-
-      if type(v) == "table" then
-        local json, err = cjson.encode(v)
-        if err then
-          log(ERR, "could not JSON encode given table entity: ", err)
-        end
-
-        v = json
-      end
-
+      v = serialize_report_value(v)
       if v ~= nil then
         mutable_idx = mutable_idx + 1
-        _buffer[mutable_idx] = k .. "=" .. tostring(v)
+        _buffer[mutable_idx] = k .. "=" .. v
       end
     end
   end
@@ -181,6 +187,15 @@ local function add_ping_value(k, v)
 end
 
 
+local function add_immutable_value(k, v)
+  v = serialize_report_value(v)
+  if v ~= nil then
+    _buffer_immutable_idx = _buffer_immutable_idx + 1
+    _buffer[_buffer_immutable_idx] = k .. "=" .. v
+  end
+end
+
+
 local retrieve_redis_version
 
 
@@ -226,6 +241,7 @@ return {
 
     create_timer(PING_INTERVAL, ping_handler)
   end,
+  add_immutable_value = add_immutable_value,
   add_ping_value = add_ping_value,
   get_ping_value = function(k)
     return _ping_infos[k]

spec/01-unit/013-reports_spec.lua

@@ -51,6 +51,22 @@ describe("reports", function()
       assert.is_nil(res)
       assert.equal("timeout", err)
     end)
+    it("accepts custom immutable items", function()
+      reports.toggle(true)
+
+      local thread = helpers.udp_server(8189)
+
+      reports.add_immutable_value("imm1", "fooval")
+      reports.add_immutable_value("imm2", "barval")
+
+      reports.send("stub", {k1 = "bazval"}, "127.0.0.1", 8189)
+
+      local ok, res = thread:join()
+      assert.True(ok)
+      assert.matches("imm1=fooval", res)
+      assert.matches("imm2=barval", res)
+      assert.matches("k1=bazval", res)
+    end)
   end)
 
   describe("retrieve_redis_version()", function()