example_basic_test.go

package log_test

import (
	"fmt"
	"os"

	errs "github.com/bdlm/errors/v2"
	"github.com/bdlm/log/v2"
)

func Example_basic() {
	var logger = log.New()
	logger.Formatter = new(log.TextFormatter)                     //default
	logger.Formatter.(*log.TextFormatter).DisableTimestamp = true // remove timestamp from test output
	logger.Formatter.(*log.TextFormatter).DisableHostname = true  // remove timestamp from test output
	logger.Formatter.(*log.TextFormatter).DisableCaller = true    // remove caller from test output
	logger.Level = log.DebugLevel
	logger.Out = os.Stdout

	// Capture the panic result
	defer func() {
		err := recover()
		if err != nil {
			entry := err.(*log.Entry)
			logger.WithFields(log.Fields{
				"winner": entry.Data["animal"],
				"dead":   true,
			}).Error("That could have gone better...")
		}
	}()

	logger.WithFields(log.Fields{
		"animal": "bird",
		"count":  1,
	}).Debug("Oh, look, a bird...")
	logger.WithFields(log.Fields{
		"animal": "walrus",
		"count":  20,
	}).Info("A group of walrus emerges from the ocean")
	logger.WithFields(log.Fields{
		"animal": "walrus",
		"count":  100,
	}).Warn("The group's number increased tremendously!")
	logger.WithFields(log.Fields{
		"animal": "cow",
		"run":    "wait, what?",
	}).Error("Tremendously sized cow enters the ocean.")
	logger.WithFields(log.Fields{
		"animal": "walrus",
		"run":    true,
	}).Panic("The walrus are attacking!")

	// Output:
	// level="debug" msg="Oh, look, a bird..." data.animal="bird" data.count=1
	// level="info" msg="A group of walrus emerges from the ocean" data.animal="walrus" data.count=20
	// level="warn" msg="The group's number increased tremendously!" data.animal="walrus" data.count=100
	// level="error" msg="Tremendously sized cow enters the ocean." data.animal="cow" data.run="wait, what?"
	// level="panic" msg="The walrus are attacking!" data.animal="walrus" data.run=true
	// level="error" msg="That could have gone better..." data.dead=true data.winner="walrus"
}

func Example_json() {
	var logger = log.New()
	logger.Formatter = new(log.JSONFormatter)                     //default
	logger.Formatter.(*log.JSONFormatter).DisableTimestamp = true // remove timestamp from test output
	logger.Formatter.(*log.JSONFormatter).DisableHostname = true  // remove timestamp from test output
	logger.Formatter.(*log.JSONFormatter).DisableCaller = true    // remove caller from test output
	logger.Level = log.DebugLevel
	logger.Out = os.Stdout

	// Capture the panic result
	defer func() {
		err := recover()
		if err != nil {
			entry := err.(*log.Entry)
			logger.WithFields(log.Fields{
				"winner": entry.Data["animal"],
				"dead":   true,
			}).Error("That could have gone better...")
		}
	}()

	logger.WithFields(log.Fields{
		"animal": "bird",
		"count":  1,
	}).Debug("Oh, look, a bird...")
	logger.WithFields(log.Fields{
		"animal": "walrus",
		"count":  20,
	}).Info("A group of walrus emerges from the ocean")
	logger.WithFields(log.Fields{
		"animal": "walrus",
		"count":  100,
	}).Warn("The group's number increased tremendously!")
	logger.WithFields(log.Fields{
		"animal": "cow",
		"run":    "wait, what?",
	}).Error("Tremendously sized cow enters the ocean.")
	logger.WithFields(log.Fields{
		"animal": "walrus",
		"run":    true,
	}).Panic("The walrus are attacking!")

	// Output:
	// {"data":{"animal":"bird","count":1},"level":"debug","msg":"Oh, look, a bird..."}
	// {"data":{"animal":"walrus","count":20},"level":"info","msg":"A group of walrus emerges from the ocean"}
	// {"data":{"animal":"walrus","count":100},"level":"warn","msg":"The group's number increased tremendously!"}
	// {"data":{"animal":"cow","run":"wait, what?"},"level":"error","msg":"Tremendously sized cow enters the ocean."}
	// {"data":{"animal":"walrus","run":true},"level":"panic","msg":"The walrus are attacking!"}
	// {"data":{"dead":true,"winner":"walrus"},"level":"error","msg":"That could have gone better..."}
}

