Print out the goroutine id (#3433)

The TXT logger prints out the actual go routine ID

This feature depends on 'loggoroutine' build tag

```go build -tags loggoroutine```

formatter/hook/additional_empty.go

@@ -0,0 +1,9 @@
+//go:build !loggoroutine
+
+package hook
+
+import log "github.com/sirupsen/logrus"
+
+func additionalEntries(_ *log.Entry) {
+	// This function is empty and is used to demonstrate the use of additional hooks.
+}

formatter/hook/additional_goroutine.go

@@ -0,0 +1,12 @@
+//go:build loggoroutine
+
+package hook
+
+import (
+	"github.com/petermattis/goid"
+	log "github.com/sirupsen/logrus"
+)
+
+func additionalEntries(entry *log.Entry) {
+	entry.Data[EntryKeyGoroutineID] = goid.Get()
+}

formatter/hook/hook.go

@@ -0,0 +1,134 @@
+package hook
+
+import (
+	"fmt"
+	"path"
+	"runtime/debug"
+	"strings"
+
+	"github.com/sirupsen/logrus"
+
+	"github.com/netbirdio/netbird/management/server/context"
+)
+
+type ExecutionContext string
+
+const (
+	ExecutionContextKey = "executionContext"
+
+	HTTPSource   ExecutionContext = "HTTP"
+	GRPCSource   ExecutionContext = "GRPC"
+	SystemSource ExecutionContext = "SYSTEM"
+)
+
+// ContextHook is a custom hook for add the source information for the entry
+type ContextHook struct {
+	goModuleName string
+}
+
+// NewContextHook instantiate a new context hook
+func NewContextHook() *ContextHook {
+	hook := &ContextHook{}
+	hook.goModuleName = hook.moduleName() + "/"
+	return hook
+}
+
+// Levels set the supported levels for this hook
+func (hook ContextHook) Levels() []logrus.Level {
+	return logrus.AllLevels
+}
+
+// Fire extend with the source information the entry.Data
+func (hook ContextHook) Fire(entry *logrus.Entry) error {
+	src := hook.parseSrc(entry.Caller.File)
+	entry.Data[EntryKeySource] = fmt.Sprintf("%s:%v", src, entry.Caller.Line)
+	additionalEntries(entry)
+
+	if entry.Context == nil {
+		return nil
+	}
+
+	source, ok := entry.Context.Value(ExecutionContextKey).(ExecutionContext)
+	if !ok {
+		return nil
+	}
+
+	entry.Data["context"] = source
+
+	switch source {
+	case HTTPSource:
+		addHTTPFields(entry)
+	case GRPCSource:
+		addGRPCFields(entry)
+	case SystemSource:
+		addSystemFields(entry)
+	}
+
+	return nil
+}
+
+func (hook ContextHook) moduleName() string {
+	info, ok := debug.ReadBuildInfo()
+	if ok && info.Main.Path != "" {
+		return info.Main.Path
+	}
+
+	return "netbird"
+}
+
+func (hook ContextHook) parseSrc(filePath string) string {
+	netbirdPath := strings.SplitAfter(filePath, hook.goModuleName)
+	if len(netbirdPath) > 1 {
+		return netbirdPath[len(netbirdPath)-1]
+	}
+
+	// in case of forked repo
+	netbirdPath = strings.SplitAfter(filePath, "netbird/")
+	if len(netbirdPath) > 1 {
+		return netbirdPath[len(netbirdPath)-1]
+	}
+
+	// in case if log entry is come from external pkg
+	_, pkg := path.Split(path.Dir(filePath))
+	file := path.Base(filePath)
+	return fmt.Sprintf("%s/%s", pkg, file)
+}
+
+func addHTTPFields(entry *logrus.Entry) {
+	if ctxReqID, ok := entry.Context.Value(context.RequestIDKey).(string); ok {
+		entry.Data[context.RequestIDKey] = ctxReqID
+	}
+	if ctxAccountID, ok := entry.Context.Value(context.AccountIDKey).(string); ok {
+		entry.Data[context.AccountIDKey] = ctxAccountID
+	}
+	if ctxInitiatorID, ok := entry.Context.Value(context.UserIDKey).(string); ok {
+		entry.Data[context.UserIDKey] = ctxInitiatorID
+	}
+}
+
+func addGRPCFields(entry *logrus.Entry) {
+	if ctxReqID, ok := entry.Context.Value(context.RequestIDKey).(string); ok {
+		entry.Data[context.RequestIDKey] = ctxReqID
+	}
+	if ctxAccountID, ok := entry.Context.Value(context.AccountIDKey).(string); ok {
+		entry.Data[context.AccountIDKey] = ctxAccountID
+	}
+	if ctxDeviceID, ok := entry.Context.Value(context.PeerIDKey).(string); ok {
+		entry.Data[context.PeerIDKey] = ctxDeviceID
+	}
+}
+
+func addSystemFields(entry *logrus.Entry) {
+	if ctxReqID, ok := entry.Context.Value(context.RequestIDKey).(string); ok {
+		entry.Data[context.RequestIDKey] = ctxReqID
+	}
+	if ctxInitiatorID, ok := entry.Context.Value(context.UserIDKey).(string); ok {
+		entry.Data[context.UserIDKey] = ctxInitiatorID
+	}
+	if ctxAccountID, ok := entry.Context.Value(context.AccountIDKey).(string); ok {
+		entry.Data[context.AccountIDKey] = ctxAccountID
+	}
+	if ctxDeviceID, ok := entry.Context.Value(context.PeerIDKey).(string); ok {
+		entry.Data[context.PeerIDKey] = ctxDeviceID
+	}
+}

formatter/hook/hook_test.go

@@ -0,0 +1,39 @@
+package hook
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestFilePathParsing(t *testing.T) {
+
+	testCases := []struct {
+		filePath         string
+		expectedFileName string
+	}{
+		// locally cloned repo
+		{
+			filePath:         "/Users/user/Github/Netbird/netbird/formatter/formatter.go",
+			expectedFileName: "formatter/formatter.go",
+		},
+		// locally cloned repo with duplicated name in path
+		{
+			filePath:         "/Users/user/netbird/repos/netbird/formatter/formatter.go",
+			expectedFileName: "formatter/formatter.go",
+		},
+		// locally cloned repo with renamed package root
+		{
+			filePath:         "/Users/user/Github/MyOwnNetbirdClient/formatter/formatter.go",
+			expectedFileName: "formatter/formatter.go",
+		},
+	}
+
+	hook := NewContextHook()
+
+	for _, testCase := range testCases {
+		parsedString := hook.parseSrc(testCase.filePath)
+		assert.Equal(t, testCase.expectedFileName, parsedString, "Parsed filepath does not match expected for %s", testCase.filePath)
+	}
+
+}

formatter/hook/keys.go

@@ -0,0 +1,6 @@
+package hook
+
+const (
+	EntryKeySource      = "source"
+	EntryKeyGoroutineID = "goroutine_id"
+)