feat: new priority key settings for key value formatter

Reviewed-on: #1

.forgejo/workflows/build.yml

@@ -0,0 +1,81 @@
+name: Build
+
+on:
+  push:
+    branches:
+      - main
+      - beta
+      - develop
+  pull_request:
+
+jobs:
+  checks:
+    name: Checks
+    runs-on: docker
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Setup Go
+        uses: actions/setup-go@v5
+        with:
+          go-version: '1.23.x'
+          check-latest: true
+      - name: Run go fmt and go vet
+        run: |
+          go fmt $(go list ./...)
+          go vet $(go list ./...)
+
+  code-coverage:
+    name: Code Coverage
+    runs-on: docker
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Setup Go
+        uses: actions/setup-go@v5
+        with:
+          go-version: '1.23.x'
+          check-latest: true
+      - name: Run tests and generate coverage report
+        run: |
+          go test -covermode=count -coverprofile coverage.cov $(go list ./...)
+          go tool cover -func=coverage.cov
+          go tool cover -html=coverage.cov -o coverage.html
+      - name: Upload coverage artifacts
+        uses: https://code.forgejo.org/forgejo/upload-artifact@v4
+        with:
+          name: coverage-reports
+          path: |
+            coverage.cov
+            coverage.html
+
+  build:
+    name: Build
+    runs-on: docker
+    strategy:
+      matrix:
+        go:
+          - GOOS: darwin
+            GOARCH: amd64
+          - GOOS: darwin
+            GOARCH: arm64
+          - GOOS: linux
+            GOARCH: amd64
+          - GOOS: linux
+            GOARCH: arm64
+          - GOOS: windows
+            GOARCH: amd64
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Setup Go
+        uses: actions/setup-go@v5
+        with:
+          go-version: '1.23.x'
+          check-latest: true
+      - name: Set environment variables
+        run: |
+          echo "GOOS=${{ matrix.go.GOOS }}" >> $GITHUB_ENV
+          echo "GOARCH=${{ matrix.go.GOARCH }}" >> $GITHUB_ENV
+      - name: Build
+        run: go build .

.forgejo/workflows/release.yml

@@ -0,0 +1,20 @@
+name: Release
+
+on:
+  push:
+    branches:
+      - main
+      - beta
+
+jobs:
+  release:
+    name: Semantic Release
+    runs-on: docker
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+      - name: Semantic Release
+        shell: bash
+        run: |
+          npm install -g semantic-release@23 conventional-changelog-conventionalcommits@7
+          semantic-release

.gitignore

@@ -1,2 +1,3 @@
 .DS_Store
+.idea
 .vscode

.releaserc

@@ -0,0 +1,72 @@
+{
+  "branches": [
+    "main",
+    {
+      "name": "beta",
+      "prerelease": true
+    }
+  ],
+  "plugins": [
+    [
+      "@semantic-release/commit-analyzer",
+      {
+        "preset": "conventionalcommits",
+        "releaseRules": [
+          {
+            "type": "chore",
+            "release": "patch"
+          },
+          {
+            "type": "build",
+            "release": "patch"
+          },
+          {
+            "type": "ci",
+            "release": "patch"
+          }
+        ]
+      }
+    ],
+    [
+      "@semantic-release/release-notes-generator",
+      {
+        "preset": "conventionalcommits",
+        "presetConfig": {
+          "types": [
+            {
+              "type": "feat",
+              "section": "Features"
+            },
+            {
+              "type": "feature",
+              "section": "Features"
+            },
+            {
+              "type": "fix",
+              "section": "Bug Fixes"
+            },
+            {
+              "type": "perf",
+              "section": "Performance Improvements"
+            },
+            {
+              "type": "revert",
+              "section": "Reverts"
+            },
+            {
+              "type": "chore",
+              "section": "Miscellaneous Chores"
+            }
+          ]
+        }
+      }
+    ],
+    [
+      "@semantic-release/github",
+      {
+        "successCommentCondition": false,
+        "failTitle": false
+      }
+    ]
+  ]
+}

README.md