func Example_jsontty() {
	var logger = log.New()
	logger.Formatter = new(log.JSONFormatter)                     //default
	logger.Formatter.(*log.JSONFormatter).DisableTimestamp = true // remove timestamp from test output
	logger.Formatter.(*log.JSONFormatter).DisableHostname = true  // remove timestamp from test output
	logger.Formatter.(*log.JSONFormatter).DisableCaller = true    // remove caller from test output
	logger.Formatter.(*log.JSONFormatter).ForceTTY = true         // remove caller from test output
	logger.Level = log.DebugLevel
	logger.Out = os.Stdout

	// Capture the panic result
	defer func() {
		err := recover()
		if err != nil {
			entry := err.(*log.Entry)
			logger.WithFields(log.Fields{
				"winner": entry.Data["animal"],
				"dead":   true,
			}).Error("That could have gone better...")
		}
	}()

	logger.WithFields(log.Fields{
		"animal": "bird",
		"count":  1,
	}).Debug("Oh, look, a bird...")
	logger.WithFields(log.Fields{
		"animal": "walrus",
		"count":  20,
	}).Info("A group of walrus emerges from the ocean")
	logger.WithFields(log.Fields{
		"animal": "walrus",
		"count":  100,
	}).Warn("The group's number increased tremendously!")
	logger.WithFields(log.Fields{
		"animal": "cow",
		"run":    "wait, what?",
	}).Error("Tremendously sized cow enters the ocean.")
	logger.WithFields(log.Fields{
		"animal": "walrus",
		"run":    true,
	}).Panic("The walrus are attacking!")

	e := fmt.Errorf("error 1")
	e = errs.Wrap(e, "error 2")
	e = errs.Wrap(e, "error 3")
	log.WithError(e).WithField("some", "field").Info("GOT HERE")

	// Output:
	// {
	//     "level": "debug",
	//     "msg": "Oh, look, a bird...",
	//     "data": {
	//         "animal": "bird",
	//         "count": 1
	//     },
	// }
	// {
	//     "level": " info",
	//     "msg": "A group of walrus emerges from the ocean",
	//     "data": {
	//         "animal": "walrus",
	//         "count": 20
	//     },
	// }
	// {
	//     "level": " warn",
	//     "msg": "The group's number increased tremendously!",
	//     "data": {
	//         "animal": "walrus",
	//         "count": 100
	//     },
	// }
	// {
	//     "level": "error",
	//     "msg": "Tremendously sized cow enters the ocean.",
	//     "data": {
	//         "animal": "cow",
	//         "run": "wait, what?"
	//     },
	// }
	// {
	//     "level": "panic",
	//     "msg": "The walrus are attacking!",
	//     "data": {
	//         "animal": "walrus",
	//         "run": true
	//     },
	// }
	// {
	//     "level": "error",
	//     "msg": "That could have gone better...",
	//     "data": {
	//         "dead": true,
	//         "winner": "walrus"
	//     },
	// }
}

