From 496049ef1bc354b33845532de49bea572a2af244 Mon Sep 17 00:00:00 2001 From: Felix Hanley Date: Wed, 18 Sep 2019 14:31:21 +1000 Subject: Add example --- example_test.go | 53 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 53 insertions(+) create mode 100644 example_test.go (limited to 'example_test.go') diff --git a/example_test.go b/example_test.go new file mode 100644 index 0000000..b1b2189 --- /dev/null +++ b/example_test.go @@ -0,0 +1,53 @@ +package logger + +import ( + "src.userspace.com.au/felix/logger/message" + "src.userspace.com.au/felix/logger/writers/json" + "src.userspace.com.au/felix/logger/writers/kv" +) + +func ExampleLevel() { + keyValue, _ := kv.New(kv.SetTimeFormat("")) + log, _ := New( + Name("app"), + Level(message.DEBUG), + Writer(keyValue), + ) + log.Error("unable to do anything") + // Output: [error] app: unable to do anything +} + +func Example_structure() { + keyValue, _ := kv.New(kv.SetTimeFormat("")) + log, _ := New(Writer(keyValue)) + log.Warn("invalid something", "id", 344, "error", "generally broken") + // Output: [warn] invalid something id=344 error="generally broken" +} + +func ExampleNamed() { + keyValue, _ := kv.New(kv.SetTimeFormat("")) + log, _ := New( + Name("database"), + Writer(keyValue), + ) + log.Error("connection initialised") + // Output: [error] database: connection initialised +} + +func ExampleField() { + jsonWriter, _ := json.New(json.SetTimeFormat("")) + log, _ := New(Name("app.database"), Writer(jsonWriter)) + // Create a new Logger with pre-defined values + reqID := "555" + msgLog := log.Field("request", reqID) + msgLog.Error("failed to process message") + // Output: {"_level":"error","_message":"failed to process message","_name":"app.database","_time":"","request":"555"} +} + +func Example_nolevel() { + keyValue, _ := kv.New(kv.SetTimeFormat("")) + log, _ := New(Writer(keyValue)) + large := 12345678 + log.Log("metrics or whatnot", "something", large) + // Output: metrics or whatnot something=12345678 +} -- cgit v1.2.3