Added mock tracing logger for testing purposes

Author: constantincristian

src/lua/api-gateway/tracking/log/tracingRulesLogger.lua

@@ -13,9 +13,9 @@
   ]]
 
 local cjson = require "cjson"
-local _M = {}
+local su = require "api-gateway.tracking.util.stringutil"
 
-local kinesisLogger
+local _M = {}
 
 function _M:new(o)
     local o = o or {}
@@ -24,45 +24,30 @@ function _M:new(o)
     return o
 end
 
-function _M:sendKinesisMessage(kinesis_data)
-
-    local kinesisSwitch = ngx.var.kinesisSwitch
-    if (kinesisSwitch == nil or kinesisSwitch == "") then
-        kinesisSwitch = "on"
-    end
-    if ( kinesisLogger ~= nil and (kinesisSwitch ~= nil and kinesisSwitch == "on")) then
-        local partition_key = ngx.utctime() .."-".. math.random(ngx.now() * 1000)
-
-        -- Send logs to kinesis
-        kinesisLogger:logMetrics(partition_key, cjson.encode(kinesis_data))
-    else
-        ngx.log(ngx.WARN, "Trace info not sent to kinesis")
-    end
-
-end
-
-function _M:getKinesisMessage(rule)
-    local kinesis_data = {}
+function _M:buildTraceMessage(rule)
+    local data = {}
 
-    kinesis_data["id"] = tostring(rule.id)
-    kinesis_data["domain"] = tostring(rule.domain)
-    kinesis_data["request_body"] = tostring(ngx.var.request_body)
+    data["id"] = tostring(rule.id)
+    data["domain"] = tostring(rule.domain)
+    data["request_body"] = tostring(ngx.var.request_body)
+    data["status"] = tostring(ngx.var.status)
 
     for key,value in pairs(ngx.header) do
-        kinesis_data[tostring(key)] = tostring(value)
+        data[tostring(key)] = tostring(value)
     end
 
-    local meta = rule.meta
+    local meta = rule.meta:split(";")
     local meta_length = table.getn(meta)
 
     local var_value, index
     for index = 1, meta_length do
         local variableManager = ngx.apiGateway.tracking.variableManager
-        var_value = variableManager:getRequestVariable(meta[index], nil)
-        kinesis_data[tostring(meta[index])] = tostring(var_value)
+        local var_name = string.sub(su.trim(meta[index]), 2);
+        var_value = variableManager:getRequestVariable(var_name, nil)
+        data[var_name] = tostring(var_value)
     end
 
-    return kinesis_data
+    return data
 end
 
 ---
@@ -74,9 +59,9 @@ function _M:log_trace_rules(config_obj)
         ngx.log(ngx.WARN, "Please initialize RequestTrackingManager before calling this method")
     end
 
-    kinesisLogger = ngx.apiGateway.getAsyncLogger("api-gateway-debugging")
-    if ( kinesisLogger == nil ) then
-        ngx.log(ngx.WARN, "Could not track request. kinesis logger should not be nil")
+    local tracingLogger = ngx.apiGateway.getAsyncLogger("api-gateway-debugging")
+    if ( tracingLogger == nil ) then
+        ngx.log(ngx.WARN, "Could not track request. Tracing logger should not be nil")
         return
     end
 
@@ -86,13 +71,14 @@ function _M:log_trace_rules(config_obj)
     if (tracing_rules == nil) then
         return
     end
-    -- 2. for each tracing rule matching the request publish a kinesis message asyncronously
+    -- 2. for each tracing rule matching the request publish a tracing message asyncronously
     for i, rule in pairs(tracing_rules) do
         if ( rule ~= nil ) then
-            local message = self:getKinesisMessage(rule)
+            local message = self:buildTraceMessage(rule)
             if ( message ~= nil ) then
-                ngx.log(ngx.DEBUG, "Sending tracing info to kinesis: " .. cjson.encode(message))
-                self:sendKinesisMessage(message)
+                local partition_key = ngx.utctime() .."-".. math.random(ngx.now() * 1000)
+                ngx.log(ngx.DEBUG, "Logging tracing info: " .. cjson.encode(message))
+                tracingLogger:logMetrics(partition_key, cjson.encode(message));
             end
         end
     end

src/lua/api-gateway/tracking/util/stringutil.lua

@@ -0,0 +1,26 @@
+local stringutil = {}
+
+-- http://coronalabs.com/blog/2013/04/16/lua-string-magic/
+function string:split( pattern, results )
+    if not results then
+        results = { }
+    end
+    local start = 1
+    local split_start, split_end = string.find( self, pattern, start )
+    while split_start do
+        table.insert( results, string.sub( self, start, split_start - 1 ) )
+        start = split_end + 1
+        split_start, split_end = string.find( self, pattern, start )
+    end
+    table.insert( results, string.sub( self, start ) )
+    return results
+end
+
+-- http://coronalabs.com/blog/2013/04/16/lua-string-magic/
+local function trim( s )
+    return string.match( s,"^()%s*$") and "" or string.match(s,"^%s*(.*%S)" )
+end
+
+stringutil.trim = trim
+
+return stringutil

test/perl/api-gateway/tracking/log/tracingRulesLogger.t

@@ -24,7 +24,7 @@ use Cwd qw(cwd);
 
 repeat_each(1);
 
-plan tests => repeat_each() * (blocks() * 5) + 1 ;
+plan tests => repeat_each() * (blocks() * 5) + 3 ;
 
 my $pwd = cwd();
 
@@ -42,7 +42,11 @@ our $HttpConfig = <<_EOC_;
         ngx.apiGateway.tracking = require "api-gateway.tracking.factory"
 
         local function get_logger(name)
-            return {}
+            return {
+                logMetrics = function (self, key, value)
+                             ngx.log(ngx.INFO, "Received " .. tostring(value))
+                     end
+            }
         end
         ngx.apiGateway.getAsyncLogger = get_logger
      ';
@@ -81,14 +85,12 @@ __DATA__
 
         error_log ../test-logs/tracingRequestValidator_test1_error.log debug;
 
-        location ~ /trace {
-            set $validate_service_plan "on; path=/validate_service_plan; order=1; ";
+        location /trace {
 
-            access_by_lua "
+            log_by_lua '
                 ngx.apiGateway.tracking.track()
-                ngx.apiGateway.validation.validateRequest()
-            ";
-            content_by_lua 'ngx.say(ngx.var.validate_request_response_time)';
+            ';
+            content_by_lua 'ngx.say("OK")';
 
         }
 --- timeout: 10
@@ -100,20 +102,20 @@ __DATA__
   "format": "$publisher_org_name",
   "expire_at_utc": 1583910454,
   "action" : "TRACE",
-  "meta" : ["$request_uri"]
+  "meta" : "$request_uri; $request_method;$publisher_org_name"
 }]
 ',
 "GET /trace"
 ]
 --- response_body_like eval
 [
 '\{"result":"success"\}.*',
-'0',
-'(\d{2,4})+',
-'(\d{2,4})+',
-'.*{"domain":"pub1","format":"\$publisher_org_name","id":222,"action":"TRACE","expire_at_utc":1583910454}.*'
+'OK'
 ]
 --- error_code_like eval
- [200, 200, 200, 200, 200]
+ [200, 200]
+--- grep_error_log eval: qr/Received .*?/
+--- grep_error_log_out
+request_uri
 --- no_error_log
 [error]