func Example_basic_withError() {
	var logger = log.New()
	logger.Formatter = new(log.TextFormatter)                     //default
	logger.Formatter.(*log.TextFormatter).DisableTimestamp = true // remove timestamp from test output
	logger.Formatter.(*log.TextFormatter).DisableHostname = true  // remove timestamp from test output
	logger.Formatter.(*log.TextFormatter).DisableCaller = true    // remove caller from test output
	logger.Level = log.DebugLevel
	logger.Out = os.Stdout

	// Capture the panic result
	defer func() {
		err := recover()
		if err != nil {
			e := fmt.Errorf("First mistake: not running when a walrus herd \"emerged\" from the ocean")
			e = errs.Wrap(e, "Second mistake: a walrus cow is not cattle...")

			entry := err.(*log.Entry)
			logger.WithError(e).WithFields(log.Fields{
				"winner": entry.Data["animal"],
				"dead":   true,
			}).Error("That could have gone better...")
		}
	}()

	logger.WithFields(log.Fields{
		"animal": "bird",
		"count":  1,
	}).Debug("Oh, look, a bird...")
	logger.WithFields(log.Fields{
		"animal": "walrus",
		"count":  20,
	}).Info("A group of walrus emerges from the ocean")
	logger.WithFields(log.Fields{
		"animal": "walrus",
		"count":  100,
	}).Warn("The group's number increased tremendously!")
	logger.WithFields(log.Fields{
		"animal": "cow",
		"run":    "wait, what?",
	}).Error("Tremendously sized cow enters the ocean.")
	logger.WithFields(log.Fields{
		"animal": "walrus",
		"run":    true,
	}).Panic("The walrus are attacking!")

	// Output:
	// level="debug" msg="Oh, look, a bird..." data.animal="bird" data.count=1
	// level="info" msg="A group of walrus emerges from the ocean" data.animal="walrus" data.count=20
	// level="warn" msg="The group's number increased tremendously!" data.animal="walrus" data.count=100
	// level="error" msg="Tremendously sized cow enters the ocean." data.animal="cow" data.run="wait, what?"
	// level="panic" msg="The walrus are attacking!" data.animal="walrus" data.run=true
	// level="error" msg="That could have gone better..." error="Second mistake: a walrus cow is not cattle... - #0 example_basic_test.go:226 (github.com/bdlm/log/v2_test.Example_basic_withError.func1);" data.dead=true data.winner="walrus"
}

func Example_json_withError() {
	var logger = log.New()
	logger.Formatter = new(log.JSONFormatter)                     //default
	logger.Formatter.(*log.JSONFormatter).DisableTimestamp = true // remove timestamp from test output
	logger.Formatter.(*log.JSONFormatter).DisableHostname = true  // remove timestamp from test output
	logger.Formatter.(*log.JSONFormatter).DisableCaller = true    // remove caller from test output
	logger.Level = log.DebugLevel
	logger.Out = os.Stdout

	// Capture the panic result
	defer func() {
		err := recover()
		if err != nil {
			e := fmt.Errorf("First mistake: not running when a walrus herd \"emerged\" from the ocean")
			e = errs.Wrap(e, "Second mistake: a walrus cow is not cattle...")

			entry := err.(*log.Entry)
			logger.WithError(e).WithFields(log.Fields{
				"winner": entry.Data["animal"],
				"dead":   true,
			}).Error("That could have gone better...")
		}
	}()

	logger.WithFields(log.Fields{
		"animal": "bird",
		"count":  1,
	}).Debug("Oh, look, a bird...")
	logger.WithFields(log.Fields{
		"animal": "walrus",
		"count":  20,
	}).Info("A group of walrus emerges from the ocean")
	logger.WithFields(log.Fields{
		"animal": "walrus",
		"count":  100,
	}).Warn("The group's number increased tremendously!")
	logger.WithFields(log.Fields{
		"animal": "cow",
		"run":    "wait, what?",
	}).Error("Tremendously sized cow enters the ocean.")
	logger.WithFields(log.Fields{
		"animal": "walrus",
		"run":    true,
	}).Panic("The walrus are attacking!")

	// Output:
	// {"data":{"animal":"bird","count":1},"level":"debug","msg":"Oh, look, a bird..."}
	// {"data":{"animal":"walrus","count":20},"level":"info","msg":"A group of walrus emerges from the ocean"}
	// {"data":{"animal":"walrus","count":100},"level":"warn","msg":"The group's number increased tremendously!"}
	// {"data":{"animal":"cow","run":"wait, what?"},"level":"error","msg":"Tremendously sized cow enters the ocean."}
	// {"data":{"animal":"walrus","run":true},"level":"panic","msg":"The walrus are attacking!"}
	// {"data":{"dead":true,"winner":"walrus"},"error":[{"caller":"#0 example_basic_test.go:280 (github.com/bdlm/log/v2_test.Example_json_withError.func1)","error":"Second mistake: a walrus cow is not cattle..."},{"caller":"#1 n/a","error":"First mistake: not running when a walrus herd \"emerged\" from the ocean"}],"level":"error","msg":"That could have gone better..."}
}

