Add log to happy path

[bohuini]

Reason for Change:
DNC requiring to refresh CNS NC associations is not expected to happen too often, but when it does, we need to log all pertinent details. Added the log in CNS should to show refresh detected and initiated by DNC.

Issue Fixed:

Requirements:

• uses conventional commit messages
• includes documentation
• adds unit tests

Notes:

[rbtr]

@bohuini pls read this #1921 (comment)

[rbtr]

the log should not speculate on the intent of what is happening, the log should describe what is happening concisely and in enough detail to be useful during debugging

[rbtr]

unnecessary to add an informational log here if all branches of the switch have a log

[bohuini]

Removed.

[rbtr]

or, GET from getOrRefreshNetworkContainers

[rbtr]

you don't have to use my example, but it provides just as much info as yours without the potential of lying to me if that's not why this method was called

[bohuini]

Make sense. Addressed.

[rbtr]

or, POST to getOrRefreshNetworkContainers

[bohuini]

Addressed.

[timraymond]

I'm with @rbtr here... I think concise logs are better because they tend to tell fewer lies about what's going on as things change over time. Log just the facts, given what's known at the time the log is generated. Given what I see, it would likely be better to have a middleware that logs requests (path, method, some request ID), and responses (HTTP response code, end-to-end time, the same ID for correlation). All of those should be structured using zap. Something like:

func logHTTP(next http.Handler) http.Handler {
	return http.HandlerFunc(func(rw http.ResponseWriter, r *http.Request) {
		logger.Info("request", zap.String("uri", r.URL.RequestURI()), zap.String("method", r.Method))
		// need to wrap the ResponseWriter in something that can capture the response code
		wrw := WrappedResponseWriter{rw} // this doesn't exist and needs to be written
		next(wrw, r)
		logger.Info("response", zap.Int("code", wrw.ResponseCode)) // etc.
	})
}

[bohuini]

@rbtr Revised the log and rebased branch. Please review again when you get a chance. Thanks!

[bohuini]

@timraymond That's a good point and I do agree. But for this time I am just making it simple for integration testing purposes.

[timraymond]

LGTM 👍 Awaiting @rbtr to hit the approval button.

[rbtr]

/azp run

[azure-pipelines]

Azure Pipelines successfully started running 2 pipeline(s).