-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
8 changed files
with
245 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -40,4 +40,5 @@ issues: | |
| - linters: | ||
| - gomnd | ||
| - goconst | ||
| - noctx | ||
| path: "_test.go" | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| package ctxz_test | ||
|
|
||
| import ( | ||
| "context" | ||
| "net/http" | ||
| "os" | ||
| "time" | ||
|
|
||
| "github.com/bool64/ctxd" | ||
| "github.com/bool64/logz" | ||
| "github.com/bool64/logz/ctxz" | ||
| "github.com/bool64/logz/logzpage" | ||
| ) | ||
|
|
||
| func ExampleNewObserver() { | ||
| var logger ctxd.Logger | ||
|
|
||
| lz := ctxz.NewObserver(logger, logz.Config{ | ||
| MaxCardinality: 100, | ||
| MaxSamples: 50, | ||
| DistRetentionPeriod: 72 * time.Hour, | ||
| }) | ||
| logger = lz | ||
|
|
||
| ctx := context.TODO() | ||
|
|
||
| logger.Debug(ctx, "starting example") | ||
| logger.Info(ctx, "sample info", "one", 1, "two", 2) | ||
| logger.Error(ctx, "unexpected end of the world") | ||
|
|
||
| logger.Important(ctx, "starting server at http://localhost:6060/") | ||
|
|
||
| err := http.ListenAndServe("0.0.0.0:6060", logzpage.Handler(lz.LevelObservers()...)) | ||
| if err != nil { | ||
| logger.Error(ctx, err.Error()) | ||
| os.Exit(1) | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,123 @@ | ||
| // Package ctxz implements wrapper to report aggregated messages for github.com/bool64/ctxd.Logger. | ||
| package ctxz | ||
|
|
||
| import ( | ||
| "context" | ||
| "encoding/json" | ||
|
|
||
| "github.com/bool64/ctxd" | ||
| "github.com/bool64/logz" | ||
| ) | ||
|
|
||
| // Observer keeps track of logged messages. | ||
| type Observer struct { | ||
| debug *logz.Observer | ||
| info *logz.Observer | ||
| important *logz.Observer | ||
| warn *logz.Observer | ||
| error *logz.Observer | ||
| logger ctxd.Logger | ||
| } | ||
|
|
||
| type tuples struct { | ||
| ctx context.Context | ||
| kv []interface{} | ||
| } | ||
|
|
||
| func (t tuples) MarshalJSON() ([]byte, error) { | ||
| kv := t.kv[0:len(t.kv):len(t.kv)] | ||
|
|
||
| ctxFields := ctxd.Fields(t.ctx) | ||
| if len(ctxFields) > 0 { | ||
| kv = append(kv, ctxFields...) | ||
| } | ||
|
|
||
| m := make(map[string]interface{}, len(kv)) | ||
|
|
||
| var ( | ||
| label string | ||
| ok bool | ||
| ) | ||
|
|
||
| for i, l := range kv { | ||
| if label == "" { | ||
| label, ok = l.(string) | ||
| if !ok { | ||
| m["malformedFields"] = kv[i:] | ||
|
|
||
| break | ||
| } | ||
| } else { | ||
| m[label] = l | ||
| label = "" | ||
| } | ||
| } | ||
|
|
||
| return json.Marshal(m) | ||
| } | ||
|
|
||
| // Debug logs debug message. | ||
| func (o Observer) Debug(ctx context.Context, msg string, keysAndValues ...interface{}) { | ||
| o.debug.ObserveMessage(msg, tuples{ctx: ctx, kv: keysAndValues}) | ||
| o.logger.Debug(ctx, msg, keysAndValues...) | ||
| } | ||
|
|
||
| // Info logs informational message. | ||
| func (o Observer) Info(ctx context.Context, msg string, keysAndValues ...interface{}) { | ||
| o.info.ObserveMessage(msg, tuples{ctx: ctx, kv: keysAndValues}) | ||
| o.logger.Info(ctx, msg, keysAndValues...) | ||
| } | ||
|
|
||
| // Important logs important information. | ||
| func (o Observer) Important(ctx context.Context, msg string, keysAndValues ...interface{}) { | ||
| o.important.ObserveMessage(msg, tuples{ctx: ctx, kv: keysAndValues}) | ||
| o.logger.Important(ctx, msg, keysAndValues...) | ||
| } | ||
|
|
||
| // Warn logs a warning. | ||
| func (o Observer) Warn(ctx context.Context, msg string, keysAndValues ...interface{}) { | ||
| o.warn.ObserveMessage(msg, tuples{ctx: ctx, kv: keysAndValues}) | ||
| o.logger.Warn(ctx, msg, keysAndValues...) | ||
| } | ||
|
|
||
| // Error logs an error. | ||
| func (o Observer) Error(ctx context.Context, msg string, keysAndValues ...interface{}) { | ||
| o.error.ObserveMessage(msg, tuples{ctx: ctx, kv: keysAndValues}) | ||
| o.logger.Error(ctx, msg, keysAndValues...) | ||
| } | ||
|
|
||
| // LevelObservers returns . | ||
| func (o Observer) LevelObservers() []*logz.Observer { | ||
| return []*logz.Observer{o.debug, o.info, o.important, o.warn, o.error} | ||
| } | ||
|
|
||
| // CtxdLogger is a service provider. | ||
| func (o Observer) CtxdLogger() ctxd.Logger { | ||
| return o | ||
| } | ||
|
|
||
| // NewObserver initializes Observer instance. | ||
| func NewObserver(logger ctxd.Logger, conf ...logz.Config) Observer { | ||
| o := Observer{ | ||
| logger: logger, | ||
| } | ||
|
|
||
| cfg := logz.Config{} | ||
|
|
||
| if len(conf) == 1 { | ||
| cfg = conf[0] | ||
| } | ||
|
|
||
| cfg.Name = "Debug" | ||
| o.debug = &logz.Observer{Config: cfg} | ||
| cfg.Name = "Info" | ||
| o.info = &logz.Observer{Config: cfg} | ||
| cfg.Name = "Important" | ||
| o.important = &logz.Observer{Config: cfg} | ||
| cfg.Name = "Warning" | ||
| o.warn = &logz.Observer{Config: cfg} | ||
| cfg.Name = "Error" | ||
| o.error = &logz.Observer{Config: cfg} | ||
|
|
||
| return o | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| package ctxz_test | ||
|
|
||
| import ( | ||
| "context" | ||
| "net/http" | ||
| "net/http/httptest" | ||
| "testing" | ||
|
|
||
| "github.com/bool64/ctxd" | ||
| "github.com/bool64/logz/ctxz" | ||
| "github.com/bool64/logz/logzpage" | ||
| "github.com/stretchr/testify/assert" | ||
| "github.com/stretchr/testify/require" | ||
| ) | ||
|
|
||
| func TestNewObserver(t *testing.T) { | ||
| logger := ctxd.NoOpLogger{} | ||
| o := ctxz.NewObserver(logger) | ||
|
|
||
| assert.Equal(t, o, o.CtxdLogger()) | ||
|
|
||
| ctx := ctxd.AddFields(context.Background(), "shared", 123) | ||
|
|
||
| o.Debug(ctx, "debug", "foo", "bar") | ||
| o.Info(ctx, "info", "foo", "bar") | ||
| o.Important(ctx, "important", "foo", "bar") | ||
| o.Warn(ctx, "warn", "foo", "bar") | ||
| o.Error(ctx, "error", "foo", "bar") | ||
|
|
||
| req, err := http.NewRequest(http.MethodGet, "/debug/logz?level=Info&msg=info", nil) | ||
| require.NoError(t, err) | ||
|
|
||
| rw := httptest.NewRecorder() | ||
|
|
||
| logzpage.Handler(o.LevelObservers()...).ServeHTTP(rw, req) | ||
|
|
||
| assert.Contains(t, rw.Body.String(), `{ | ||
| "foo": "bar", | ||
| "shared": 123 | ||
| }`) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters