feat(Logging): improved logger prefixes

config/config.go

@@ -15,12 +15,12 @@
 package config
 
 import (
-	logger "log"
+	"cake4everybot/logger"
 
 	"github.com/spf13/viper"
 )
 
-var log = logger.New(logger.Writer(), "[Config] ", logger.LstdFlags|logger.Lmsgprefix)
+var log = logger.New("Config")
 
 // Load loads the given configuration file as the global config. It
 // also loads:

data/lang/lang.go

@@ -15,13 +15,13 @@
 package lang
 
 import (
-	logger "log"
+	"cake4everybot/logger"
 	"strings"
 
 	"github.com/spf13/viper"
 )
 
-var log = logger.New(logger.Writer(), "[Config] ", logger.LstdFlags|logger.Lmsgprefix)
+var log = logger.New("Data/Lang")
 var langsMap = map[string]*viper.Viper{}
 
 // Unify takes and returns a string wich defines a language, i.e.

database/connection.go

@@ -15,17 +15,17 @@
 package database
 
 import (
+	"cake4everybot/logger"
 	"database/sql"
 	"fmt"
-	logger "log"
 	"time"
 
 	// mysql driver used for database
 	_ "github.com/go-sql-driver/mysql"
 	"github.com/spf13/viper"
 )
 
