gr1ffon/quic-go
1
0
Fork 0
forked from quic-go/quic-go
Code Pull Requests Activity

Merge pull request #1375 from lucas-clemente/prefix-logger

Browse Source 
use a {client, server, proxy} prefix in logs
This commit is contained in:
Marten Seemann
2018-05-29 21:22:57 +08:00
committed by GitHub
parent 508ce03d71 6b82e46e0c
commit 9cc23135d0
7 changed files with 55 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
client.go
View File

@@ -112,7 +112,7 @@ func Dial(
tlsConf: tlsConf,
config: clientConfig,
version: version,
logger: utils.DefaultLogger,
logger: utils.DefaultLogger.WithPrefix("client"),
}
c.logger.Infof("Starting new connection to %s (%s -> %s), source connection ID %s, destination connection ID %s, version %s", hostname, c.conn.LocalAddr(), c.conn.RemoteAddr(), c.srcConnID, c.destConnID, c.version)

2
h2quic/client.go
View File

@@ -77,7 +77,7 @@ func newClient(
opts: opts,
headerErrored: make(chan struct{}),
dialer: dialer,
logger: utils.DefaultLogger,
logger: utils.DefaultLogger.WithPrefix("client"),
}
}

2
h2quic/server.go
View File

@@ -90,7 +90,7 @@ func (s *Server) serveImpl(tlsConfig *tls.Config, conn net.PacketConn) error {
if s.Server == nil {
return errors.New("use of h2quic.Server without http.Server")
}
s.logger = utils.DefaultLogger
s.logger = utils.DefaultLogger.WithPrefix("server")
s.listenerMutex.Lock()
if s.closed {
s.listenerMutex.Unlock()

2
integrationtests/tools/proxy/proxy.go
View File

@@ -134,7 +134,7 @@ func NewQuicProxy(local string, version protocol.VersionNumber, opts *Opts) (*Qu
dropPacket: packetDropper,
delayPacket: packetDelayer,
version: version,
logger: utils.DefaultLogger,
logger: utils.DefaultLogger.WithPrefix("proxy"),
}
p.logger.Debugf("Starting UDP Proxy %s <-> %s", conn.LocalAddr(), raddr)

24
internal/utils/log.go
View File

@@ -28,6 +28,7 @@ const logEnv = "QUIC_GO_LOG_LEVEL"
type Logger interface {
SetLogLevel(LogLevel)
SetLogTimeFormat(format string)
WithPrefix(prefix string) Logger
Debug() bool
Errorf(format string, args ...interface{})
@@ -39,6 +40,8 @@ type Logger interface {
var DefaultLogger Logger
type defaultLogger struct {
prefix string
logLevel LogLevel
timeFormat string
}
@@ -79,10 +82,25 @@ func (l *defaultLogger) Errorf(format string, args ...interface{}) {
}
func (l *defaultLogger) logMessage(format string, args ...interface{}) {
var pre string
if len(l.timeFormat) > 0 {
log.Printf(time.Now().Format(l.timeFormat)+" "+format, args...)
} else {
log.Printf(format, args...)
pre = time.Now().Format(l.timeFormat) + " "
}
if len(l.prefix) > 0 {
pre += l.prefix + " "
}
log.Printf(pre+format, args...)
}
func (l *defaultLogger) WithPrefix(prefix string) Logger {
if len(l.prefix) > 0 {
prefix = l.prefix + " " + prefix
}
return &defaultLogger{
logLevel: l.logLevel,
timeFormat: l.timeFormat,
prefix: prefix,
}
}

41
internal/utils/log_test.go
View File

@@ -35,7 +35,7 @@ var _ = Describe("Log", func() {
DefaultLogger.Debugf("debug")
DefaultLogger.Infof("info")
DefaultLogger.Errorf("err")
Expect(b.Bytes()).To(Equal([]byte("")))
Expect(b.String()).To(BeEmpty())
})
It("log level err", func() {
@@ -43,9 +43,9 @@ var _ = Describe("Log", func() {
DefaultLogger.Debugf("debug")
DefaultLogger.Infof("info")
DefaultLogger.Errorf("err")
Expect(b.Bytes()).To(ContainSubstring("err\n"))
Expect(b.Bytes()).ToNot(ContainSubstring("info"))
Expect(b.Bytes()).ToNot(ContainSubstring("debug"))
Expect(b.String()).To(ContainSubstring("err\n"))
Expect(b.String()).ToNot(ContainSubstring("info"))
Expect(b.String()).ToNot(ContainSubstring("debug"))
})
It("log level info", func() {
@@ -53,9 +53,9 @@ var _ = Describe("Log", func() {
DefaultLogger.Debugf("debug")
DefaultLogger.Infof("info")
DefaultLogger.Errorf("err")
Expect(b.Bytes()).To(ContainSubstring("err\n"))
Expect(b.Bytes()).To(ContainSubstring("info\n"))
Expect(b.Bytes()).ToNot(ContainSubstring("debug"))
Expect(b.String()).To(ContainSubstring("err\n"))
Expect(b.String()).To(ContainSubstring("info\n"))
Expect(b.String()).ToNot(ContainSubstring("debug"))
})
It("log level debug", func() {
@@ -63,16 +63,16 @@ var _ = Describe("Log", func() {
DefaultLogger.Debugf("debug")
DefaultLogger.Infof("info")
DefaultLogger.Errorf("err")
Expect(b.Bytes()).To(ContainSubstring("err\n"))
Expect(b.Bytes()).To(ContainSubstring("info\n"))
Expect(b.Bytes()).To(ContainSubstring("debug\n"))
Expect(b.String()).To(ContainSubstring("err\n"))
Expect(b.String()).To(ContainSubstring("info\n"))
Expect(b.String()).To(ContainSubstring("debug\n"))
})
It("doesn't add a timestamp if the time format is empty", func() {
DefaultLogger.SetLogLevel(LogLevelDebug)
DefaultLogger.SetLogTimeFormat("")
DefaultLogger.Debugf("debug")
Expect(b.Bytes()).To(Equal([]byte("debug\n")))
Expect(b.String()).To(Equal("debug\n"))
})
It("adds a timestamp", func() {
@@ -80,7 +80,7 @@ var _ = Describe("Log", func() {
DefaultLogger.SetLogTimeFormat(format)
DefaultLogger.SetLogLevel(LogLevelInfo)
DefaultLogger.Infof("info")
t, err := time.Parse(format, string(b.Bytes()[:b.Len()-6]))
t, err := time.Parse(format, string(b.String()[:b.Len()-6]))
Expect(err).ToNot(HaveOccurred())
Expect(t).To(BeTemporally("~", time.Now(), 25*time.Hour))
})
@@ -91,6 +91,23 @@ var _ = Describe("Log", func() {
Expect(DefaultLogger.Debug()).To(BeTrue())
})
It("adds a prefix", func() {
DefaultLogger.SetLogLevel(LogLevelDebug)
prefixLogger := DefaultLogger.WithPrefix("prefix")
prefixLogger.Debugf("debug")
Expect(b.String()).To(ContainSubstring("prefix"))
Expect(b.String()).To(ContainSubstring("debug"))
})
It("adds multiple prefixes", func() {
DefaultLogger.SetLogLevel(LogLevelDebug)
prefixLogger := DefaultLogger.WithPrefix("prefix1")
prefixPrefixLogger := prefixLogger.WithPrefix("prefix2")
prefixPrefixLogger.Debugf("debug")
Expect(b.String()).To(ContainSubstring("prefix"))
Expect(b.String()).To(ContainSubstring("debug"))
})
Context("reading from env", func() {
BeforeEach(func() {
Expect(DefaultLogger.(*defaultLogger).logLevel).To(Equal(LogLevelNothing))

2
server.go
View File

@@ -110,7 +110,7 @@ func Listen(conn net.PacketConn, tlsConf *tls.Config, config *Config) (Listener,
sessionQueue: make(chan Session, 5),
errorChan: make(chan struct{}),
supportsTLS: supportsTLS,
logger: utils.DefaultLogger,
logger: utils.DefaultLogger.WithPrefix("server"),
}
if supportsTLS {
if err := s.setupTLS(); err != nil {