Compare commits

..

No commits in common. "main" and "v0.1.4" have entirely different histories.
main ... v0.1.4

17 changed files with 93 additions and 203 deletions

View File

@ -1,7 +0,0 @@
Copyright 2021 Basit Ali
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

View File

@ -1,7 +0,0 @@
# go-log
A Go logging library that provides simple leveled logging.
## Documentation
Documentation for the following library can be found at https://pkg.go.dev/github.com/rjbasitali/go-log
[![GoDoc](https://godoc.org/github.com/rjbasitali/go-log?status.svg)](https://pkg.go.dev/github.com/rjbasitali/go-log)

38
doc.go
View File

@ -1,38 +0,0 @@
/*
Package log provides simple leveled logging.
Usage
To use this package get the logger using:
logger = log.NewLogger(os.Stdout)
You can also get a leveled logger using:
Logger = log.NewLogger(os.Stdout).Level(6)
(Note that we are passing Level as 6, which will log everything)
Once you have the logger you can use it to log stuff like:
logger.Log("Hello world!")
logger.Inform("Someone knocked!")
logger.Alert("Intruder!")
logger.Warn("Threat found.")
Or for formatted logging:
logger.Logf("Hello %s!", "John")
logger.Informf("%s knocked!", "John")
logger.Alertf("Intruder of level %d", 9)
logger.Warnf("Found %q threat!", "Impersonator")
*/
package log

View File

@ -1,12 +0,0 @@
package log
func (l myLogger) WithFields(fields Fields) Logger {
if l.data != nil && len(l.data) > 0 {
for k, v := range fields {
l.data[k] = v
}
} else {
l.data = fields
}
return l
}

View File

@ -29,6 +29,4 @@ type Logger interface {
End(a ...interface{}) End(a ...interface{})
Level(uint8) Logger Level(uint8) Logger
WithFields(fields Fields) Logger
} }

View File

@ -1,15 +1,21 @@
package log package log
func (l myLogger) Alert(a ...interface{}) { func (l myLogger) Alert(a ...interface{}) {
if l.Writer == nil {
return
}
if !hasLevel(l.level, alertFlag) { if !hasLevel(l.level, alertFlag) {
return return
} }
l.log(alertFlag, a...) l.log(a...)
} }
func (l myLogger) Alertf(format string, a ...interface{}) { func (l myLogger) Alertf(format string, a ...interface{}) {
if l.Writer == nil {
return
}
if !hasLevel(l.level, alertFlag) { if !hasLevel(l.level, alertFlag) {
return return
} }
l.logf(alertFlag, format, a...) l.logf(format, a...)
} }

View File

@ -3,9 +3,7 @@ package log
import "time" import "time"
func (l myLogger) Begin(s ...interface{}) Logger { func (l myLogger) Begin(s ...interface{}) Logger {
if hasLevel(l.level, logFlag) { logger := myLogger{Writer: l.Writer, prefix: l.prefix, begin: time.Now(), level: l.level}
l.log(logFlag, append([]interface{}{"BEGIN"}, s...)...) l.log(append([]interface{}{"BEGIN"}, s...)...)
}
logger := myLogger{Writer: l.Writer, ErrWriter: l.ErrWriter, prefix: l.prefix, begin: time.Now(), level: l.level, data: l.data}
return logger return logger
} }

View File

@ -6,8 +6,6 @@ import (
) )
func (l myLogger) End(s ...interface{}) { func (l myLogger) End(s ...interface{}) {
if hasLevel(l.level, logFlag) { var p []interface{} = append([]interface{}{fmt.Sprintf("END δt=%dµs", time.Now().Sub(l.begin)/1000)}, s...)
var p []interface{} = append([]interface{}{fmt.Sprintf("END δt=%dµs", time.Now().Sub(l.begin)/1000)}, s...) l.log(p...)
l.log(logFlag, p...)
}
} }

View File

@ -1,15 +1,21 @@
package log package log
func (l myLogger) Error(a ...interface{}) { func (l myLogger) Error(a ...interface{}) {
if l.Writer == nil {
return
}
if !hasLevel(l.level, errorFlag) { if !hasLevel(l.level, errorFlag) {
return return
} }
l.log(errorFlag, a...) l.log(a...)
} }
func (l myLogger) Errorf(format string, a ...interface{}) { func (l myLogger) Errorf(format string, a ...interface{}) {
if l.Writer == nil {
return
}
if !hasLevel(l.level, errorFlag) { if !hasLevel(l.level, errorFlag) {
return return
} }
l.logf(errorFlag, format, a...) l.logf(format, a...)
} }

View File

@ -1,15 +1,21 @@
package log package log
func (l myLogger) Highlight(a ...interface{}) { func (l myLogger) Highlight(a ...interface{}) {
if l.Writer == nil {
return
}
if !hasLevel(l.level, highlightFlag) { if !hasLevel(l.level, highlightFlag) {
return return
} }
l.log(highlightFlag, a...) l.log(a...)
} }
func (l myLogger) Highlightf(format string, a ...interface{}) { func (l myLogger) Highlightf(format string, a ...interface{}) {
if l.Writer == nil {
return
}
if !hasLevel(l.level, highlightFlag) { if !hasLevel(l.level, highlightFlag) {
return return
} }
l.logf(highlightFlag, format, a...) l.logf(format, a...)
} }

