Merge pull request #7 from SenseUnit/log_prefix

Snawoot · web-flow · commit d4b737eba9d1 · 2024-02-18T15:02:09.000+02:00
Customizable log prefix
diff --git a/cmd/rgap/main.go b/cmd/rgap/main.go
@@ -1,10 +1,5 @@
 package main
 
-import (
-	"log"
-	"strings"
-)
-
 const (
 	progName = "rgap"
 )
@@ -14,7 +9,5 @@ var (
 )
 
 func main() {
-	log.Default().SetFlags(log.Ldate | log.Ltime | log.Lmicroseconds | log.Lshortfile)
-	log.Default().SetPrefix(strings.ToUpper(progName) + ": ")
 	Execute()
 }
diff --git a/cmd/rgap/root.go b/cmd/rgap/root.go
@@ -2,13 +2,56 @@ package main
 
 import (
 	"context"
+	"log"
 	"os"
 	"os/signal"
+	"strings"
 	"syscall"
 
 	"github.com/spf13/cobra"
 )
 
+const (
+	envLogPrefix = "RGAP_LOG_PREFIX"
+)
+
+var (
+	logPrefix logPrefixValue = newLogPrefixValue(defaultLogPrefix())
+)
+
+type logPrefixValue struct {
+	value *string
+}
+
+func newLogPrefixValue(s string) logPrefixValue {
+	return logPrefixValue{
+		value: &s,
+	}
+}
+
+func (v *logPrefixValue) String() string {
+	if v == nil || v.value == nil {
+		return defaultLogPrefix()
+	}
+	return *v.value
+}
+
+func (v *logPrefixValue) Type() string {
+	return "string"
+}
+
+func (v *logPrefixValue) Set(s string) error {
+	v.value = &s
+	return nil
+}
+
+func defaultLogPrefix() string {
+	if envLogPrefixValue, ok := os.LookupEnv(envLogPrefix); ok {
+		return envLogPrefixValue
+	}
+	return strings.ToUpper(progName) + ": "
+}
+
 // rootCmd represents the base command when called without any subcommands
 var rootCmd = &cobra.Command{
 	Use:          progName,
@@ -25,6 +68,8 @@ var rootCmd = &cobra.Command{
 func Execute() {
 	ctx, done := signal.NotifyContext(context.Background(), syscall.SIGINT, syscall.SIGTERM)
 	defer done()
+	log.Default().SetFlags(log.Ldate | log.Ltime | log.Lmicroseconds | log.Lshortfile)
+	log.Default().SetPrefix(logPrefix.String())
 	err := rootCmd.ExecuteContext(ctx)
 	if err != nil {
 		os.Exit(1)
@@ -36,7 +81,7 @@ func init() {
 	// Cobra supports persistent flags, which, if defined here,
 	// will be global for your application.
 
-	// rootCmd.PersistentFlags().StringVar(&cfgFile, "config", "", "config file (default is $HOME/.cmd.yaml)")
+	rootCmd.PersistentFlags().Var(&logPrefix, "log-prefix", "log prefix")
 
 	// Cobra also supports local flags, which will only run
 	// when this action is called directly.
diff --git a/output/eventlog.go b/output/eventlog.go
@@ -14,8 +14,8 @@ type EventLogConfig struct {
 }
 
 type EventLog struct {
-	bridge iface.GroupBridge
-	groups []uint64
+	bridge   iface.GroupBridge
+	groups   []uint64
 	unsubFns []func()
 }
 

Original file line number	Diff line number	Diff line change
`@@ -1,10 +1,5 @@`
`1`	`1`	`package main`
`2`	`2`
`3`		`-import (`
`4`		`- "log"`
`5`		`- "strings"`
`6`		`-)`
`7`		`-`
`8`	`3`	`const (`
`9`	`4`	`progName = "rgap"`
`10`	`5`	`)`
`@@ -14,7 +9,5 @@ var (`
`14`	`9`	`)`
`15`	`10`
`16`	`11`	`func main() {`
`17`		`- log.Default().SetFlags(log.Ldate \| log.Ltime \| log.Lmicroseconds \| log.Lshortfile)`
`18`		`- log.Default().SetPrefix(strings.ToUpper(progName) + ": ")`
`19`	`12`	`Execute()`
`20`	`13`	`}`
Original file line number	Diff line number	Diff line change
`@@ -14,8 +14,8 @@ type EventLogConfig struct {`
`14`	`14`	`}`
`15`	`15`
`16`	`16`	`type EventLog struct {`
`17`		`- bridge iface.GroupBridge`
`18`		`- groups []uint64`
	`17`	`+ bridge iface.GroupBridge`
	`18`	`+ groups []uint64`
`19`	`19`	`unsubFns []func()`
`20`	`20`	`}`
`21`	`21`