From 00de73d65e2779a9fb2c1cf030ebe237ccc6902e Mon Sep 17 00:00:00 2001
From: Daniel <dhaavi@users.noreply.github.com>
Date: Thu, 24 Sep 2020 22:44:27 +0200
Subject: [PATCH] Further logging improvements

---
 nameserver/nameserver.go | 22 +++++++++++-----------
 resolver/resolve.go      |  4 ++++
 resolver/reverse.go      |  2 +-
 resolver/scopes.go       |  2 +-
 4 files changed, 17 insertions(+), 13 deletions(-)

diff --git a/nameserver/nameserver.go b/nameserver/nameserver.go
index acf22474..9deec933 100644
--- a/nameserver/nameserver.go
+++ b/nameserver/nameserver.go
@@ -108,7 +108,7 @@ func handleRequest(ctx context.Context, w dns.ResponseWriter, request *dns.Msg)
 	// Return with server failure if offline.
 	if netenv.GetOnlineStatus() == netenv.StatusOffline &&
 		!netenv.IsConnectivityDomain(q.FQDN) {
-		tracer.Debugf("namserver: not resolving %s, device is offline", q.FQDN)
+		tracer.Debugf("nameserver: not resolving %s, device is offline", q.FQDN)
 		return reply(nsutil.ServerFailure("resolving disabled, device is offline"))
 	}
 
@@ -121,8 +121,8 @@ func handleRequest(ctx context.Context, w dns.ResponseWriter, request *dns.Msg)
 
 	// Handle request for localhost.
 	if strings.HasSuffix(q.FQDN, "localhost.") {
-		tracer.Tracef("namserver: returning localhost records")
-		return reply(nsutil.Localhost(""))
+		tracer.Tracef("nameserver: returning localhost records")
+		return reply(nsutil.Localhost())
 	}
 
 	// Authenticate request - only requests from the local host, but with any of its IPs, are allowed.
@@ -197,14 +197,14 @@ func handleRequest(ctx context.Context, w dns.ResponseWriter, request *dns.Msg)
 		// React to special errors.
 		switch {
 		case errors.Is(err, resolver.ErrNotFound):
-			tracer.Tracef("namserver: NXDomain via error")
-			return reply(nsutil.NxDomain(""))
+			tracer.Tracef("nameserver: NXDomain via error: %s", err)
+			return reply(nsutil.NxDomain("nxdomain: " + err.Error()))
 		case errors.Is(err, resolver.ErrBlocked):
-			tracer.Tracef("namserver: block via error")
-			return reply(nsutil.ZeroIP(""))
+			tracer.Tracef("nameserver: block via error: %s", err)
+			return reply(nsutil.ZeroIP("blocked: " + err.Error()))
 		case errors.Is(err, resolver.ErrLocalhost):
-			tracer.Tracef("namserver: returning localhost records")
-			return reply(nsutil.Localhost(""))
+			tracer.Tracef("nameserver: returning localhost records")
+			return reply(nsutil.Localhost())
 		default:
 			tracer.Warningf("nameserver: failed to resolve %s: %s", q.ID(), err)
 			return reply(nsutil.ServerFailure("internal error: " + err.Error()))
@@ -230,7 +230,7 @@ func handleRequest(ctx context.Context, w dns.ResponseWriter, request *dns.Msg)
 		// Request was blocked by the firewall.
 		switch conn.Verdict {
 		case network.VerdictBlock, network.VerdictDrop, network.VerdictFailed:
-			tracer.Infof("nameserver: request for %s from %s %s", q.ID(), conn.Process(), conn.Verdict.Verb())
+			tracer.Infof("nameserver: %s request for %s from %s", conn.Verdict.Verb(), q.ID(), conn.Process())
 			return reply(conn, conn)
 		}
 	}
@@ -239,6 +239,6 @@ func handleRequest(ctx context.Context, w dns.ResponseWriter, request *dns.Msg)
 	defer network.SaveOpenDNSRequest(conn)
 
 	// Reply with successful response.
-	tracer.Infof("nameserver: returning %s response %s to %s", conn.Verdict.Verb(), q.ID(), conn.Process())
+	tracer.Infof("nameserver: returning %s response for %s to %s", conn.Verdict.Verb(), q.ID(), conn.Process())
 	return reply(rrCache, conn, rrCache)
 }
diff --git a/resolver/resolve.go b/resolver/resolve.go
index 921f2b8e..566ba63d 100644
--- a/resolver/resolve.go
+++ b/resolver/resolve.go
@@ -121,6 +121,9 @@ func Resolve(ctx context.Context, q *Query) (rrCache *RRCache, err error) {
 	}
 
 	// log
+	// try adding a context tracer
+	ctx, tracer := log.AddTracer(ctx)
+	defer tracer.Submit()
 	log.Tracer(ctx).Tracef("resolver: resolving %s%s", q.FQDN, q.QType)
 
 	// check query compliance
@@ -225,6 +228,7 @@ func checkCache(ctx context.Context, q *Query) *RRCache {
 		// resolve async
 		module.StartWorker("resolve async", func(ctx context.Context) error {
 			ctx, tracer := log.AddTracer(ctx)
+			defer tracer.Submit()
 			tracer.Debugf("resolver: resolving %s async", q.ID())
 			_, err := resolveAndCache(ctx, q, nil)
 			if err != nil {
diff --git a/resolver/reverse.go b/resolver/reverse.go
index c236818b..88e67d3a 100644
--- a/resolver/reverse.go
+++ b/resolver/reverse.go
@@ -14,7 +14,7 @@ func ResolveIPAndValidate(ctx context.Context, ip string, securityLevel uint8) (
 	// get reversed DNS address
 	reverseIP, err := dns.ReverseAddr(ip)
 	if err != nil {
-		log.Tracef("resolver: failed to get reverse address of %s: %s", ip, err)
+		log.Tracer(ctx).Tracef("resolver: failed to get reverse address of %s: %s", ip, err)
 		return "", ErrInvalid
 	}
 
diff --git a/resolver/scopes.go b/resolver/scopes.go
index c0414381..0943cf2b 100644
--- a/resolver/scopes.go
+++ b/resolver/scopes.go
@@ -158,7 +158,7 @@ addNextResolver:
 	for _, resolver := range addResolvers {
 		// check for compliance
 		if err := resolver.checkCompliance(ctx, q); err != nil {
-			log.Tracef("skipping non-compliant resolver %s: %s", resolver.GetName(), err)
+			log.Tracer(ctx).Tracef("skipping non-compliant resolver %s: %s", resolver.GetName(), err)
 			continue
 		}