Refacter API server emphasis on logging

* To aid in debugging log API request and response bodies at trace
  level. Events can be correlated using the X-Reference-Id.
* Server now echos X-Reference-Id from client if set, otherwise
  generates an unique id.
* Move logic for X-Reference-Id into middleware
* Change uses of Header.Add() to Set() when setting Content-Type
* Log API operations in Apache format using gorilla middleware
* Port server code to use BaseContext and ConnContext

Fixes #10053

Signed-off-by: Jhon Honce <jhonce@redhat.com>

1 files changed, 34 insertions, 0 deletions

diff --git a/pkg/api/server/handler_rid.go b/pkg/api/server/handler_rid.go
new file mode 100644
index 000000000..b624b99a6
--- /dev/null
+++ b/pkg/api/server/handler_rid.go
@@ -0,0 +1,34 @@
+package server
+
+import (
+	"fmt"
+	"net/http"
+
+	"github.com/containers/podman/v3/pkg/api/types"
+	"github.com/google/uuid"
+	"github.com/gorilla/handlers"
+	"github.com/gorilla/mux"
+	"github.com/sirupsen/logrus"
+)
+
+// referenceIDHandler adds X-Reference-Id Header allowing event correlation
+// and Apache style request logging
+func referenceIDHandler() mux.MiddlewareFunc {
+	return func(h http.Handler) http.Handler {
+		return handlers.CombinedLoggingHandler(logrus.StandardLogger().Out,
+			http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+				rid := r.Header.Get("X-Reference-Id")
+				if rid == "" {
+					if c := r.Context().Value(types.ConnKey); c == nil {
+						rid = uuid.New().String()
+					} else {
+						rid = fmt.Sprintf("%p", c)
+					}
+				}
+
+				r.Header.Set("X-Reference-Id", rid)
+				w.Header().Set("X-Reference-Id", rid)
+				h.ServeHTTP(w, r)
+			}))
+	}
+}