diff --git a/log/README.md b/log/README.md
index 0951b21cb53fa182627b47bb0a4b7457f2f76f84..b4476577b63b8db25c7d6212e9a7eeaf282260c3 100644
--- a/log/README.md
+++ b/log/README.md
@@ -45,7 +45,7 @@ srvlog.SetHandler(log.MultiHandler(
log.StreamHandler(os.Stderr, log.LogfmtFormat()),
log.LvlFilterHandler(
log.LvlError,
- log.Must.FileHandler("errors.json", log.JsonFormat()))))
+ log.Must.FileHandler("errors.json", log.JSONFormat()))))
```
Will result in output that looks like this:
diff --git a/log/doc.go b/log/doc.go
index 83ad8c54f64c0a73e7bf1667fbc7b1f793a861dc..bff2f4966a4bfc9bdbc1bfb95d8e9730b4140e43 100644
--- a/log/doc.go
+++ b/log/doc.go
@@ -86,7 +86,7 @@ from the rpc package in logfmt to standard out. The other prints records at Erro
or above in JSON formatted output to the file /var/log/service.json
handler := log.MultiHandler(
- log.LvlFilterHandler(log.LvlError, log.Must.FileHandler("/var/log/service.json", log.JsonFormat())),
+ log.LvlFilterHandler(log.LvlError, log.Must.FileHandler("/var/log/service.json", log.JSONFormat())),
log.MatchFilterHandler("pkg", "app/rpc" log.StdoutHandler())
)
@@ -304,8 +304,8 @@ For all Handler functions which can return an error, there is a version of that
function which will return no error but panics on failure. They are all available
on the Must object. For example:
- log.Must.FileHandler("/path", log.JsonFormat)
- log.Must.NetHandler("tcp", ":1234", log.JsonFormat)
+ log.Must.FileHandler("/path", log.JSONFormat)
+ log.Must.NetHandler("tcp", ":1234", log.JSONFormat)
Inspiration and Credit
diff --git a/log/format.go b/log/format.go
index 0b07abb2acbc5cdf7d393e8eade9191e1706f321..fb1ea1a7b48305918311c3029e129da5339abb82 100644
--- a/log/format.go
+++ b/log/format.go
@@ -196,16 +196,16 @@ func logfmt(buf *bytes.Buffer, ctx []interface{}, color int, term bool) {
buf.WriteByte('\n')
}
-// JsonFormat formats log records as JSON objects separated by newlines.
-// It is the equivalent of JsonFormatEx(false, true).
-func JsonFormat() Format {
- return JsonFormatEx(false, true)
+// JSONFormat formats log records as JSON objects separated by newlines.
+// It is the equivalent of JSONFormatEx(false, true).
+func JSONFormat() Format {
+ return JSONFormatEx(false, true)
}
-// JsonFormatEx formats log records as JSON objects. If pretty is true,
+// JSONFormatEx formats log records as JSON objects. If pretty is true,
// records will be pretty-printed. If lineSeparated is true, records
// will be logged with a new line between each record.
-func JsonFormatEx(pretty, lineSeparated bool) Format {
+func JSONFormatEx(pretty, lineSeparated bool) Format {
jsonMarshal := json.Marshal
if pretty {
jsonMarshal = func(v interface{}) ([]byte, error) {
@@ -225,7 +225,7 @@ func JsonFormatEx(pretty, lineSeparated bool) Format {
if !ok {
props[errorKey] = fmt.Sprintf("%+v is not a string key", r.Ctx[i])
}
- props[k] = formatJsonValue(r.Ctx[i+1])
+ props[k] = formatJSONValue(r.Ctx[i+1])
}
b, err := jsonMarshal(props)
@@ -270,7 +270,7 @@ func formatShared(value interface{}) (result interface{}) {
}
}
-func formatJsonValue(value interface{}) interface{} {
+func formatJSONValue(value interface{}) interface{} {
value = formatShared(value)
switch value.(type) {
case int, int8, int16, int32, int64, float32, float64, uint, uint8, uint16, uint32, uint64, string:
diff --git a/log/handler.go b/log/handler.go
index 41d5718ddb24061980f9fe750e68bba66293810f..3c99114dcb2f4f76f05cfee1dfec9043a78f1d6b 100644
--- a/log/handler.go
+++ b/log/handler.go
@@ -11,8 +11,8 @@ import (
"github.com/go-stack/stack"
)
+// Handler defines where and how log records are written.
// A Logger prints its log records by writing to a Handler.
-// The Handler interface defines where and how log records are written.
// Handlers are composable, providing you great flexibility in combining
// them to achieve the logging structure that suits your applications.
type Handler interface {
@@ -193,7 +193,7 @@ func LvlFilterHandler(maxLvl Lvl, h Handler) Handler {
}, h)
}
-// A MultiHandler dispatches any write to each of its handlers.
+// MultiHandler dispatches any write to each of its handlers.
// This is useful for writing different types of log information
// to different locations. For example, to log to a file and
// standard error:
@@ -212,7 +212,7 @@ func MultiHandler(hs ...Handler) Handler {
})
}
-// A FailoverHandler writes all log records to the first handler
+// FailoverHandler writes all log records to the first handler
// specified, but will failover and write to the second handler if
// the first handler has failed, and so on for all handlers specified.
// For example you might want to log to a network socket, but failover
@@ -220,7 +220,7 @@ func MultiHandler(hs ...Handler) Handler {
// standard out if the file write fails:
//
// log.FailoverHandler(
-// log.Must.NetHandler("tcp", ":9090", log.JsonFormat()),
+// log.Must.NetHandler("tcp", ":9090", log.JSONFormat()),
// log.Must.FileHandler("/var/log/app.log", log.LogfmtFormat()),
// log.StdoutHandler)
//
@@ -336,7 +336,7 @@ func DiscardHandler() Handler {
})
}
-// The Must object provides the following Handler creation functions
+// Must provides the following Handler creation functions
// which instead of returning an error parameter only return a Handler
// and panic on failure: FileHandler, NetHandler, SyslogHandler, SyslogNetHandler
var Must muster
diff --git a/log/logger.go b/log/logger.go
index 15c83a9b25d1f3b76bbce20922f875f2c6d417f6..a2fe6dc5808dd8e11092bf0f70f8753966e34a0d 100644
--- a/log/logger.go
+++ b/log/logger.go
@@ -24,7 +24,7 @@ const (
LvlTrace
)
-// Aligned returns a 5-character string containing the name of a Lvl.
+// AlignedString returns a 5-character string containing the name of a Lvl.
func (l Lvl) AlignedString() string {
switch l {
case LvlTrace:
@@ -64,7 +64,7 @@ func (l Lvl) String() string {
}
}
-// Returns the appropriate Lvl from a string name.
+// LvlFromString returns the appropriate Lvl from a string name.
// Useful for parsing command line args and configuration files.
func LvlFromString(lvlString string) (Lvl, error) {
switch lvlString {
@@ -95,6 +95,7 @@ type Record struct {
KeyNames RecordKeyNames
}
+// RecordKeyNames gets stored in a Record when the write function is executed.
type RecordKeyNames struct {
Time string
Msg string