Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/chanxuehong/log
a simple, flexible, leveled logging package for Go/golang.
https://github.com/chanxuehong/log
go golang log logger logging
Last synced: 4 months ago
JSON representation
a simple, flexible, leveled logging package for Go/golang.
- Host: GitHub
- URL: https://github.com/chanxuehong/log
- Owner: chanxuehong
- Created: 2018-04-17T10:01:14.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2021-10-09T06:29:40.000Z (over 3 years ago)
- Last Synced: 2024-06-19T18:10:26.970Z (8 months ago)
- Topics: go, golang, log, logger, logging
- Language: Go
- Homepage:
- Size: 99.6 KB
- Stars: 10
- Watchers: 1
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## log
```golang
package main
import (
"context"
"net/http"
"github.com/chanxuehong/log"
"github.com/chanxuehong/log/trace"
)
// set defaults if necessary.
// normally sets when the program starts.
func init() {
log.SetFormatter(log.TextFormatter)
log.SetLevelString(log.DebugLevelString)
log.SetDefaultOptions([]log.Option{
log.WithFormatter(log.TextFormatter),
log.WithLevelString(log.DebugLevelString),
})
}
type mockResponseWriter struct {
http.ResponseWriter
header http.Header
}
func (w *mockResponseWriter) Header() http.Header {
return w.header
}
func main() {
// mock http.ResponseWriter and *http.Request
w := &mockResponseWriter{
header: make(http.Header),
}
r, _ := http.NewRequest(http.MethodGet, "http://www.example.com", nil)
// handle http request
middleware(handler)(w, r)
}
func middleware(next http.HandlerFunc) http.HandlerFunc {
return func(w http.ResponseWriter, r *http.Request) {
// gets traceId from request header, if not exists, generates it.
traceId, ok := trace.FromRequest(r)
if !ok {
traceId = trace.NewTraceId()
r.Header.Set(trace.TraceIdHeaderKey, traceId)
}
// sets traceId to response header
w.Header().Set(trace.TraceIdHeaderKey, traceId)
// adds traceId to request.Context
r = r.WithContext(trace.NewContext(r.Context(), traceId))
// adds log.Logger to request.Context
l := log.New(log.WithTraceId(traceId))
r = log.NewRequest(r, l)
// call http handler
next(w, r)
}
}
func handler(w http.ResponseWriter, r *http.Request) {
l := log.MustFromRequest(r)
l.Info("1.info message")
l.Info("2.info message", "key1", 1, "key2", 2)
l = l.WithField("key3", 3)
l = l.WithFields("key4", 4, "key5", 5)
l.Info("3.info message")
ctx := log.NewContext(r.Context(), l)
fn1(ctx)
}
func fn1(ctx context.Context) {
l := log.MustFromContext(ctx)
l.Info("4.info message")
l.Info("5.info message", "key6", 6)
l = l.WithField("key7", 7)
ctx = log.NewContext(ctx, l)
fn2(ctx)
}
func fn2(ctx context.Context) {
log.InfoContext(ctx, "6.info message", "key8", 8) // shortcut
fn3(ctx)
}
func fn3(ctx context.Context) {
log.InfoContext(ctx, "7.info message", "key9", 9) // shortcut
}
```
```Text
time=2018-07-01 15:49:04.520, level=info, request_id=39eff2b97d0311e89fcd000c294d93c4, location=main.handler(test1/main.go:67), msg=1.info message
time=2018-07-01 15:49:04.520, level=info, request_id=39eff2b97d0311e89fcd000c294d93c4, location=main.handler(test1/main.go:68), msg=2.info message, key1=1, key2=2
time=2018-07-01 15:49:04.520, level=info, request_id=39eff2b97d0311e89fcd000c294d93c4, location=main.handler(test1/main.go:72), msg=3.info message, key3=3, key4=4, key5=5
time=2018-07-01 15:49:04.520, level=info, request_id=39eff2b97d0311e89fcd000c294d93c4, location=main.fn1(test1/main.go:80), msg=4.info message, key3=3, key4=4, key5=5
time=2018-07-01 15:49:04.520, level=info, request_id=39eff2b97d0311e89fcd000c294d93c4, location=main.fn1(test1/main.go:81), msg=5.info message, key3=3, key4=4, key5=5, key6=6
time=2018-07-01 15:49:04.520, level=info, request_id=39eff2b97d0311e89fcd000c294d93c4, location=main.fn2(test1/main.go:89), msg=6.info message, key3=3, key4=4, key5=5, key7=7, key8=8
time=2018-07-01 15:49:04.520, level=info, request_id=39eff2b97d0311e89fcd000c294d93c4, location=main.fn3(test1/main.go:94), msg=7.info message, key3=3, key4=4, key5=5, key7=7, key9=9
```