Add function start stop log

Author: tknie

go.mod

@@ -5,14 +5,15 @@ go 1.19
 require (
 	github.com/sirupsen/logrus v1.9.1
 	github.com/stretchr/testify v1.8.1
-	go.uber.org/zap v1.24.0
+	go.uber.org/zap v1.27.1
 )
 
 require (
 	github.com/davecgh/go-spew v1.1.1 // indirect
 	github.com/pmezard/go-difflib v1.0.0 // indirect
 	go.uber.org/atomic v1.7.0 // indirect
-	go.uber.org/multierr v1.6.0 // indirect
+	go.uber.org/multierr v1.11.0 // indirect
 	golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8 // indirect
+	gopkg.in/natefinch/lumberjack.v2 v2.2.1
 	gopkg.in/yaml.v3 v3.0.1 // indirect
 )

go.sum

@@ -21,12 +21,20 @@ go.uber.org/atomic v1.7.0/go.mod h1:fEN4uk6kAWBTFdckzkM89CLk9XfWZrxpCo0nPH17wJc=
 go.uber.org/goleak v1.1.11 h1:wy28qYRKZgnJTxGxvye5/wgWr1EKjmUDGYox5mGlRlI=
 go.uber.org/multierr v1.6.0 h1:y6IPFStTAIT5Ytl7/XYmHvzXQ7S3g/IeZW9hyZ5thw4=
 go.uber.org/multierr v1.6.0/go.mod h1:cdWPpRnG4AhwMwsgIHip0KRBQjJy5kYEpYjJxpXp9iU=
+go.uber.org/multierr v1.10.0 h1:S0h4aNzvfcFsC3dRF1jLoaov7oRaKqRGC/pUEJ2yvPQ=
+go.uber.org/multierr v1.10.0/go.mod h1:20+QtiLqy0Nd6FdQB9TLXag12DsQkrbs3htMFfDN80Y=
+go.uber.org/multierr v1.11.0 h1:blXXJkSxSSfBVBlC76pxqeO+LN3aDfLQo+309xJstO0=
+go.uber.org/multierr v1.11.0/go.mod h1:20+QtiLqy0Nd6FdQB9TLXag12DsQkrbs3htMFfDN80Y=
 go.uber.org/zap v1.24.0 h1:FiJd5l1UOLj0wCgbSE0rwwXHzEdAZS6hiiSnxJN/D60=
 go.uber.org/zap v1.24.0/go.mod h1:2kMP+WWQ8aoFoedH3T2sq6iJ2yDWpHbP0f6MQbS9Gkg=
+go.uber.org/zap v1.27.1 h1:08RqriUEv8+ArZRYSTXy1LeBScaMpVSTBhCeaZYfMYc=
+go.uber.org/zap v1.27.1/go.mod h1:GB2qFLM7cTU87MWRP2mPIjqfIDnGu+VIO4V/SdhGo2E=
 golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8 h1:0A+M6Uqn+Eje4kHMK80dtF3JCXC4ykBgQG4Fe06QRhQ=
 golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/natefinch/lumberjack.v2 v2.2.1 h1:bBRl1b0OH9s/DuPhuXpNl+VtCaJXFZ5/uEFST95x9zc=
+gopkg.in/natefinch/lumberjack.v2 v2.2.1/go.mod h1:YD8tP3GAjkrDg1eZH7EGmyESg/lsYskCTPBJVb9jqSc=
 gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
 gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
 gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

logging.go

