add logger message format

Author: phachon

README.md

@@ -18,19 +18,51 @@ A simple but powerful golang log Toolkit
 go get github.com/phachon/go-logger
 go get ./...
 ```
+
 # Requirement
 go 1.8
 
 # Support outputs
-- console //write console
-- file //write file
+- console // write console
+- file // write file
 - api // http request url
 - ...
 
 
-# Use
+# Quick Used
 
-- ### example
+- sync
+
+```
+import (
+ "github.com/phachon/go-logger"
+)
+func main() {
+ logger := go_logger.NewLogger()
+
+ logger.Info("this is a info log!")
+ logger.Errorf("this is a error %s log!", "format")
+}
+```
+
+- async
+
+```
+import (
+ "github.com/phachon/go-logger"
+)
+func main() {
+ logger := go_logger.NewLogger()
+ logger.SetAsync()
+
+ logger.Info("this is a info log!")
+ logger.Errorf("this is a error %s log!", "format")
+
+ logger.Flush()
+}
+```
+
+- Multiple output
 
 ```
 import (
@@ -39,106 +71,86 @@ import (
 func main() {
  logger := go_logger.NewLogger()
 
- // The default has been added to the output of console, and the default does not display the color. If you need to modify it, delete the console first
  logger.Detach("console")
 
- // config console
+ // console adapter config
  consoleConfig := &go_logger.ConsoleConfig{
- Color: true, // text show color
- JsonFormat: true, // json format
- ShowFileLine: true, // when JsonFormat is false, console show file line, default false 
+ Color: true, // Does the text display the color
+ JsonFormat: true, // Whether or not formatted into a JSON string
+ Format: "" // JsonFormat is false, logger message output to console format string
  }
- // attach console to outputs
+ // add output to the console
  logger.Attach("console", go_logger.LOGGER_LEVEL_DEBUG, consoleConfig)
 
- // config file
- fileConfig := &go_logger.FileConfig{
- Filename : "./test.log", // The file name of the log output does not exist automatically.
- // If you want to output different levels of logs to a file individually, configure the LevelFileName parameter.
+ // file adapter config
+ fileConfig := &go_logger.FileConfig {
+ Filename : "./test.log", // The file name of the logger output, does not exist automatically
+ // If you want to separate separate logs into files, configure LevelFileName parameters.
  LevelFileName : map[int]string {
  logger.LoggerLevel("error"): "./error.log", // The error level log is written to the error.log file.
- logger.LoggerLevel("info"): "./info.log", // The info  level log is written to the info.log  file.
+ logger.LoggerLevel("info"): "./info.log", // The info level log is written to the info.log file.
  logger.LoggerLevel("debug"): "./debug.log", // The debug level log is written to the debug.log file.
  },
- MaxSize : 1024 * 1024, // max file size(kb)
- MaxLine : 100000, // max file line
- DateSlice : "d", // slice file by date, support "y", "m", "d", "h", default "" not slice
- JsonFormat: true, // json format
+ MaxSize : 1024 * 1024, // File maximum (KB), default 0 is not limited
+ MaxLine : 100000, // The maximum number of lines in the file, the default 0 is not limited
+ DateSlice : "d", // Cut the document by date, support "Y" (year), "m" (month), "d" (day), "H" (hour), default "no".
+ JsonFormat: true, // Whether the file data is written to JSON formatting
+ Format: "" // JsonFormat is false, logger message written to file format string
  }
+ // add output to the file
  logger.Attach("file", go_logger.LOGGER_LEVEL_DEBUG, fileConfig)
 
- // Set to asynchronous, default is synchronous output
- logger.SetAsync()
 
- logger.Emergency("this is a emergency log!")
- logger.Alert("this is a alert log!")
- logger.Critical("this is a critical log!")
- logger.Error("this is a error log!")
- logger.Warning("this is a warning log!")
- logger.Notice("this is a notice log!")
  logger.Info("this is a info log!")
- logger.Debug("this is a debug log!")
- 
- logger.Emergencyf("this is a emergency %d log!", 10)
- logger.Alertf("this is a alert %s log!", "format")
- logger.Criticalf("this is a critical %s log!", "format")
  logger.Errorf("this is a error %s log!", "format")
- logger.Warningf("this is a warning %s log!", "format")
- logger.Noticef("this is a notice %s log!", "format")
- logger.Infof("this is a info %s log!", "format")
- logger.Debugf("this is a debug %s log!", "format")
- 
- // If set to asynchronous, the flush method must finally be invoked to ensure that all the logs are out
- logger.Flush()
-}
-```
-- ### console adapter
-```
-// config console
-consoleConfig := &go_logger.ConsoleConfig{
- Color: true, // text show color
- JsonFormat: true, // json format
- ShowFileLine: true, // when JsonFormat is false, console show file line, default false 
 }
-// attach
-logger.Attach("console", go_logger.LOGGER_LEVEL_DEBUG, consoleConfig)
 ```
-#### console color preview
+
+## Console text with color effect
 ![image](https://github.com/phachon/go-logger/blob/master/_example/images/console.png)
 
-- ### file adapter
+## Customize Format output
 
+Logger Message
+
+| Field | Alias |Type | Comment | Example |
+| Timestamp | timestamp | int64 | unix timestamp| 1521791201 |
+| TimestampFormat | timestamp_format| string | timestamp format | 2018-3-23 15:46:41|
+| Millisecond | millisecond | int64 | millisecond | |
+| MillisecondFormat | millisecond_format| string | millisecond_format | 2018-3-23 15:46:41.970 |
+| Level | level| int | logger level | 1 |
+| LevelString | level_string | string | logger level string | Error |
+| Body | body | string | logger message body | this is a info log |
+| File | file | string | Call the file of the logger | main.go |
+| Line | line | int | The number of specific lines to call logger |64|
+| Function | function| string | The function name to call logger | main() |
+
+If you want to customize the format of the log output ?
+
+config format:
 ```
-// config file
+consoleConfig := &go_logger.ConsoleConfig{
+ Format: "%millisecond_format% [%level_string%] %body%"
+}
 fileConfig := &go_logger.FileConfig{
- Filename : "./test.log", // The file name of the log output does not exist automatically.
- // If you want to output different levels of logs to a file individually, configure the LevelFileName parameter.
- LevelFileName : map[int]string {
- go_logger.LOGGER_LEVEL_ERROR: "./error.log", // The error level log is written to the error.log file.
- go_logger.LOGGER_LEVEL_INFO: "./info.log", // The info level log is written to the info.log file.
- go_logger.LOGGER_LEVEL_DEBUG: "./debug.log", // The debug level log is written to the debug.log file.
- },
- MaxSize : 1024 * 1024, // max file size(kb)
- MaxLine : 100000, // max file line
- DateSlice : "d", // slice file by date, support "y", "m", "d", "h", default "" not slice
- JsonFormat: true, // json format
+ Format: "%millisecond_format% [%level_string%] %body%"
 }
-logger.Attach("file", go_logger.LOGGER_LEVEL_DEBUG, fileConfig)
 ```
-
-- ### api adapter
-
+output:
 ```
-apiConfig := &go_logger.ApiConfig{
- Url: "http://127.0.0.1:8081/index.php", //request url address, not empty
- Method: "GET", //request method GET or POST
- Headers: map[string]string{}, //request headers, default empty
- IsVerify: false, //response is verify code, default false
- VerifyCode: 0, //verify code value, if isVerify is true, verifyCode is not be 0
-}
-logger.Attach("api", go_logger.LOGGER_LEVEL_DEBUG, apiConfig)
+2018-03-23 14:55:07.003 [Critical] this is a critical log!
 ```
 
+You can customize the format, Only needs to be satisfied Format: "%Logger Message Alias%"
+
+## More adapter examples
+- [console](./_example/console.go)
+- [file](./_example/file.go)
+- [api](./_example/api.go)
+
+
+## Benchmark
+
 ## Reference
 beego/logs : github.com/astaxie/beego/logs
 

_example/console.go

@@ -12,8 +12,8 @@ func main() {
 
 consoleConfig := &go_logger.ConsoleConfig{
 Color: true,
-//JsonFormat: true,
-//ShowFileLine: true,
+JsonFormat: false,
+Format: "%millisecond_format% [%level_string%] [%file%:%line%] %body%",
 }
 
 logger.Attach("console", go_logger.LOGGER_LEVEL_DEBUG, consoleConfig)

_example/file.go

@@ -18,7 +18,8 @@ func main() {
 MaxSize : 1024 * 1024,
 MaxLine : 10000,
 DateSlice : "d",
-JsonFormat: true,
+JsonFormat: false,
+Format: "%millisecond_format% [%level_string%] [%file%:%line%] %body%",
 }
 logger.Attach("file", go_logger.LOGGER_LEVEL_DEBUG, fileConfig)
 logger.SetAsync()

console.go

@@ -3,7 +3,6 @@ package go_logger
 import (
 "sync"
 "io"
-"strconv"
 "github.com/fatih/color"
 "os"
 "encoding/json"
@@ -44,8 +43,22 @@ type ConsoleConfig struct {
 // is json format
 JsonFormat bool
 
-// is show file
-ShowFileLine bool
+// jsonFormat is false, please input format string
+// if format is empty, default format "%millisecond_format% [%level_string%] %body%"
+//
+// Timestamp "%timestamp%"
+//	TimestampFormat "%timestamp_format%"
+//	Millisecond "%millisecond%"
+//	MillisecondFormat "%millisecond_format%"
+//	Level int "%level%"
+//	LevelString "%level_string%"
+//	Body string "%body%"
+//	File string "%file%"
+//	Line int "%line%"
+//	Function "%function%"
+//
+// example: format = "%millisecond_format% [%level_string%] %body%"
+Format string
 }
 
 func (cc *ConsoleConfig) Name() string {
@@ -71,30 +84,22 @@ func (adapterConsole *AdapterConsole) Init(consoleConfig Config) error {
 vc := reflect.ValueOf(consoleConfig)
 cc := vc.Interface().(*ConsoleConfig)
 adapterConsole.config = cc
+
+if cc.JsonFormat == false && cc.Format == "" {
+cc.Format = defaultLoggerMessageFormat
+}
+
 return nil
 }
 
 func (adapterConsole *AdapterConsole) Write(loggerMsg *loggerMessage) error {
 
-//timestamp := loggerMsg.Timestamp
-//timestampFormat := loggerMsg.TimestampFormat
-//millisecond := loggerMsg.Millisecond
-millisecondFormat := loggerMsg.MillisecondFormat
-body := loggerMsg.Body
-file := loggerMsg.File
-line := loggerMsg.Line
-levelString := loggerMsg.LevelString
-
 msg := ""
 if adapterConsole.config.JsonFormat == true {
 jsonByte, _ := json.Marshal(loggerMsg)
 msg = string(jsonByte)
 }else {
-msg = millisecondFormat +" ["+ levelString + "] "
-if adapterConsole.config.ShowFileLine {
-msg += "[" + file + ":" + strconv.Itoa(line) + "] "
-}
-msg += body
+msg = loggerMessageFormat(adapterConsole.config.Format, loggerMsg)
 }
 
 if adapterConsole.config.Color {

file.go

@@ -3,7 +3,6 @@ package go_logger
 import (
 "sync"
 "os"
-"strconv"
 "path"
 "strings"
 "time"
@@ -72,6 +71,23 @@ type FileConfig struct {
 
 // is json format
 JsonFormat bool
+
+// jsonFormat is false, please input format string
+// if format is empty, default format "%millisecond_format% [%level_string%] %body%"
+//
+// Timestamp "%timestamp%"
+//	TimestampFormat "%timestamp_format%"
+//	Millisecond "%millisecond%"
+//	MillisecondFormat "%millisecond_format%"
+//	Level int "%level%"
+//	LevelString "%level_string%"
+//	Body string "%body%"
+//	File string "%file%"
+//	Line int "%line%"
+//	Function "%function%"
+//
+// example: format = "%millisecond_format% [%level_string%] %body%"
+Format string
 }
 
 func (fc *FileConfig) Name() string {
@@ -102,6 +118,10 @@ func (adapterFile *AdapterFile) Init(fileConfig Config) error {
 fc := vc.Interface().(*FileConfig)
 adapterFile.config = fc
 
+if fc.JsonFormat == false && fc.Format == "" {
+fc.Format = defaultLoggerMessageFormat
+}
+
 if len(adapterFile.config.LevelFileName) == 0 {
 if adapterFile.config.Filename == "" {
 return errors.New("config Filename can't be empty!")
@@ -231,16 +251,6 @@ func (fw *FileWriter) initFile() error {
 // write by config
 func (fw *FileWriter) writeByConfig(config *FileConfig, loggerMsg *loggerMessage) error {
 
-//timestamp := loggerMsg.Timestamp
-//timestampFormat := loggerMsg.TimestampFormat
-//millisecond := loggerMsg.Millisecond
-millisecondFormat := loggerMsg.MillisecondFormat
-body := loggerMsg.Body
-file := loggerMsg.File
-line := loggerMsg.Line
-levelString := loggerMsg.LevelString
-
-//fileWrite := adapterFile.write
 fw.lock.Lock()
 defer fw.lock.Unlock()
 
@@ -269,9 +279,9 @@ func (fw *FileWriter) writeByConfig(config *FileConfig, loggerMsg *loggerMessage
 msg := ""
 if config.JsonFormat == true {
 jsonByte, _ := json.Marshal(loggerMsg)
-msg = string(jsonByte) + "\n"
+msg = string(jsonByte) + "\r\n"
 }else {
-msg = millisecondFormat +" ["+ levelString + "] [" + file + ":" + strconv.Itoa(line) + "] " + body + "\n"
+msg = loggerMessageFormat(config.Format, loggerMsg) + "\r\n"
 }
 
 fw.writer.Write([]byte(msg))
@@ -395,7 +405,7 @@ func (fw *FileWriter) getFileObject(filename string) (file *os.File, err error)
 //return : fileSize(byte int64), error
 func (fw *FileWriter) getFileSize(filename string) (fileSize int64, err error) {
 fileInfo, err := os.Stat(filename)
-if(err != nil) {
+if err != nil {
 return fileSize, err
 }