func Example_jsontty_withError() {
	var logger = log.New()
	logger.Formatter = new(log.JSONFormatter)                     //default
	logger.Formatter.(*log.JSONFormatter).DisableTimestamp = true // remove timestamp from test output
	logger.Formatter.(*log.JSONFormatter).DisableHostname = true  // remove timestamp from test output
	logger.Formatter.(*log.JSONFormatter).DisableCaller = true    // remove caller from test output
	logger.Formatter.(*log.JSONFormatter).ForceTTY = true         // remove caller from test output
	logger.Level = log.DebugLevel
	logger.Out = os.Stdout

	// Capture the panic result
	defer func() {
		err := recover()
		if err != nil {
			e := fmt.Errorf("First mistake: not running when a walrus herd \"emerged\" from the ocean")
			e = errs.Wrap(e, "Second mistake: a walrus cow is not cattle...")

			entry := err.(*log.Entry)
			logger.WithError(e).WithFields(log.Fields{
				"winner": entry.Data["animal"],
				"dead":   true,
			}).Error("That could have gone better...")
		}
	}()

	logger.WithFields(log.Fields{
		"animal": "bird",
		"count":  1,
	}).Debug("Oh, look, a bird...")
	logger.WithFields(log.Fields{
		"animal": "walrus",
		"count":  20,
	}).Info("A group of walrus emerges from the ocean")
	logger.WithFields(log.Fields{
		"animal": "walrus",
		"count":  100,
	}).Warn("The group's number increased tremendously!")
	logger.WithFields(log.Fields{
		"animal": "cow",
		"run":    "wait, what?",
	}).Error("Tremendously sized cow enters the ocean.")
	logger.WithFields(log.Fields{
		"animal": "walrus",
		"run":    true,
	}).Panic("The walrus are attacking!")

	e := fmt.Errorf("error 1")
	e = errs.Wrap(e, "error 2")
	e = errs.Wrap(e, "error 3")
	log.WithError(e).WithField("some", "field").Info("GOT HERE")

	// Output:
	// {
	//     "level": "debug",
	//     "msg": "Oh, look, a bird...",
	//     "data": {
	//         "animal": "bird",
	//         "count": 1
	//     },
	// }
	// {
	//     "level": " info",
	//     "msg": "A group of walrus emerges from the ocean",
	//     "data": {
	//         "animal": "walrus",
	//         "count": 20
	//     },
	// }
	// {
	//     "level": " warn",
	//     "msg": "The group's number increased tremendously!",
	//     "data": {
	//         "animal": "walrus",
	//         "count": 100
	//     },
	// }
	// {
	//     "level": "error",
	//     "msg": "Tremendously sized cow enters the ocean.",
	//     "data": {
	//         "animal": "cow",
	//         "run": "wait, what?"
	//     },
	// }
	// {
	//     "level": "panic",
	//     "msg": "The walrus are attacking!",
	//     "data": {
	//         "animal": "walrus",
	//         "run": true
	//     },
	// }
	// {
	//     "level": "error",
	//     "msg": "That could have gone better...",
	//     "error": [
	//         {
	//             "caller": "#0 example_basic_test.go:335 (github.com/bdlm/log/v2_test.Example_jsontty_withError.func1)",
	//             "error": "Second mistake: a walrus cow is not cattle..."
	//         },
	//         {
	//             "caller": "#1 n/a",
	//             "error": "First mistake: not running when a walrus herd \"emerged\" from the ocean"
	//         }
	//     ]
	//     "data": {
	//         "dead": true,
	//         "winner": "walrus"
	//     },
	// }
}