Merge lp:~jameinel/loggo/benchmarks into lp:loggo

[Tim Penhey]

Creating so I can see the diff :)

=== modified file 'logger_test.go'
--- logger_test.go	2013-05-30 23:22:35 +0000
+++ logger_test.go	2013-06-04 02:41:26 +0000
@@ -2,6 +2,8 @@
 
 import (
 	"fmt"
+	"io/ioutil"
+	"os"
 	"strings"
 	"testing"
 
@@ -268,3 +270,85 @@
 	c.Assert(s.writer.Log, HasLen, 1)
 	c.Assert(s.writer.Log[0].Message, Equals, "some % included")
 }
+
+func (s *logwriterSuite) BenchmarkLoggingNoWriters(c *C) {
+	// No writers
+	loggo.RemoveWriter("test")
+	for i := 0; i < c.N; i++ {
+		s.logger.Warning("just a simple warning for %d", i)
+	}
+}
+
+func (s *logwriterSuite) BenchmarkLoggingNoWritersNoFormat(c *C) {
+	// No writers
+	loggo.RemoveWriter("test")
+	for i := 0; i < c.N; i++ {
+		s.logger.Warning("just a simple warning")
+	}
+}
+
+func (s *logwriterSuite) BenchmarkLoggingTestWriters(c *C) {
+	for i := 0; i < c.N; i++ {
+		s.logger.Warning("just a simple warning for %d", i)
+	}
+	c.Assert(s.writer.Log, HasLen, c.N)
+}
+
+func setupTempFileWriter(c *C) (logFile *os.File, cleanup func()) {
+	loggo.RemoveWriter("test")
+	logFile, err := ioutil.TempFile("", "loggo-test")
+	c.Assert(err, IsNil)
+	cleanup = func() {
+		logFile.Close()
+		os.Remove(logFile.Name())
+	}
+	writer := loggo.NewSimpleWriter(logFile, &loggo.DefaultFormatter{})
+	err = loggo.RegisterWriter("testfile", writer, loggo.TRACE)
+	c.Assert(err, IsNil)
+	return
+}
+
+func (s *logwriterSuite) BenchmarkLoggingDiskWriter(c *C) {
+	logFile, cleanup := setupTempFileWriter(c)
+	defer cleanup()
+	msg := "just a simple warning for %d"
+	for i := 0; i < c.N; i++ {
+		s.logger.Warning(msg, i)
+	}
+	offset, err := logFile.Seek(0, os.SEEK_CUR)
+	c.Assert(err, IsNil)
+	c.Assert((offset > int64(len(msg))*int64(c.N)), Equals, true,
+		Commentf("Not enough data was written to the log file."))
+}
+
+func (s *logwriterSuite) BenchmarkLoggingDiskWriterNoMessages(c *C) {
+	logFile, cleanup := setupTempFileWriter(c)
+	defer cleanup()
+	// Change the log level
+	writer, _, err := loggo.RemoveWriter("testfile")
+	c.Assert(err, IsNil)
+	loggo.RegisterWriter("testfile", writer, loggo.WARNING)
+	msg := "just a simple warning for %d"
+	for i := 0; i < c.N; i++ {
+		s.logger.Debug(msg, i)
+	}
+	offset, err := logFile.Seek(0, os.SEEK_CUR)
+	c.Assert(err, IsNil)
+	c.Assert(offset, Equals, int64(0),
+		Commentf("Data was written to the log file."))
+}
+
+func (s *logwriterSuite) BenchmarkLoggingDiskWriterNoMessagesLogLevel(c *C) {
+	logFile, cleanup := setupTempFileWriter(c)
+	defer cleanup()
+	// Change the log level
+	s.logger.SetLogLevel(loggo.WARNING)
+	msg := "just a simple warning for %d"
+	for i := 0; i < c.N; i++ {
+		s.logger.Debug(msg, i)
+	}
+	offset, err := logFile.Seek(0, os.SEEK_CUR)
+	c.Assert(err, IsNil)
+	c.Assert(offset, Equals, int64(0),
+		Commentf("Data was written to the log file."))
+}

=== modified file 'writer.go'
--- writer.go	2013-05-30 07:19:57 +0000
+++ writer.go	2013-06-04 02:41:26 +0000
@@ -38,6 +38,7 @@
 			level:  TRACE,
 		},
 	}
+	globalMinLevel = TRACE
 )
 
 // ResetWriters puts the list of writers back into the initial state.
@@ -50,6 +51,7 @@
 			level:  TRACE,
 		},
 	}
+	findMinLevel()
 }
 
 // ReplaceDefaultWriter is a convenience method that does the equivalent of
@@ -85,6 +87,7 @@
 		return fmt.Errorf("There is already a Writer registerd with the name %q", name)
 	}
 	writers[name] = &registeredWriter{writer: writer, level: minLevel}
+	findMinLevel()
 	return nil
 }
 
@@ -98,9 +101,26 @@
 		return nil, NOT_SPECIFIED, fmt.Errorf("No registered Writer called %q", name)
 	}
 	delete(writers, name)
+	findMinLevel()
 	return registered.writer, registered.level, nil
 }
 
+func findMinLevel() {
+	// We assume the lock is already held
+	minLevel := CRITICAL
+	for _, registered := range writers {
+		if registered.level < minLevel {
+			minLevel = registered.level
+		}
+	}
+	globalMinLevel = minLevel
+}
+
+// Are there any writers that are interested in this log level?
+func WillWrite(level Level) bool {
+	return level >= globalMinLevel
+}
+
 func writeToWriters(level Level, module, filename string, line int, timestamp time.Time, message string) {
 	writerMutex.Lock()
 	defer writerMutex.Unlock()

=== modified file 'writer_test.go'
--- writer_test.go	2013-05-30 04:14:29 +0000
+++ writer_test.go	2013-06-04 02:41:26 +0000
@@ -65,6 +65,23 @@
 	c.Assert(err, ErrorMatches, `There is no "default" writer`)
 }
 
+func (s *writerBasicsSuite) TestWillWrite(c *C) {
+	// By default, the root logger watches TRACE messages
+	c.Assert(loggo.WillWrite(loggo.TRACE), Equals, true)
+	// Note: ReplaceDefaultWriter doesn't let us change the default log
+	//	 level :(
+	writer, _, err := loggo.RemoveWriter("default")
+	c.Assert(err, IsNil)
+	c.Assert(writer, NotNil)
+	err = loggo.RegisterWriter("default", writer, loggo.CRITICAL)
+	c.Assert(err, IsNil)
+	c.Assert(loggo.WillWrite(loggo.TRACE), Equals, false)
+	c.Assert(loggo.WillWrite(loggo.DEBUG), Equals, false)
+	c.Assert(loggo.WillWrite(loggo.INFO), Equals, false)
+	c.Assert(loggo.WillWrite(loggo.WARNING), Equals, false)
+	c.Assert(loggo.WillWrite(loggo.CRITICAL), Equals, true)
+}
+
 type writerSuite struct {
 	logger loggo.Logger
 }
@@ -99,7 +116,7 @@
 	// updated.
 	c.Assert(writer.Log, HasLen, 1)
 	c.Assert(writer.Log[0].Filename, Equals, "writer_test.go")
-	c.Assert(writer.Log[0].Line, Equals, 95)
+	c.Assert(writer.Log[0].Line, Equals, 112)
 	c.Assert(writer.Log[0].Module, Equals, "test.writer")
 }