godoc update and improvements

Author: jeevatkm

console_receiver.go

@@ -9,6 +9,7 @@ import (
 	"io"
 	"os"
 	"runtime"
+	"sync"
 
 	"aahframework.org/config.v0"
 )
@@ -32,6 +33,7 @@ var (
 // ConsoleReceiver writes the log entry into os.Stderr.
 // For non-windows it  writes with color.
 type ConsoleReceiver struct {
+	rw           *sync.RWMutex
 	out          io.Writer
 	formatter    string
 	flags        *[]FlagPart
@@ -58,6 +60,8 @@ func (c *ConsoleReceiver) Init(cfg *config.Config) error {
 
 // SetPattern method initializes the logger format pattern.
 func (c *ConsoleReceiver) SetPattern(pattern string) error {
+	c.rw.Lock()
+	defer c.rw.Unlock()
 	flags, err := parseFlag(pattern)
 	if err != nil {
 		return err
@@ -77,6 +81,8 @@ func (c *ConsoleReceiver) IsCallerInfo() bool {
 
 // Log method writes the log entry into os.Stderr.
 func (c *ConsoleReceiver) Log(entry *Entry) {
+	c.rw.RLock()
+	defer c.rw.RUnlock()
 	if c.isColor {
 		_, _ = c.out.Write(levelToColor[entry.Level])
 	}

default.go

@@ -123,6 +123,21 @@ func Panicln(format string, v ...interface{}) {
 	panic(fmt.Sprintf(format, v...))
 }
 
+// SetDefaultLogger method sets the given logger instance as default logger.
+func SetDefaultLogger(l *Logger) {
+	std = l
+}
+
+// SetLevel method sets log level for default logger.
+func SetLevel(level string) error {
+	return std.SetLevel(level)
+}
+
+// SetPattern method sets the log format pattern for default logger.
+func SetPattern(pattern string) error {
+	return std.SetPattern(pattern)
+}
+
 func init() {
 	cfg, _ := config.ParseString("log { }")
 	std, _ = New(cfg)

file_receiver.go

@@ -10,6 +10,7 @@ import (
 	"io"
 	"os"
 	"path/filepath"
+	"sync"
 	"time"
 
 	"aahframework.org/config.v0"
@@ -20,6 +21,7 @@ var _ Receiver = &FileReceiver{}
 
 // FileReceiver writes the log entry into file.
 type FileReceiver struct {
+	rw           *sync.RWMutex
 	filename     string
 	out          io.Writer
 	formatter    string
@@ -74,6 +76,8 @@ func (f *FileReceiver) Init(cfg *config.Config) error {
 
 // SetPattern method initializes the logger format pattern.
 func (f *FileReceiver) SetPattern(pattern string) error {
+	f.rw.Lock()
+	defer f.rw.Unlock()
 	flags, err := parseFlag(pattern)
 	if err != nil {
 		return err
@@ -97,6 +101,8 @@ func (f *FileReceiver) IsCallerInfo() bool {
 
 // Log method logs the given entry values into file.
 func (f *FileReceiver) Log(entry *Entry) {
+	f.rw.RLock()
+	defer f.rw.RUnlock()
 	if f.isRotate() {
 		_ = f.rotateFile()
 	}

formatter.go

@@ -85,12 +85,8 @@ func applyFormatter(formatter string, flags *[]FlagPart, entry *Entry) []byte {
 		return textFormatter(flags, entry)
 	}
 
-	lm, err := jsonFormatter(entry)
-	if err == nil {
-		return lm
-	}
-
-	return []byte(err.Error())
+	lm, _ := jsonFormatter(entry)
+	return lm
 }
 
 // parseFlag it parses the log message formart into flag parts

log.go

@@ -2,22 +2,23 @@
 // go-aah/log source code and usage is governed by a MIT style
 // license that can be found in the LICENSE file.
 
-// Package log implements a simple, flexible & powerful logger.
-// Currently it supports `console`, `file` (rotation by daily, size,  lines),
-// logging receivers and logging stats. It also has a predefined 'standard'
-// Logger accessible through helper functions `Error{f}`, `Warn{f}`, `Info{f}`,
-// `Debug{f}`, `Trace{f}` which are easier to use than creating a Logger manually.
-// That logger writes to standard error and prints log `Entry` details
-// as per `DefaultPattern`.
+// Package log implements a simple, flexible, non-blocking logger.
+// It supports `console`, `file` (rotation by daily, size, lines).
+// It also has a predefined 'standard' Logger accessible through helper
+// functions `Error{f}`, `Warn{f}`, `Info{f}`, `Debug{f}`, `Trace{f}`,
+// `Print{f,ln}`, `Fatal{f,ln}`, `Panic{f,ln}` which are easier to use than creating
+// a Logger manually. Default logger writes to standard error and prints log
+// `Entry` details as per `DefaultPattern`.
 //
-// Note: aah log package is drop-in replacement for standard go logger with features.
+// aah log package can be used as drop-in replacement for standard go logger
+// with features.
 //
 // 	log.Info("Welcome ", "to ", "aah ", "logger")
-// 	log.Infof("%v, %v, & %v", "simple", "flexible", "powerful logger")
+// 	log.Infof("%v, %v, %v", "simple", "flexible", "non-blocking logger")
 //
 // 	// Output:
-// 	2016-07-03 19:22:11.504 INFO  - Welcome to aah logger
-// 	2016-07-03 19:22:11.504 INFO  - simple, flexible, & powerful logger
+// 	2016-07-03 19:22:11.504 INFO  Welcome to aah logger
+// 	2016-07-03 19:22:11.504 INFO  simple, flexible, non-blocking logger
 package log
 
 import (
@@ -188,19 +189,17 @@ func (l *Logger) SetPattern(pattern string) error {
 	if l.receiver == nil {
 		return ErrLogReceiverIsNil
 	}
-
-	l.m.Lock()
-	defer l.m.Unlock()
 	return l.receiver.SetPattern(pattern)
 }
 
 // SetReceiver sets the given receiver into logger instance.
 func (l *Logger) SetReceiver(receiver Receiver) error {
+	l.m.Lock()
+	defer l.m.Unlock()
+
 	if receiver == nil {
 		return ErrLogReceiverIsNil
 	}
-	l.m.Lock()
-	defer l.m.Unlock()
 
 	l.receiver = receiver
 	return l.receiver.Init(l.cfg)

util.go

@@ -7,6 +7,7 @@ package log
 import (
 	"runtime"
 	"strings"
+	"sync"
 	"time"
 )
 
@@ -79,9 +80,9 @@ func isCallerInfo(flags *[]FlagPart) bool {
 
 func getReceiverByName(name string) Receiver {
 	if name == "FILE" {
-		return &FileReceiver{}
+		return &FileReceiver{rw: &sync.RWMutex{}}
 	} else if name == "CONSOLE" {
-		return &ConsoleReceiver{}
+		return &ConsoleReceiver{rw: &sync.RWMutex{}}
 	}
 	return nil
 }