Changeset 747 in code

Timestamp:

Dec 6, 2021, 5:35:49 PM (4 years ago)

Author:

contact

Message:

Add Logger.Debugf

Makes it easy to print debugging messages which aren't targeted at
the user. See [1] for motivation.

[1]: ​https://dave.cheney.net/2015/11/05/lets-talk-about-logging

Location:

trunk

Files:

• cmd/soju/main.go (modified) (2 diffs)
• conn.go (modified) (2 diffs)
• server.go (modified) (4 diffs)

trunk/cmd/soju/main.go

@@ -98 +98 @@
                 MultiUpstream:   raw.MultiUpstream,
                 UpstreamUserIPs: raw.UpstreamUserIPs,
-                Debug:           debug,
                 MOTD:            motd,
         }
@@ -141 +140 @@
         srv := soju.NewServer(db)
         srv.SetConfig(serverCfg)
+        srv.Logger = soju.NewLogger(log.Writer(), debug)
 
         for _, listen := range cfg.Listen {

trunk/conn.go

@@ -157 +157 @@
                         }
 
-                        if c.srv.Config().Debug {
-                                c.logger.Printf("sent: %v", msg)
-                        }
+                        c.logger.Debugf("sent: %v", msg)
                         c.conn.SetWriteDeadline(time.Now().Add(writeTimeout))
                         if err := c.conn.WriteMessage(msg); err != nil {
@@ -211 +209 @@
         }
 
-        if c.srv.Config().Debug {
-                c.logger.Printf("received: %v", msg)
-        }
-
+        c.logger.Debugf("received: %v", msg)
         return msg, nil
 }

trunk/server.go

@@ -39 +39 @@
 type Logger interface {
         Printf(format string, v ...interface{})
+        Debugf(format string, v ...interface{})
+}
+
+type logger struct {
+        *log.Logger
+        debug bool
+}
+
+func (l logger) Debugf(format string, v ...interface{}) {
+        if !l.debug {
+                return
+        }
+        l.Logger.Printf(format, v...)
+}
+
+func NewLogger(out io.Writer, debug bool) Logger {
+        return logger{
+                Logger: log.New(log.Writer(), "", log.LstdFlags),
+                debug:  debug,
+        }
 }
 
@@ -51 +71 @@
         v = append([]interface{}{l.prefix}, v...)
         l.logger.Printf("%v"+format, v...)
+}
+
+func (l *prefixLogger) Debugf(format string, v ...interface{}) {
+        v = append([]interface{}{l.prefix}, v...)
+        l.logger.Debugf("%v"+format, v...)
 }
 
@@ -73 +98 @@
         Title           string
         LogPath         string
-        Debug           bool
         HTTPOrigins     []string
         AcceptProxyIPs  config.IPSet
@@ -110 +134 @@
 func NewServer(db Database) *Server {
         srv := &Server{
-                Logger:    log.New(log.Writer(), "", log.LstdFlags),
+                Logger:    NewLogger(log.Writer(), true),
                 db:        db,
                 listeners: make(map[net.Listener]struct{}),