fix(tracing): handle error when DNS query fails (#11935)

changelog/unreleased/kong/fix_dns_instrument_error_handling.yml

@@ -0,0 +1,3 @@
+message: "**tracing:** Fixed an issue where a DNS query failure would cause a tracing failure."
+type: bugfix
+scope: Core

kong/tracing/instrumentation.lua

@@ -287,7 +287,12 @@ do
     if span then
       span:set_attribute("dns.record.domain", host)
       span:set_attribute("dns.record.port", port)
-      span:set_attribute("dns.record.ip", ip_addr)
+      if ip_addr then
+        span:set_attribute("dns.record.ip", ip_addr)
+      else
+        span:record_error(res_port)
+        span:set_status(2)
+      end
       span:finish()
     end
 

spec/02-integration/14-tracing/01-instrumentations_spec.lua

@@ -48,7 +48,7 @@ for _, strategy in helpers.each_strategy() do
 
   describe("tracing instrumentations spec #" .. strategy, function()
 
-    local function setup_instrumentations(types, custom_spans)
+    local function setup_instrumentations(types, custom_spans, post_func)
       local bp, _ = assert(helpers.get_db_utils(strategy, {
         "services",
         "routes",
@@ -96,6 +96,10 @@ for _, strategy in helpers.each_strategy() do
         }
       })
 
+      if post_func then
+        post_func(bp)
+      end
+
       assert(helpers.start_kong {
         database = strategy,
         nginx_conf = "spec/fixtures/custom_nginx.template",
@@ -512,5 +516,60 @@ for _, strategy in helpers.each_strategy() do
         assert_has_spans("kong", spans, 1)
       end)
     end)
+
+    describe("#regression", function ()
+      describe("nil attribute for dns_query when fail to query", function ()
+        lazy_setup(function()
+          setup_instrumentations("dns_query", true, function(bp)
+            -- intentionally trigger a DNS query error
+            local service = bp.services:insert({
+              name = "inexist-host-service",
+              host = "really-inexist-host",
+              port = 80,
+            })
+
+            bp.routes:insert({
+              service = service,
+              protocols = { "http" },
+              paths = { "/test" },
+            })
+          end)
+        end)
+
+        lazy_teardown(function()
+          helpers.stop_kong()
+        end)
+
+        it("contains the expected kong.dns span", function ()
+          local thread = helpers.tcp_server(TCP_PORT)
+          local r = assert(proxy_client:send {
+            method  = "GET",
+            path    = "/test",
+          })
+          assert.res_status(503, r)
+
+          -- Getting back the TCP server input
+          local ok, res = thread:join()
+          assert.True(ok)
+          assert.is_string(res)
+
+          local spans = cjson.decode(res)
+          assert_has_spans("kong", spans)
+          local dns_spans = assert_has_spans("kong.dns", spans)
+          local upstream_dns
+          for _, dns_span in ipairs(dns_spans) do
+            if dns_span.attributes["dns.record.domain"] == "really-inexist-host" then
+              upstream_dns = dns_span
+              break
+            end
+          end
+
+          assert.is_not_nil(upstream_dns)
+          assert.is_nil(upstream_dns.attributes["dns.record.ip"])
+          -- has error reported
+          assert.is_not_nil(upstream_dns.events)
+        end)
+      end)
+    end)
   end)
 end