@@ -1,4 +1,56 @@
+# log
+
+Log is a simple logging framework for golang.
+
+## Getting Started
+
+```golang
+import "git.martin-riedl.de/golang/log"
+
+func main(){
+	log.Default.Info("My First Info Message")
+}
+```
+
+Check out this [simple example file](cmd/simple/main.go) for the basic usage.
+
+## Multiple Log Instance
+
+Create a new log instance (instead of using the `Default`).
+
+```golang
+import "git.martin-riedl.de/golang/log"
+
+var myLog := log.NewLoggerDefault()
+myLog.Info("My First Info Message")
+```
+
+## Outputs / Formatter / Printer
+
+- `Formatter` defines the output format (e.g. Key/Value or JSON)
+- `Printer` defines the message output location (e.g. stdout or file)
+- `Output` is a combination of `Formatter` and `Printer`
+
+The following sample creates 2 outputs. The first sends a key/value format to stdout. The second writes messages as JSON format to stdout.
+
+```golang
+import "git.martin-riedl.de/golang/log"
+
+var output1 := NewOutput(log.LevelInfo, NewFormatterKeyValue(), NewPrinterStdout()
+var output2 := NewOutput(log.LevelError, NewFormatterJSON(), NewPrinterStdout())
+
+var myLog := log.NewLogger(
+	[]*Output{output1, output2}
+)
+myLog.Info("My First Info Message")
+```
+
+## Custom Formatter / Printer
+
+If you need a special `Formatter` or `Printer`: simply implement the Interface (same name) and assign it to an `Output`.
+
 # License
