Log request id

[reindert-vetter]

Is there a plan to also refactor the CLI log once one fires up the application, for example, to be displaying the link also to the application localhost:80 and also the log to be containing all requests made to your application?

Log request-id
Response with request-id header

Originally posted by @KinyaElGrande in #105 (comment)

[bosix]

I was thinking about adding the request-id not only to the log messages but also to http responses. That way each part that has access to the request or the response can access the id. This also allows client-sided javascript to work

Well, adding the request-id to request and response is really easy from my point of view. Here an example implementation with a middleware:

package middleware

import (
	"github.com/confetti-framework/contract/inter"
	"github.com/google/uuid"
)

type RequestID struct{}

const requestHeaderIDName = "x-request-id"

func (_ RequestID) Handle(request inter.Request, next inter.Next) inter.Response {
	var reqID string

        // allow other systems like a reverse proxy to set the request-id
	if reqID = request.Headers().Get(requestHeaderIDName); reqID == "" {
		reqID = uuid.New().String()
		request.Headers().Set(requestHeaderIDName, reqID)
	}

	resp := next(request)
	resp.GetHeaders().Set(requestHeaderIDName, reqID)

	return resp
}

My problem is that I have no clue how to access the request-id inside the logging facade (foundation -> logger_adapter.go). I think that this would be the correct spot to add the request-id globally to all log messages.

[reindert-vetter]

I don't know a nice name for it indeed.

I think I don't want to place those specific data providers on the channel (as below). Then we would have made the inter.Logger bigger with an extra method to retrieve those providers. What do you think of this?

diff --git a/config/logging.go b/config/logging.go
index 7d78c96..969bfb5 100644
--- a/config/logging.go
+++ b/config/logging.go
@@ -11,6 +11,7 @@ import (
 var Logging = struct {
        Default  string
        Channels map[string]inter.Logger
+       DataProviders []func(map[string]interface{}) map[string]interface{}
 }{
        /*
           |--------------------------------------------------------------------------
@@ -24,6 +25,14 @@ var Logging = struct {
        */
        Default: "stack",

+       /**
+          | Global
+        */
+       DataProviders: []func(map[string]interface{}) map[string]interface{}{
+               loggers.appendLogLevel,
+               loggers.appendRequestId,
+       },
+
        /*
           |--------------------------------------------------------------------------
           | Log Channels
@@ -48,6 +57,10 @@ var Logging = struct {
                "single": loggers.Syslog{
                        Path:     Path.Storage + "/logs/default.log",
                        MinLevel: log_level.DEBUG,
+                       DataProviders: []func(map[string]interface{}) map[string]interface{}{
+                               loggers.appendExtraData,
+                               loggers.appendExtraData2,
+                       },
                },

                "daily": loggers.Syslog{

[bosix]

I see your point. What do you think about only allow global DataProviders/decorators/... ? That way the inter.Logger interface keeps thin and you could add information to the log channel. The only problem with that is when someone don't want to add a decorator to all channels.

[reindert-vetter]

Let's just make it global for now. Maybe we'll come up with a better idea later.

[bosix]

I've created a pr for adding the required middleware. Please have a look at the changes and let me know if you want me anything to add or change.
confetti-framework/foundation#14

[reindert-vetter]

That looks good! I have 2 comments.