@@ -1,5 +1,5 @@
 /*
-* Copyright 2022-2024 Thorsten A. Knieling
+* Copyright 2022-2026 Thorsten A. Knieling
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
@@ -14,6 +14,7 @@ package log
 import (
 	"fmt"
 	"os"
+	"runtime"
 	"strings"
 	"time"
 )
@@ -85,7 +86,7 @@ type LogI interface {
 
 // Central central configuration
 var Log = LogI(lognil())
-var debug = false
+var debugEnabled = false
 
 func InitLog(newLog LogI) {
 	Log = newLog
@@ -106,12 +107,12 @@ func InitLog(newLog LogI) {
 }
 
 func IsDebugLevel() bool {
-	return debug
+	return debugEnabled
 }
 
 func SetDebugLevel(debugIn bool) {
-	debug = debugIn
-	if debug {
+	debugEnabled = debugIn
+	if debugEnabled {
 		fmt.Println("Warning DB debug is enabled")
 	}
 }
@@ -139,3 +140,29 @@ func TimeTrack(start time.Time, name string) {
 	elapsed := time.Since(start)
 	Log.Infof("%s took %s", name, elapsed)
 }
+
+// LogFunctionStart log function start if debug is enabled
+func LogFunctionStart() {
+	if !debugEnabled {
+		return
+	}
+	pc, _, _, ok := runtime.Caller(1)
+	details := runtime.FuncForPC(pc)
+	if ok && details != nil {
+		Log.Debugf("Entering %s())", details.Name())
+	}
+}
+
+// LogFunctionEnd log function end if debug is enabled
+// Usage: defer LogFunctionEnd(time.Now())
+func LogFunctionEnd(start time.Time) {
+	if !debugEnabled {
+		return
+	}
+	pc, _, _, ok := runtime.Caller(1)
+	details := runtime.FuncForPC(pc)
+	if ok && details != nil {
+		elapsed := time.Since(start)
+		Log.Debugf("Leaving %s() tooks %s ms", details.Name(), elapsed)
+	}
+}

logging_test.go

@@ -1,5 +1,5 @@
 /*
-* Copyright 2022-2024 Thorsten A. Knieling
+* Copyright 2022-2026 Thorsten A. Knieling
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
@@ -12,13 +12,10 @@
 package log
 
 import (
-	"encoding/json"
 	"fmt"
 	"io"
 	"net/url"
 	"os"
-	"path/filepath"
-	"runtime"
 	"testing"
 	"time"
 
@@ -29,8 +26,8 @@ import (
 )
 
 func initTestLogWithFile(t *testing.T, fileName string) error {
-	err := initLogLevelWithFile(fileName, zapcore.DebugLevel)
-	if err != nil {
+	err := InitZapLogLevelWithFile(fileName, zapcore.DebugLevel)
+	if !assert.NoError(t, err) {
 		t.Fatalf("error opening file: %v", err)
 	}
 	return err
@@ -41,59 +38,16 @@ func newWinFileSink(u *url.URL) (zap.Sink, error) {
 	return os.OpenFile(u.Path[1:], os.O_WRONLY|os.O_APPEND|os.O_CREATE, 0644)
 }
 
-func initLogLevelWithFile(fileName string, level zapcore.Level) (err error) {
-	p := os.Getenv("LOGPATH")
-	if p == "" {
-		p = os.TempDir()
-	}
-	var name string
-	if runtime.GOOS == "windows" {
-		zap.RegisterSink("winfile", newWinFileSink)
-		//		OutputPaths: []string{"stdout", "winfile:///" + filepath.Join(GlobalConfigDir.Path, "info.log.json")},
-		name = "winfile:///" + p + string(os.PathSeparator) + fileName
-	} else {
-		name = "file://" + filepath.ToSlash(p+string(os.PathSeparator)+fileName)
-	}
-
-	rawJSON := []byte(`{
-	"level": "error",
-	"encoding": "console",
-	"outputPaths": [ "XXX"],
-	"errorOutputPaths": ["stderr"],
-	"encoderConfig": {
-	  "messageKey": "message",
-	  "levelKey": "level",
-	  "levelEncoder": "lowercase"
-	}
-  }`)
-
-	var cfg zap.Config
-	if err := json.Unmarshal(rawJSON, &cfg); err != nil {
-		return err
-	}
-	cfg.Level.SetLevel(level)
-	cfg.OutputPaths = []string{name}
-	logger, err := cfg.Build()
-	if err != nil {
-		return err
-	}
-	defer logger.Sync()
-
-	sugar := logger.Sugar()
-	InitLog(sugar)
-
-	sugar.Infof("AdabasGoApi logger initialization succeeded")
-	return nil
-}
-
 func doTrackCall() {
 	defer TimeTrack(time.Now(), "Time Track Unit test ")
 
 }
 
 func TestLogZap(t *testing.T) {
 	fileName := "zap.log"
-	os.Remove(os.TempDir() + "/" + fileName)
+	fileName = os.TempDir() + "/" + fileName
+	fmt.Println("Use log file:", fileName)
+	os.Remove(fileName)
 	err := initTestLogWithFile(t, fileName)
 	if !assert.NoError(t, err) {
 		fmt.Println(err)
@@ -111,20 +65,21 @@ func TestLogZap(t *testing.T) {
 	SetDebugLevel(false)
 	SetDebugLevel(d)
 
-	flog, err := os.Open(os.TempDir() + "/" + fileName)
+	flog, err := os.Open(fileName)
 	if !assert.NoError(t, err) {
 		return
 	}
 	logInfo, err := io.ReadAll(flog)
 	if !assert.NoError(t, err) {
 		return
 	}
-	assert.Regexp(t, `info	AdabasGoApi logger initialization succeeded
-info	Time Track Unit test  took \d*ns
-debug	This is a test of data HELLO
-debug	ABC
-debug	XXXX
-debug`, string(logInfo))
+	assert.Regexp(t, `....-..-.. ..:..:..\tinfo\tStart logging with level debug
+....-..-.. ..:..:..\tinfo\tTime Track Unit test  took [0-8]*ns
+....-..-.. ..:..:..\tdebug\tThis is a test of data HELLO
+....-..-.. ..:..:..\tdebug\tABC
+....-..-.. ..:..:..\tdebug\tXXXX
+....-..-.. ..:..:..\tdebug\t
+`, string(logInfo))
 }
 
 func TestLogrus(t *testing.T) {
@@ -208,3 +163,32 @@ func TestCache(t *testing.T) {
 	Log.Errorf("ERROR: Post-log information")
 	assert.Equal(t, testResult, testLog.testLog)
 }
+
+func TestStackTest(t *testing.T) {
+	InitZapLogLevelWithFile("StackTest.log", zapcore.DebugLevel)
+	Log.Debugf("DEBUG: Post-log information")
+	Log.Infof("INFO: Post-log information")
+	Log.Errorf("ERROR: Post-log information")
+	stack1()
+}
+
+func stack1() {
+	LogFunctionStart()
+	stack2()
+	defer LogFunctionEnd(time.Now())
+
+}
+
+func stack2() {
+	LogFunctionStart()
+	stack3()
+	defer LogFunctionEnd(time.Now())
+
+}
+
+func stack3() {
+	LogFunctionStart()
+	Log.Debugf("In stack3")
+	defer LogFunctionEnd(time.Now())
+
+}

zaplog.go

@@ -0,0 +1,97 @@
+/*
+* Copyright 2026 Thorsten A. Knieling
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+ */
+
+package log
+
+import (
+	"fmt"
+	"os"
+	"strings"
+	"time"
+
+	"go.uber.org/zap"
+	"go.uber.org/zap/zapcore"
+	"gopkg.in/natefinch/lumberjack.v2"
+)
+
+var level = zapcore.ErrorLevel
+
+func init() {
+	ed := os.Getenv("ENABLE_LOGLEVEL")
+	switch strings.ToLower(ed) {
+	case "0", "error":
+		level = zapcore.ErrorLevel
+	case "1":
+		level = zapcore.FatalLevel
+	case "2", "warn", "warning":
+		level = zapcore.WarnLevel
+	case "3", "info":
+		level = zapcore.InfoLevel
+	case "4", "debug":
+		level = zapcore.DebugLevel
+	}
+}
+
+func InitZapLogLevelWithFilename(fileName string, levelIn zapcore.Level) (err error) {
+	level = levelIn
+	p := os.Getenv("LOGPATH")
+	if p == "" {
+		p = "."
+	} else {
+		if _, err := os.Stat(p); os.IsNotExist(err) {
+			err := os.Mkdir(p, os.ModePerm)
+			if err != nil {
+				fmt.Printf("Error creating log path '%s': %v\n", p, err)
+				os.Exit(255)
+			}
+		}
+	}
+
+	name := p + string(os.PathSeparator) + fileName
+	return InitZapLogWithFile(name)
+}
+
+func InitZapLogLevelWithFile(fileName string, levelIn zapcore.Level) (err error) {
+	level = levelIn
+
+	return InitZapLogWithFile(fileName)
+}
+
+func InitZapLogWithFile(name string) (err error) {
+	lumberLog := &lumberjack.Logger{
+		Filename:   name, // Location of the log file
+		MaxSize:    10,   // Maximum file size (in MB)
+		MaxBackups: 3,    // Maximum number of old files to retain
+		MaxAge:     28,   // Maximum number of days to retain old files
+		Compress:   true, // Whether to compress/archive old files
+		LocalTime:  true, // Use local time for timestamps
+	}
+	writer := zapcore.AddSync(lumberLog)
+	cfg := zap.NewProductionEncoderConfig()
+	cfg.TimeKey = "timestamp"
+	cfg.EncodeTime = zapcore.TimeEncoderOfLayout(time.DateTime)
+
+	core := zapcore.NewCore(
+		zapcore.NewConsoleEncoder(cfg),
+		writer,
+		level,
+	)
+	logger := zap.New(core)
+	defer logger.Sync() // Flush any buffered log entries
+
+	sugar := logger.Sugar()
+
+	sugar.Infof("Start logging with level %s", level)
+	Log = sugar
+	SetDebugLevel(level == zapcore.DebugLevel)
+
+	return
+}