View File

@ -1,15 +1,21 @@
package log package log
func (l myLogger) Inform(a ...interface{}) { func (l myLogger) Inform(a ...interface{}) {
if l.Writer == nil {
return
}
if !hasLevel(l.level, informFlag) { if !hasLevel(l.level, informFlag) {
return return
} }
l.log(informFlag, a...) l.log(a...)
} }
func (l myLogger) Informf(format string, a ...interface{}) { func (l myLogger) Informf(format string, a ...interface{}) {
if l.Writer == nil {
return
}
if !hasLevel(l.level, informFlag) { if !hasLevel(l.level, informFlag) {
return return
} }
l.logf(informFlag, format, a...) l.logf(format, a...)
} }

View File

@ -2,67 +2,33 @@ package log
const ( const (
alertFlag = 0b00000001 // L1 alertFlag = 0b00000001 // L1
errorFlag = 0b00000010 // L2 errorFlag = 0b00000001 // L1
warnFlag = 0b00000100 // L3 warnFlag = 0b00000010 // L2
highlightFlag = 0b00001000 // L4 highlightFlag = 0b00000100 // L3
informFlag = 0b00010000 // L5 informFlag = 0b00001000 // L4
logFlag = 0b00100000 // L6 logFlag = 0b00010000 // L5
traceFlag = 0b01000000 // L7 traceFlag = 0b00100000 // L6
) )
// Level returns a leveled logger, level can be from 1 to 6.
// Level 1 — Alert or Error
// Level 2 — Warn
// Level 3 — Highlight
// Level 4 — Inform
// Level 5 — Log
// Level 6 — Trace
// Anything above 6 as level will be considered Level 6.
// Pass 0 to output no logs.
func (l myLogger) Level(level uint8) Logger { func (l myLogger) Level(level uint8) Logger {
logger := myLogger{Writer: l.Writer, ErrWriter: l.ErrWriter, prefix: l.prefix, begin: l.begin, data: l.data} logger := myLogger{Writer: l.Writer, prefix: l.prefix, begin: l.begin}
switch level { switch level {
case 1: case 1:
logger.level = alertFlag
case 2:
logger.level = alertFlag | errorFlag logger.level = alertFlag | errorFlag
case 3: case 2:
logger.level = alertFlag | errorFlag | warnFlag logger.level = alertFlag | errorFlag | warnFlag
case 4: case 3:
logger.level = alertFlag | errorFlag | warnFlag | highlightFlag logger.level = alertFlag | errorFlag | warnFlag | highlightFlag
case 5: case 4:
logger.level = alertFlag | errorFlag | warnFlag | highlightFlag | informFlag logger.level = alertFlag | errorFlag | warnFlag | highlightFlag | informFlag
case 6: case 5:
logger.level = alertFlag | errorFlag | warnFlag | highlightFlag | informFlag | logFlag logger.level = alertFlag | errorFlag | warnFlag | highlightFlag | informFlag | logFlag
case 7:
logger.level = alertFlag | errorFlag | warnFlag | highlightFlag | informFlag | logFlag | traceFlag
default: default:
logger.level = 0 logger.level = alertFlag | errorFlag | warnFlag | highlightFlag | informFlag | logFlag | traceFlag
} }
return logger return logger
} }
func unmarshalLevel(level uint8) string {
switch level {
case alertFlag:
return "alert"
case errorFlag:
return "error"
case warnFlag:
return "warn"
case highlightFlag:
return "highlight"
case informFlag:
return "inform"
case logFlag:
return "log"
case traceFlag:
return "trace"
default:
return ""
}
}
func hasLevel(b uint8, flag uint8) bool { func hasLevel(b uint8, flag uint8) bool {
return b&flag != 0 return b&flag != 0
} }

View File

@ -1,15 +1,21 @@
package log package log
func (l myLogger) Log(s ...interface{}) { func (l myLogger) Log(s ...interface{}) {
if l.Writer == nil {
return
}
if !hasLevel(l.level, logFlag) { if !hasLevel(l.level, logFlag) {
return return
} }
l.log(logFlag, s...) l.log(s...)
} }
func (l myLogger) Logf(format string, s ...interface{}) { func (l myLogger) Logf(format string, s ...interface{}) {
if l.Writer == nil {
return
}
if !hasLevel(l.level, logFlag) { if !hasLevel(l.level, logFlag) {
return return
} }
l.logf(logFlag, format, s...) l.logf(format, s...)
} }

View File