-var log = logger.New(logger.Writer(), "[Config] ", logger.LstdFlags|logger.Lmsgprefix)
+var log = logger.New("Config")
 var db *sql.DB
 
 type connectionConfig struct {

event/command/commandBase.go

@@ -15,18 +15,20 @@
 package command
 
 import (
+	"cake4everybot/logger"
 	"cake4everybot/modules/adventcalendar"
 	"cake4everybot/modules/birthday"
 	"cake4everybot/modules/info"
 	"cake4everybot/modules/secretsanta"
 	"cake4everybot/util"
 	"fmt"
-	"log"
 	"strings"
 
 	"github.com/bwmarrin/discordgo"
 )
 
+var log = logger.New("Event/Command")
+
 // Command is an interface wrapper for all commands. Including chat-comamnds (slash-commands),
 // message-commands, and user-commands.
 type Command interface {

event/component/componentBase.go

@@ -1,13 +1,15 @@
 package component
 
 import (
+	"cake4everybot/logger"
 	"cake4everybot/modules/adventcalendar"
 	"cake4everybot/modules/secretsanta"
-	"log"
 
 	"github.com/bwmarrin/discordgo"
 )
 
+var log = logger.New("Event/Component")
+
 // Component is an interface wrapper for all message components.
 type Component interface {
 	// Function of a component.

event/event.go

@@ -19,13 +19,13 @@ import (
 	"cake4everybot/event/component"
 	"cake4everybot/event/modal"
 	"cake4everybot/event/twitch"
-	logger "log"
+	"cake4everybot/logger"
 
 	"github.com/bwmarrin/discordgo"
 	"github.com/kesuaheli/twitchgo"
 )
 
-var log = *logger.New(logger.Writer(), "[Events] ", logger.LstdFlags|logger.Lmsgprefix)
+var log = logger.New("Event")
 
 // PostRegister registers all events, like commands after the bots are started.
 func PostRegister(dc *discordgo.Session, t *twitchgo.Session, guildID string) error {

event/modal/componentBase.go

@@ -1,8 +1,8 @@
 package modal
 
 import (
+	"cake4everybot/logger"
 	"cake4everybot/modules/secretsanta"
-	"log"
 
 	"github.com/bwmarrin/discordgo"
 )
@@ -17,6 +17,8 @@ type Modal interface {
 	ID() string
 }
 
+var log = logger.New("Event/Modal")
+
 // ModalMap holds all active modals. It maps them from a unique string identifier to the
 // corresponding [Modal].
 var ModalMap = make(map[string]Modal)

event/twitch/messageHandler.go

@@ -17,10 +17,8 @@ package twitch
 import (
 	"cake4everybot/data/lang"
 	"cake4everybot/database"
-	"cake4everybot/tools/streamelements"
 	"encoding/json"
 	"fmt"
-	logger "log"
 	"math/rand"
 	"os"
 	"strings"
@@ -32,9 +30,6 @@ import (
 
 const tp string = "twitch.command."
 
-var log logger.Logger = *logger.New(logger.Writer(), "[Twitch] ", logger.LstdFlags|logger.Lmsgprefix)
-var se *streamelements.Streamelements
-
 // MessageHandler handles new messages from the twitch chat(s). It will be called on every new
 // message.
 func MessageHandler(t *twitchgo.Session, channel string, user *twitchgo.IRCUser, message, msgID string, tags twitchgo.IRCMessageTags) {

event/twitch/twitch.go

@@ -0,0 +1,11 @@
+package twitch
+
+import (
+	"cake4everybot/logger"
+	"cake4everybot/tools/streamelements"
+)
+
+var (
+	log *logger.Logger = logger.New("Event/Twitch")
+	se  *streamelements.Streamelements
+)

event/youtube/announce.go

@@ -21,7 +21,6 @@ import (
 	webYT "cake4everybot/webserver/youtube"
 
 	"fmt"
-	"log"
 	"strings"
 
 	"github.com/bwmarrin/discordgo"

event/youtube/youtube.go

@@ -0,0 +1,7 @@
+package youtube
+
+import (
+	"cake4everybot/logger"
+)
+
+var log = logger.New("Event/YouTube")

logger/logger.go

@@ -0,0 +1,59 @@
+package logger
+
+import (
+	"fmt"
+	"log"
+	"sync"
+)
+
+// Logger is a wrapper around the standard [log.Logger] that adds a prefix to each
+// loger instance.
+type Logger struct {
+	*log.Logger
+}
+
+const (
+	prefixBrackets       = "[%s]"
+	prefixFormat         = "% -*s | "
+	prefixBracketsLength = len(prefixBrackets) - 2
+)
+
+var (
+	loggers      = make(map[string]*Logger)
+	loggersMux   sync.Mutex
+	prefixLength int
+)
+
+// New creates a new logger with the given prefix that writes to the standard
+// logger destination.
+func New(prefix string) *Logger {
+	loggersMux.Lock()
+	defer loggersMux.Unlock()
+
+	if l, ok := loggers[prefix]; ok {
+		return l
+	}
+
+	if len(prefix) > prefixLength {
+		prefixLength = len(prefix)
+		updatePrefixes()
+	}
+
+	loggers[prefix] = &Logger{log.New(
+		log.Writer(),
+		getPrefix(prefix),
+		log.LstdFlags|log.Lmsgprefix,
+	)}
+	return loggers[prefix]
+}
+
+func updatePrefixes() {
+	for prefix, l := range loggers {
+		l.SetPrefix(getPrefix(prefix))
+	}
+}
+
+func getPrefix(prefix string) string {
+	prefix = fmt.Sprintf(prefixBrackets, prefix)
+	return fmt.Sprintf(prefixFormat, prefixBracketsLength+prefixLength, prefix)
+}

main.go

@@ -16,22 +16,22 @@ package main
 
 import (
 	"context"
-	logger "log"
 	"os/signal"
 	"syscall"
 
 	"cake4everybot/config"
 	"cake4everybot/data/lang"
 	"cake4everybot/database"
 	"cake4everybot/event"
+	"cake4everybot/logger"
 	"cake4everybot/webserver"
 
 	"github.com/bwmarrin/discordgo"
 	"github.com/kesuaheli/twitchgo"
 	"github.com/spf13/viper"
 )
 
-var log = logger.New(logger.Writer(), "[MAIN] ", logger.LstdFlags|logger.Lmsgprefix)
+var log = logger.New("MAIN")
 
 const banner string = "\n" +
 	"   ______      __        __ __  ______                                     \n" +

modules/adventcalendar/adventcalendarbase.go

@@ -15,8 +15,8 @@
 package adventcalendar
 
 import (
+	"cake4everybot/logger"
 	"cake4everybot/util"
-	logger "log"
 
 	"github.com/bwmarrin/discordgo"
 )
@@ -27,7 +27,7 @@ const (
 	tp = "discord.command.adventcalendar."
 )
 
-var log = logger.New(logger.Writer(), "[Advent] ", logger.LstdFlags|logger.Lmsgprefix)
+var log = logger.New("Advent")
 
 type adventcalendarBase struct {
 	util.InteractionUtil

modules/birthday/birthdaybase.go

@@ -17,6 +17,7 @@ package birthday
 import (
 	"cake4everybot/data/lang"
 	"cake4everybot/database"
+	"cake4everybot/logger"
 	"cake4everybot/util"
 	"fmt"
 	"reflect"
@@ -33,6 +34,8 @@ const (
 	tp = "discord.command.birthday."
 )
 
+var log = logger.New("Birthday")
+
 type birthdayBase struct {
 	util.InteractionUtil
 	member *discordgo.Member

modules/birthday/handleCheck.go

@@ -19,7 +19,6 @@ import (
 	"cake4everybot/database"
 	"cake4everybot/util"
 	"fmt"
-	"log"
 	"time"
 
 	"github.com/bwmarrin/discordgo"

modules/birthday/handlerSubcommandAnnounce.go

@@ -15,7 +15,6 @@
 package birthday
 
 import (
-	"log"
 	"time"
 
 	"github.com/bwmarrin/discordgo"

modules/birthday/handlerSubcommandList.go

@@ -18,7 +18,6 @@ import (
 	"cake4everybot/data/lang"
 	"cake4everybot/util"
 	"fmt"
-	"log"
 	"time"
 
 	"github.com/bwmarrin/discordgo"

modules/birthday/handlerSubcommandRemove.go

@@ -18,7 +18,6 @@ import (
 	"cake4everybot/data/lang"
 	"cake4everybot/util"
 	"fmt"
-	"log"
 	"strconv"
 
 	"github.com/bwmarrin/discordgo"

modules/birthday/handlerSubcommandSet.go

@@ -18,7 +18,6 @@ import (
 	"cake4everybot/data/lang"
 	"cake4everybot/util"
 	"fmt"
-	"log"
 	"strconv"
 	"time"
 

modules/birthday/handlerUserShow.go

@@ -18,7 +18,6 @@ import (
 	"cake4everybot/data/lang"
 	"cake4everybot/util"
 	"fmt"
-	"log"
 	"strconv"
 
 	"github.com/bwmarrin/discordgo"

modules/secretsanta/secretsantabase.go

@@ -2,10 +2,10 @@ package secretsanta
 
 import (
 	"cake4everybot/data/lang"
+	"cake4everybot/logger"
 	"cake4everybot/util"
 	"encoding/json"
 	"fmt"
-	logger "log"
 	"os"
 
 	"github.com/bwmarrin/discordgo"
@@ -19,7 +19,7 @@ const (
 	tp = "discord.command.secretsanta."
 )
 
-var log = logger.New(logger.Writer(), "[SecretSanta] ", logger.LstdFlags|logger.Lmsgprefix)
+var log = logger.New("SecretSanta")
 
 type secretSantaBase struct {
 	util.InteractionUtil

util/universal.go

@@ -15,10 +15,10 @@
 package util
 
 import (
-	logger "log"
+	"cake4everybot/logger"
 )
 
-var log = logger.New(logger.Writer(), "[Util] ", logger.LstdFlags|logger.Lmsgprefix)
+var log = logger.New("Util")
 
 // ContainsInt reports whether at least one of num is at least once anywhere in i.
 func ContainsInt(i []int, num ...int) bool {

webserver/main.go

@@ -15,9 +15,9 @@
 package webserver
 
 import (
+	"cake4everybot/logger"
 	"cake4everybot/webserver/twitch"
 	"cake4everybot/webserver/youtube"
-	logger "log"
 	"net"
 	"net/http"
 	"time"
@@ -26,7 +26,7 @@ import (
 	"github.com/spf13/viper"
 )
 
-var log = logger.New(logger.Writer(), "[WebServer] ", logger.LstdFlags|logger.Lmsgprefix)
+var log = logger.New("WebServer")
 
 func initHTTP() http.Handler {
 	r := mux.NewRouter()