+
 ```
 Copyright 2023 Martin Riedl
 

cmd/keyValueFormatter/main.go

@@ -0,0 +1,30 @@
+package main
+
+import (
+	"time"
+
+	"git.martin-riedl.de/golang/log"
+)
+
+func main() {
+	advancedSettings()
+}
+
+func advancedSettings() {
+	// Key Value Formatter with special settings
+	formatter := log.NewFormatterKeyValue()
+	formatter.HighPriorityKeys = []string{"firstField"}
+	formatter.PriorityKeys = []string{"secondField"}
+	formatter.TimeFormat = time.RFC3339Nano
+
+	// create new log instance
+	output := log.NewOutput(log.LevelDebug, formatter, log.NewPrinterStdout())
+	logger := log.NewLogger([]*log.Output{output})
+
+	// log some message
+	logger.WithMap(log.Map{
+		"someField":   "Martin",
+		"firstField":  "John",
+		"secondField": "Doe",
+	}).Info("This is an info message")
+}

cmd/simple/main.go

@@ -0,0 +1,24 @@
+package main
+
+import (
+	"runtime"
+
+	"git.martin-riedl.de/golang/log"
+)
+
+func main() {
+	someMethod()
+	anotherMethod()
+}
+
+func someMethod() {
+	log.Default.Info("Hello World")
+	log.Default.With("os", runtime.GOOS).Warning("environment detected")
+}
+
+func anotherMethod() {
+	log.Default.WithMap(log.Map{
+		"foo": "bar",
+		"bar": "baz",
+	}).Info("Second Hello World")
+}

entry.go

@@ -12,10 +12,11 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package golog
+package log
 
 import (
 	"fmt"
+	"runtime"
 	"time"
 )
 
@@ -25,6 +26,7 @@ type Entry struct {
 	Message   string
 	Level     Level
 	Time      time.Time
+	CallStack []runtime.Frame
 }
 
 type Content struct {
@@ -32,6 +34,8 @@ type Content struct {
 	Value any    `json:"value"`
 }
 
+type Map map[string]any
+
 func NewEntry(logger *Logger) *Entry {
 	return &Entry{
 		Logger:  logger,
@@ -47,6 +51,13 @@ func (entry *Entry) With(key string, value any) *Entry {
 	return entry
 }
 
+func (entry *Entry) WithMap(entries Map) *Entry {
+	for key, value := range entries {
+		entry.With(key, value)
+	}
+	return entry
+}
+
 func (entry *Entry) WithContent(content []Content) *Entry {
 	entry.Content = append(entry.Content, content...)
 	return entry

formatter.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package golog
+package log
 
 type Formatter interface {
 	Begin(*Entry)

formatter_json.go

@@ -12,10 +12,11 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package golog
+package log
 
 import (
 	"encoding/json"
+	"fmt"
 	"log"
 	"time"
 )
@@ -23,7 +24,7 @@ import (
 type FormatterJSON struct {
 	FlatContent bool
 	TimeFormat  string
-	data        map[string]interface{}
+	data        map[string]any
 }
 
 func NewFormatterJSON() *FormatterJSON {
@@ -34,7 +35,7 @@ func NewFormatterJSON() *FormatterJSON {
 
 func (formatter *FormatterJSON) Begin(entry *Entry) {
 	// reset formatter
-	formatter.data = make(map[string]interface{})
+	formatter.data = make(map[string]any)
 
 	// add timestamp
 	formatter.data["time"] = entry.Time.Format(formatter.TimeFormat)
@@ -47,6 +48,13 @@ func (formatter *FormatterJSON) Process(entry *Entry) {
 	// add message
 	formatter.data["message"] = entry.Message
 
+	// add call stack
+	if len(entry.CallStack) > 0 {
+		caller := entry.CallStack[0]
+		formatter.data["file"] = fmt.Sprintf("%s:%d", caller.File, caller.Line)
+		formatter.data["function"] = caller.Function
+	}
+
 	// add additional fields
 	if formatter.FlatContent {
 		for _, content := range entry.Content {
@@ -57,7 +65,7 @@ func (formatter *FormatterJSON) Process(entry *Entry) {
 	}
 }
 
-func (formatter *FormatterJSON) End(entry *Entry) []byte {
+func (formatter *FormatterJSON) End(_ *Entry) []byte {
 	// build JSON
 	data, err := json.Marshal(formatter.data)
 	if err != nil {

formatter_json_test.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package golog
+package log
 
 import "testing"
 

formatter_keyvalue.go

@@ -12,16 +12,21 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package golog
+package log
 
 import (
 	"fmt"
+	"slices"
 	"strings"
 	"time"
 )
 
 type FormatterKeyValue struct {
 	TimeFormat string
+	// HighPriorityKeys are printed before the actual log message
+	HighPriorityKeys []string
+	// PriorityKeys are printed after the log message
+	PriorityKeys     []string
 	builder          strings.Builder
 	isFirstKVWritten bool
 }
@@ -35,6 +40,7 @@ func NewFormatterKeyValue() *FormatterKeyValue {
 func (formatter *FormatterKeyValue) Begin(entry *Entry) {
 	// reset builder
 	formatter.builder.Reset()
+	formatter.isFirstKVWritten = false
 
 	// add timestamp
 	formatter.addKV("time", entry.Time.Format(formatter.TimeFormat))
@@ -44,21 +50,45 @@ func (formatter *FormatterKeyValue) Begin(entry *Entry) {
 }
 
 func (formatter *FormatterKeyValue) Process(entry *Entry) {
+	// log high priority keys
+	for _, content := range entry.Content {
+		if slices.Contains(formatter.HighPriorityKeys, content.Key) {
+			formatter.addKV(content.Key, content.Value)
+		}
+	}
+
 	// add message
 	formatter.addKV("message", entry.Message)
 
+	// log priority keys
+	for _, content := range entry.Content {
+		if slices.Contains(formatter.PriorityKeys, content.Key) {
+			formatter.addKV(content.Key, content.Value)
+		}
+	}
+
+	// add call stack
+	if len(entry.CallStack) > 0 {
+		caller := entry.CallStack[0]
+		formatter.addKV("file", fmt.Sprintf("%s:%d", caller.File, caller.Line))
+		formatter.addKV("function", caller.Function)
+	}
+
 	// add additional fields
 	for _, content := range entry.Content {
+		if !slices.Contains(formatter.HighPriorityKeys, content.Key) &&
+			!slices.Contains(formatter.PriorityKeys, content.Key) {
 			formatter.addKV(content.Key, content.Value)
 		}
 	}
+}
 
 func (formatter *FormatterKeyValue) addKV(key string, value any) {
 	// convert any to string
 	val := fmt.Sprintf("%v", value)
 
 	// check, if value should be escaped
-	if strings.ContainsAny(val, " \t\n\r=") {
+	if strings.ContainsAny(val, " \t\n\r=:\\") {
 		val = fmt.Sprintf("%q", val)
 	}
 
@@ -74,7 +104,7 @@ func (formatter *FormatterKeyValue) addKV(key string, value any) {
 	formatter.builder.WriteString(val)
 }
 
-func (formatter *FormatterKeyValue) End(entry *Entry) []byte {
+func (formatter *FormatterKeyValue) End(_ *Entry) []byte {
 	// send data
 	return []byte(formatter.builder.String())
 }

formatter_keyvalue_test.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package golog
+package log
 
 import "testing"
 
@@ -26,7 +26,7 @@ func TestFormatterKeyValue(t *testing.T) {
 		},
 		Level: LevelInfo,
 	}
-	result := `time=0001-01-01T00:00:00Z level=INFO message="Some Text" k1=v1 k2=v2`
+	result := `time="0001-01-01T00:00:00Z" level=INFO message="Some Text" k1=v1 k2=v2`
 
 	// execute formatter
 	formatter := NewFormatterKeyValue()

go.mod

@@ -1,3 +1,3 @@
-module gitlab.com/martinr92/golog
+module git.martin-riedl.de/golang/log
 
 go 1.20

level.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package golog
+package log
 
 type Level uint32
 

logger.go

@@ -12,43 +12,96 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package golog
+package log
 
-import "time"
+import (
+	"runtime"
+	"strings"
+	"time"
+)
 
 var Default = NewLoggerDefault()
 
+const maxCallersPCs = 20
+
 type Logger struct {
-	Level   Level
 	Outputs []*Output
 }
 
-func NewLogger(level Level, outputs []*Output) *Logger {
+func NewLogger(outputs []*Output) *Logger {
 	return &Logger{
-		Level:   LevelInfo,
 		Outputs: outputs,
 	}
 }
 
 func NewLoggerDefault() *Logger {
-	return NewLogger(LevelInfo, []*Output{NewOutputDefault()})
+	return NewLogger([]*Output{NewOutputDefault()})
 }
 
 func (logger *Logger) LogEntry(entry *Entry) {
-	// check, if message should be printed
-	if entry.Level > logger.Level {
-		return
-	}
-
 	// set execution time
 	entry.Time = time.Now()
 
+	// set call stack
+	entry.CallStack = logger.callStack()
+
 	// run each output
 	for _, output := range logger.Outputs {
 		output.Send(entry)
 	}
 }
 
+func (logger *Logger) callStack() (response []runtime.Frame) {
+	// get call stack
+	pcs := make([]uintptr, maxCallersPCs)
+	runtime.Callers(1, pcs)
+	frames := runtime.CallersFrames(pcs)
+
+	var self string
+	for {
+		// check for next frame
+		frame, more := frames.Next()
+		if !more {
+			break
+		}
+
+		// extract self package
+		if self == "" {
+			self = logger.framePackage(frame)
+			continue
+		}
+
+		// ignore self
+		currentPackage := logger.framePackage(frame)
+		if currentPackage != self {
+			response = append(response, frame)
+		}
+	}
+
+	return
+}
+
+func (logger *Logger) framePackage(frame runtime.Frame) string {
+	s := frame.Function
+
+	// special handling, if no full qualified package exists
+	lastSlash := strings.LastIndexByte(s, '/')
+	if lastSlash == -1 {
+		firstDot := strings.IndexByte(s, '.')
+		if firstDot == -1 {
+			return s
+		}
+		return s[:firstDot]
+	}
+
+	// extract package
+	firstDot := strings.IndexByte(s[:lastSlash], '.')
+	if firstDot == -1 {
+		return s[:lastSlash]
+	}
+	return s[:lastSlash+firstDot]
+}
+
 func (logger *Logger) Log(level Level, args ...any) {
 	entry := NewEntry(logger)
 	entry.Log(level, args...)
@@ -60,6 +113,12 @@ func (logger *Logger) With(key string, value any) *Entry {
 	return entry
 }
 
+func (logger *Logger) WithMap(entries Map) *Entry {
+	entry := NewEntry(logger)
+	entry.WithMap(entries)
+	return entry
+}
+
 func (logger *Logger) WithContent(content []Content) *Entry {
 	entry := NewEntry(logger)
 	entry.WithContent(content)

output.go

@@ -12,32 +12,43 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package golog
+package log
 
 import "sync"
 
 type Output struct {
+	Level         Level
 	Formatter     Formatter
 	formatterLock sync.Mutex
 	Printer       Printer
 }
 
-func NewOutput(formatter Formatter, printer Printer) *Output {
+func NewOutput(level Level, formatter Formatter, printer Printer) *Output {
 	return &Output{
+		Level:     level,
 		Formatter: formatter,
 		Printer:   printer,
 	}
 }
 
 func NewOutputDefault() *Output {
-	return NewOutput(NewFormatterKeyValue(), NewPrinterStdout())
+	return NewOutput(LevelInfo, NewFormatterKeyValue(), NewPrinterStdout())
 }
 
 func (output *Output) Send(entry *Entry) {
-	output.format(entry)
+	// check, if message should be printed
+	if entry.Level > output.Level {
+		return
 	}
 
-func (output *Output) format(entry *Entry) {
+	// execute formatter
+	data := output.format(entry)
+
+	// execute printer
+	output.Printer.Write(data)
+}
+
+func (output *Output) format(entry *Entry) []byte {
 	output.formatterLock.Lock()
 	defer output.formatterLock.Unlock()
 
@@ -48,5 +59,8 @@ func (output *Output) format(entry *Entry) {
 	output.Formatter.Process(entry)
 
 	// finalize formatter
-	output.Formatter.End(entry)
+	data := output.Formatter.End(entry)
+
+	// return generated data
+	return data
 }

printer.go

@@ -12,8 +12,8 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package golog
+package log
 
 type Printer interface {
-	Write(p []byte) (n int, err error)
+	Write(p []byte)
 }

printer_stdout.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package golog
+package log
 
 import "os"
 
@@ -26,6 +26,7 @@ func NewPrinterStdout() *PrinterStdout {
 	}
 }
 
-func (printer *PrinterStdout) Write(p []byte) (n int, err error) {
+func (printer *PrinterStdout) Write(p []byte) {
-	return printer.out.Write(p)
+	out := append(p, '\n')
+	printer.out.Write(out)
 }

renovate.json

@@ -0,0 +1,9 @@
+{
+  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+  "extends": [
+    "local>ci/renovate//configs/base"
+  ],
+  "baseBranches": [
+    "develop"
+  ]
+}