@ -11,6 +11,6 @@ func (l myLogger) Prefix(p ...string) Logger {
for _, prefix := range p { for _, prefix := range p {
buffer.WriteString(fmt.Sprintf("%s: ", prefix)) buffer.WriteString(fmt.Sprintf("%s: ", prefix))
} }
logger := myLogger{Writer: l.Writer, ErrWriter: l.ErrWriter, prefix: buffer.String(), data: l.data} logger := myLogger{Writer: l.Writer, prefix: buffer.String()}
return logger return logger
} }

View File

@ -1,15 +1,21 @@
package log package log
func (l myLogger) Trace(a ...interface{}) { func (l myLogger) Trace(a ...interface{}) {
if l.Writer == nil {
return
}
if !hasLevel(l.level, traceFlag) { if !hasLevel(l.level, traceFlag) {
return return
} }
l.log(traceFlag, a...) l.log(a...)
} }
func (l myLogger) Tracef(format string, a ...interface{}) { func (l myLogger) Tracef(format string, a ...interface{}) {
if l.Writer == nil {
return
}
if !hasLevel(l.level, traceFlag) { if !hasLevel(l.level, traceFlag) {
return return
} }
l.logf(traceFlag, format, a...) l.logf(format, a...)
} }

View File

@ -1,15 +1,21 @@
package log package log
func (l myLogger) Warn(a ...interface{}) { func (l myLogger) Warn(a ...interface{}) {
if l.Writer == nil {
return
}
if !hasLevel(l.level, warnFlag) { if !hasLevel(l.level, warnFlag) {
return return
} }
l.log(warnFlag, a...) l.log(a...)
} }
func (l myLogger) Warnf(format string, a ...interface{}) { func (l myLogger) Warnf(format string, a ...interface{}) {
if l.Writer == nil {
return
}
if !hasLevel(l.level, warnFlag) { if !hasLevel(l.level, warnFlag) {
return return
} }
l.logf(warnFlag, format, a...) l.logf(format, a...)
} }

View File

@ -9,66 +9,27 @@ import (
"time" "time"
) )
var (
DefaultTimeFormat = time.RFC3339
)
type Fields map[string]interface{}
type myLogger struct { type myLogger struct {
Writer io.Writer Writer io.Writer
ErrWriter io.Writer prefix string
prefix string begin time.Time
begin time.Time level uint8
level uint8
data Fields
} }
func logPrefix(level uint8) string { func (l myLogger) log(s ...interface{}) {
return fmt.Sprintf("time=%q level=%s function=%s", time.Now().Format(DefaultTimeFormat), unmarshalLevel(level), funcName()) if l.Writer == nil {
return
}
s = append([]interface{}{l.prefix, funcName()}, s...)
fmt.Fprintln(l.Writer, s...)
} }
func (fields Fields) String() string { func (l myLogger) logf(format string, s ...interface{}) {
if len(fields) == 0 { if l.Writer == nil {
return "" return
} }
var buffer strings.Builder format = fmt.Sprintf("%s %s %s\n", l.prefix, funcName(), format)
for k, v := range fields { fmt.Fprintf(l.Writer, format, s...)
switch v := v.(type) {
case string:
buffer.WriteString(fmt.Sprintf(" %s=%q", k, v))
default:
buffer.WriteString(fmt.Sprintf(" %s=%v", k, v))
}
}
return buffer.String()
}
func (l myLogger) log(flag uint8, s ...interface{}) {
var w io.Writer
{
if flag == errorFlag {
w = l.ErrWriter
} else {
w = l.Writer
}
}
f := fmt.Sprintf("%s%s msg=%q%s", logPrefix(flag), l.prefix, fmt.Sprint(s...), l.data)
fmt.Fprintln(w, f)
}
func (l myLogger) logf(flag uint8, format string, s ...interface{}) {
var w io.Writer
{
if flag == errorFlag {
w = l.ErrWriter
} else {
w = l.Writer
}
}
format = fmt.Sprintf("%%s%%s msg=\"%s\"%s\n", format, l.data)
s = append([]interface{}{logPrefix(flag), l.prefix}, s...)
fmt.Fprintf(w, format, s...)
} }
func funcName() string { func funcName() string {
@ -77,28 +38,19 @@ func funcName() string {
for _, p := range pc { for _, p := range pc {
fn := runtime.FuncForPC(p) fn := runtime.FuncForPC(p)
if !strings.HasPrefix(fn.Name(), "github.com/rjbasitali/go-log") { if !strings.HasPrefix(fn.Name(), "github.com/rjbasitali/go-log") {
fname := fn.Name() return fn.Name()
i := strings.LastIndexByte(fname, byte('/'))
if i == -1 {
return fname
}
return fname[i+1:]
} }
} }
return "" return ""
} }
func NewLogger(w, errw io.Writer) Logger { func NewLogger(w io.Writer) Logger {
if w == nil { if w == nil {
w = os.Stdout w = os.Stdout
} }
if errw == nil {
errw = os.Stderr
}
return myLogger{ return myLogger{
Writer: w, Writer: w,
ErrWriter: errw, begin: time.Now(),
begin: time.Now(), level: 63,
level: traceFlag,
} }
} }