log

package module
Version: v0.1.20 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 5, 2020 License: MIT Imports: 19 Imported by: 81

README

log

MIT Mature Build status Coverage status Go Report Card Github issues Github pull requests GoDoc

bdlm/log is a fork of the excellent sirupsen/logrus package.

This package adds:

  • support for sanitizing strings from log output to aid in preventing leaking sensitive data.
  • additional default fields host and caller.
  • verbose output including the full backtrace of logger calls.
  • support for suppressing any default field.
  • TTY formatting and coloring of JSON output.
  • updated formatting for TTY text output.
  • updated default TTY color scheme and color customization.

bdlm/log is a structured logger for Go and is fully API compatible with both the standard libaray log package as well as the sirupsen/logrus package.

Examples

User documentation
Simple usage

The simplest way to use bdlm/log is with the exported package-level logger:

package main

import (
    log "github.com/bdlm/log"
)

func main() {
    log.WithFields(log.Fields{
        "animal": "walrus",
    }).Info("A walrus appears")
}

Compatibility

Note that bdlm/log is fully api-compatible with the stdlib logger, so you can replace your log imports everywhere or using a strangler pattern with "github.com/bdlm/log" and add the full logging flexibility to your service without impacting existing code.

The default log format of this package does not match the stdlib logger's default output so a compatible formatter, StdFormatter, is provided which includes the additional information inline:

log.SetFormatter(&log.StdFormatter{})

Which results in the following log output. StdFormatter does not have a TTY feature:

2018/08/17 20:17:45 Oh, look, a bird... level="debug" data.animal="bird" data.count=1 caller="main.go:39 main.main" host="myhost"
2018/08/17 20:17:45 A group of walrus emerges from the ocean level="info" data.animal="walrus" data.count=20 caller="main.go:43 main.main" host="myhost"
2018/08/17 20:17:45 The group's number increased tremendously! level="warn" data.animal="walrus" data.count=100 caller="main.go:47 main.main" host="myhost"
2018/08/17 20:17:45 Tremendously sized cow enters the ocean. level="error" data.animal="cow" data.count="wait, what?" caller="main.go:51 main.main" host="myhost"
2018/08/17 20:17:45 The walrus are attacking! level="panic" data.animal="walrus" data.run=true caller="main.go:55 main.main" host="myhost"
2018/08/17 20:17:45 That could have gone better... level="fatal" data.dead=true data.winner="walrus" caller="main.go:30 main.main.func1" host="myhost"

Log Formatters

By default, bdlm/log uses a basic text format:

time="2018-08-17T18:28:07.385-06:00" level="debug" msg="Oh, look, a bird..." data.animal="bird" data.count=1 caller="main.go:34 main.main" host="myhost"
time="2018-08-17T18:28:07.385-06:00" level="info" msg="A group of walrus emerges from the ocean" data.animal="walrus" data.count=20 caller="main.go:38 main.main" host="myhost"
time="2018-08-17T18:28:07.385-06:00" level="warn" msg="The group's number increased tremendously!" data.animal="walrus" data.count=100 caller="main.go:42 main.main" host="myhost"
time="2018-08-17T18:28:07.385-06:00" level="error" msg="Tremendously sized cow enters the ocean." data.animal="cow" data.count="wait, what?" caller="main.go:46 main.main" host="myhost"
time="2018-08-17T18:28:07.385-06:00" level="panic" msg="The walrus are attacking!" data.animal="walrus" data.run=true caller="main.go:50 main.main" host="myhost"
time="2018-08-17T18:28:07.385-06:00" level="fatal" msg="That could have gone better..." data.dead=true data.winner="walrus" caller="main.go:25 main.main.func1" host="myhost"

For development, color-coded output formated for humans is automatically enabled when a tty terminal is detected (this can be disabled with log.SetFormatter(&log.TextFormatter{DisableTTY: true})):

JSON formatting is also available with log.SetFormatter(&log.JSONFormatter{}) for easy parsing by logstash or similar:

{"caller":"main.go:36 main.main","data":{"animal":"bird","count":1},"host":"myhost","level":"debug","msg":"Oh, look, a bird...","time":"2018-08-17T18:32:30.786-06:00"}
{"caller":"main.go:40 main.main","data":{"animal":"walrus","count":20},"host":"myhost","level":"info","msg":"A group of walrus emerges from the ocean","time":"2018-08-17T18:32:30.786-06:00"}
{"caller":"main.go:44 main.main","data":{"animal":"walrus","count":100},"host":"myhost","level":"warn","msg":"The group's number increased tremendously!","time":"2018-08-17T18:32:30.786-06:00"}
{"caller":"main.go:48 main.main","data":{"animal":"cow","count":"wait, what?"},"host":"myhost","level":"error","msg":"Tremendously sized cow enters the ocean.","time":"2018-08-17T18:32:30.786-06:00"}
{"caller":"main.go:52 main.main","data":{"animal":"walrus","run":true},"host":"myhost","level":"panic","msg":"The walrus are attacking!","time":"2018-08-17T18:32:30.786-06:00"}
{"caller":"main.go:27 main.main.func1","data":{"dead":true,"winner":"walrus"},"host":"myhost","level":"fatal","msg":"That could have gone better...","time":"2018-08-17T18:32:30.787-06:00"}

The JSON formatter also makes adjustments by default when a tty terminal is detected and can be disabled similarly with log.SetFormatter(&log.JSONFormatter{DisableTTY: true}):

Backtrace data

The standard formatters also have a trace mode that is disabled by default. Rather than acting as an additional log level, it is instead a verbose mode that includes the full backtrace of the call that triggered the log write. To enable trace output, set EnableTrace to true.

Here are the above examples with trace enabled:

TextFormat

Non-TTY trace output:

log.SetFormatter(&log.TextFormatter{
    DisableTTY: true,
    EnableTrace: true,
})
time="2018-08-18T00:20:36.468-06:00" level="debug" msg="Oh, look, a bird..." data.animal="bird" data.count=1 host="myhost" trace.0="main.go:38 main.main"
time="2018-08-18T00:20:36.469-06:00" level="info" msg="A group of walrus emerges from the ocean" data.animal="walrus" data.count=20 host="myhost" trace.0="main.go:42 main.main"
time="2018-08-18T00:20:36.469-06:00" level="warn" msg="The group's number increased tremendously!" data.animal="walrus" data.count=100 host="myhost" trace.0="main.go:46 main.main"
time="2018-08-18T00:20:36.469-06:00" level="error" msg="Tremendously sized cow enters the ocean." data.animal="cow" data.count="wait, what?" host="myhost" trace.0="main.go:50 main.main"
time="2018-08-18T00:20:36.469-06:00" level="panic" msg="The walrus are attacking!" data.animal="walrus" data.run=true host="myhost" trace.0="main.go:54 main.main"
time="2018-08-18T00:20:36.469-06:00" level="fatal" msg="That could have gone better..." data.dead=true data.winner="walrus" host="myhost" trace.0="main.go:30 main.main.func1" trace.1="asm_amd64.s:573 runtime.call32" trace.2="panic.go:502 runtime.gopanic" trace.3="main.go:54 main.main"

TTY trace output:

log.SetFormatter(&log.TextFormatter{
    EnableTrace: true,
    ForceTTY: true,
})

JSONFormat

To enable trace output:

log.SetFormatter(&log.JSONFormatter{
    DisableTTY: true,
    EnableTrace: true,
})

Non-TTY trace output:

{"caller":"main.go:38 main.main","data":{"animal":"bird","count":1},"host":"myhost","level":"debug","msg":"Oh, look, a bird...","time":"2018-08-18T00:22:16.057-06:00","trace":["main.go:38 main.main"]}
{"caller":"main.go:42 main.main","data":{"animal":"walrus","count":20},"host":"myhost","level":"info","msg":"A group of walrus emerges from the ocean","time":"2018-08-18T00:22:16.058-06:00","trace":["main.go:42 main.main"]}
{"caller":"main.go:46 main.main","data":{"animal":"walrus","count":100},"host":"myhost","level":"warn","msg":"The group's number increased tremendously!","time":"2018-08-18T00:22:16.058-06:00","trace":["main.go:46 main.main"]}
{"caller":"main.go:50 main.main","data":{"animal":"cow","count":"wait, what?"},"host":"myhost","level":"error","msg":"Tremendously sized cow enters the ocean.","time":"2018-08-18T00:22:16.058-06:00","trace":["main.go:50 main.main"]}
{"caller":"main.go:54 main.main","data":{"animal":"walrus","run":true},"host":"myhost","level":"panic","msg":"The walrus are attacking!","time":"2018-08-18T00:22:16.058-06:00","trace":["main.go:54 main.main"]}
{"caller":"main.go:30 main.main.func1","data":{"dead":true,"winner":"walrus"},"host":"myhost","level":"fatal","msg":"That could have gone better...","time":"2018-08-18T00:22:16.058-06:00","trace":["main.go:30 main.main.func1","asm_amd64.s:573 runtime.call32","panic.go:502 runtime.gopanic","main.go:54 main.main"]}

TTY trace output:

log.SetFormatter(&log.JSONFormatter{
    EnableTrace: true,
    ForceTTY: true,
})

Documentation

Overview

Package log is a fork of the excellent [`sirupsen/logrus`](https://github.com/bdlm/log) package.

log is a structured logger for Go, completely API compatible with the standard library logger.

Package-level exported logger

package main

import (
  "github.com/bdlm/log"
)

func main() {
  log.WithFields(log.Fields{
    "animal": "walrus",
    "number": 1,
    "size":   10,
  }).Info("A walrus appears")
}

Output:

time="2015-09-07T08:48:33Z" level=info msg="A walrus appears" animal=walrus number=1 size=10

API Compatibility

Note that it is completely api-compatible with the stdlib logger, so you can replace your `log` imports everywhere with `"github.com/bdlm/log"` and you'll have the full flexibility of `bdlm/log` available. You can customize it further in your code:

package main

import (
  "os"
  log "github.com/bdlm/log"
)

func init() {
  // Log as JSON instead of the default ASCII formatter.
  log.SetFormatter(&log.JSONFormatter{})

  // Output to stdout instead of the default stderr. Can be any io.Writer, see
  // below for a File example.
  log.SetOutput(os.Stdout)

  // Only log the warning severity or above.
  log.SetLevel(log.WarnLevel)
}

func main() {
  log.WithFields(log.Fields{
    "animal": "walrus",
    "size":   10,
  }).Info("A group of walrus emerges from the ocean")

  log.WithFields(log.Fields{
    "omg":    true,
    "number": 122,
  }).Warn("The group's number increased tremendously!")

  log.WithFields(log.Fields{
    "omg":    true,
    "number": 100,
  }).Fatal("The ice breaks!")

  // A common pattern is to re-use fields between logging statements by re-using
  // the logrus.Entry returned from WithFields()
  contextLogger := log.WithFields(log.Fields{
    "common": "this is a common field",
    "other": "I also should be logged always",
  })

  contextLogger.Info("I'll be logged with common and other field")
  contextLogger.Info("Me too")
}

Managing secrets

`bdlm/log` also supports a "blacklist" of values that should not be logged. This can be used to help prevent or mitigate leaking secrets into log files:

import (
    "github.com/bdlm/log"
)

func main() {
    log.AddSecret("some-secret-text")
    log.Info("the secret is 'some-secret-text'")

    // Output: the secret is '****************'
}

Output to multiple locations

For more advanced usage such as logging to multiple locations from the same application, you can create an instance of the `bdlm/log` Logger:

package main

import (
  "os"
  "github.com/bdlm/log"
)

// Create a new instance of the logger. You can have any number of instances.
var logger = log.New()

func main() {
  // The API for setting attributes is a little different than the package level
  // exported logger. See Godoc.
  logger.Out = os.Stdout

  // You could set this to any `io.Writer` such as a file
  // file, err := os.OpenFile("logrus.log", os.O_CREATE|os.O_WRONLY, 0666)
  //  if err == nil {
  //    logger.Out = file
  //  } else {
  //    logger.Info("Failed to log to file, using default stderr")
  // }

  logger.WithFields(logrus.Fields{
    "animal": "walrus",
    "size":   10,
  }).Info("A group of walrus emerges from the ocean")
}

Output features

Color-coded output is available when attached to a TTY for development. A JSON formatter is also available for easy parsing by logstash or Splunk:

log.SetFormatter(&log.JSONFormatter{})

Output:

{"caller":"main.go:37 main.main","data":{"animal":"walrus"},"host":"myhost","level":"info","msg":"A group of walrus emerges from the ocean","time":"2018-08-10T23:08:02.860Z"}
{"caller":"main.go:61 main.main","host":"myhost","level":"warning","msg":"The group's number increased tremendously!","number":122,"omg":true,"time":"2018-08-10T23:08:02.863Z"}
{"caller":"main.go:99 main.main","data":{"animal":"walrus"},"host":"myhost","level":"info","msg":"A giant walrus appears!","time":"2018-08-10T23:08:02.877Z"}
{"caller":"main.go:61 main.main","data":{"animal":"walrus","host":"myhost","level":"info","msg":"Tremendously sized cow enters the ocean.","time":"2018-08-10T23:08:02.877Z"}
{"caller":"main.go:99 main.main","host":"myhost","level":"fatal","msg":"The ice breaks!","number":100,"omg":true,"time":"2018-08-10T23:08:03.566Z"}

For a full guide visit https://github.com/bdlm/log

Example (Basic)
package main

import (
	"os"

	"github.com/bdlm/log"
)

func main() {
	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"

Index

Examples

Constants

View Source
const (
	LabelCaller = "caller"
	LabelData   = "data"
	LabelHost   = "host"
	LabelLevel  = "level"
	LabelMsg    = "msg"
	LabelTime   = "time"
	LabelTrace  = "trace"
)

Default key names for the default fields

View Source
const (
	// PanicLevel level, highest level of severity. Logs and then calls panic with the
	// message passed to Debug, Info, ...
	PanicLevel = stdLogger.Panic
	// FatalLevel level. Logs and then calls `os.Exit(1)`. It will exit even if the
	// logging level is set to Panic.
	FatalLevel = stdLogger.Fatal
	// ErrorLevel level. Logs. Used for errors that should definitely be noted.
	// Commonly used for hooks to send errors to an error tracking service.
	ErrorLevel = stdLogger.Error
	// WarnLevel level. Non-critical entries that deserve eyes.
	WarnLevel = stdLogger.Warn
	// InfoLevel level. General operational entries about what's going on inside the
	// application.
	InfoLevel = stdLogger.Info
	// DebugLevel level. Usually only enabled when debugging. Very verbose logging.
	DebugLevel = stdLogger.Debug
)

These are the standard logging levels. You can set the logging level to log on your instance of logger, obtained with `New()`.

View Source
const RFC3339Milli = "2006-01-02T15:04:05.000Z07:00"

RFC3339Milli defines an RFC3339 date format with miliseconds

Variables

View Source
var (
	// DEFAULTColor is the default TTY 'level' color.
	DEFAULTColor = "\033[38;5;46m"
	// ERRORColor is the TTY 'level' color for error messages.
	ERRORColor = "\033[38;5;208m"
	// FATALColor is the TTY 'level' color for fatal messages.
	FATALColor = "\033[38;5;124m"
	// PANICColor is the TTY 'level' color for panic messages.
	PANICColor = "\033[38;5;196m"
	// WARNColor is the TTY 'level' color for warning messages.
	WARNColor = "\033[38;5;226m"
	// DEBUGColor is the TTY 'level' color for debug messages.
	DEBUGColor = "\033[38;5;245m"

	// CallerColor is the TTY caller color.
	CallerColor = "\033[38;5;244m"
	// DataLabelColor is the TTY data label color.
	DataLabelColor = "\033[38;5;111m"
	// DataValueColor is the TTY data value color.
	DataValueColor = "\033[38;5;180m"
	// HostnameColor is the TTY hostname color.
	HostnameColor = "\033[38;5;39m"
	// TraceColor is the TTY trace color.
	TraceColor = "\033[38;5;244m"
	// TimestampColor is the TTY timestamp color.
	TimestampColor = "\033[38;5;72m"

	// ResetColor resets the TTY color scheme to it's default.
	ResetColor = "\033[0m"
)

AllLevels is a constant exposing all logging levels.

View Source
var ErrorKey = "error"

ErrorKey defines the key when adding errors using WithError.

Functions

func AddHook

func AddHook(hook Hook)

AddHook adds a hook to the standard logger hooks.

func AddSecret

func AddSecret(secret string)

AddSecret adds a string to the sanitization list.

func Debug

func Debug(args ...interface{})

Debug logs a message at level Debug on the standard logger.

func Debugf

func Debugf(format string, args ...interface{})

Debugf logs a message at level Debug on the standard logger.

func Debugln

func Debugln(args ...interface{})

Debugln logs a message at level Debug on the standard logger.

func Error

func Error(args ...interface{})

Error logs a message at level Error on the standard logger.

func Errorf

func Errorf(format string, args ...interface{})

Errorf logs a message at level Error on the standard logger.

func Errorln

func Errorln(args ...interface{})

Errorln logs a message at level Error on the standard logger.

func Exit

func Exit(code int)

Exit runs all the exit handlers and then terminates the program using os.Exit(code)

func Fatal

func Fatal(args ...interface{})

Fatal logs a message at level Fatal on the standard logger then the process will exit with status set to 1.

func Fatalf

func Fatalf(format string, args ...interface{})

Fatalf logs a message at level Fatal on the standard logger then the process will exit with status set to 1.

func Fatalln

func Fatalln(args ...interface{})

Fatalln logs a message at level Fatal on the standard logger then the process will exit with status set to 1.

func GetLevel

func GetLevel() stdLogger.Level

GetLevel returns the standard logger level.

func Info

func Info(args ...interface{})

Info logs a message at level Info on the standard logger.

func Infof

func Infof(format string, args ...interface{})

Infof logs a message at level Info on the standard logger.

func Infoln

func Infoln(args ...interface{})

Infoln logs a message at level Info on the standard logger.

func LevelString added in v0.1.19

func LevelString(level stdLogger.Level) string

LevelString convert the Level to a human readable string. E.g. PanicLevel becomes "panic".

func Panic

func Panic(args ...interface{})

Panic logs a message at level Panic on the standard logger.

func Panicf

func Panicf(format string, args ...interface{})

Panicf logs a message at level Panic on the standard logger.

func Panicln

func Panicln(args ...interface{})

Panicln logs a message at level Panic on the standard logger.

func ParseLevel

func ParseLevel(lvl string) (stdLogger.Level, error)

ParseLevel takes a string level and returns the log level constant.

func Print

func Print(args ...interface{})

Print logs a message at level Info on the standard logger.

func Printf

func Printf(format string, args ...interface{})

Printf logs a message at level Info on the standard logger.

func Println

func Println(args ...interface{})

Println logs a message at level Info on the standard logger.

func RegisterExitHandler

func RegisterExitHandler(handler func())

RegisterExitHandler adds an Exit handler, call log.Exit to invoke all handlers. The handlers will also be invoked when any Fatal log entry is made.

This method is useful when a caller wishes to log a fatal message but also needs to gracefully shutdown. An example usecase could be closing database connections, or sending a alert that the application is closing.

func SetCallerLevel added in v0.1.14

func SetCallerLevel(level int)

SetCallerLevel will adjust the relative caller level in log output.

func SetFormatter

func SetFormatter(formatter Formatter)

SetFormatter sets the standard logger formatter.

func SetLevel

func SetLevel(level stdLogger.Level)

SetLevel sets the standard logger level.

func SetOutput

func SetOutput(out io.Writer)

SetOutput sets the standard logger output.

func Warn

func Warn(args ...interface{})

Warn logs a message at level Warn on the standard logger.

func Warnf

func Warnf(format string, args ...interface{})

Warnf logs a message at level Warn on the standard logger.

func Warning

func Warning(args ...interface{})

Warning logs a message at level Warn on the standard logger.

func Warningf

func Warningf(format string, args ...interface{})

Warningf logs a message at level Warn on the standard logger.

func Warningln

func Warningln(args ...interface{})

Warningln logs a message at level Warn on the standard logger.

func Warnln

func Warnln(args ...interface{})

Warnln logs a message at level Warn on the standard logger.

Types

type Entry

type Entry struct {
	Logger *Logger

	// Contains all the fields set by the user.
	Data Fields

	// Time at which the log entry was created
	Time time.Time

	// Level the log entry was logged at: Debug, Info, Warn, Error, Fatal or Panic
	// This field will be set on entry firing and the value will be equal to the one in Logger struct field.
	Level logger.Level

	// Message passed to Debug, Info, Warn, Error, Fatal or Panic
	Message string

	// When formatter is called in entry.log(), an Buffer may be set to entry
	Buffer *bytes.Buffer
}

Entry is the final or intermediate logging entry. It contains all the fields passed with WithField{,s}. It's finally logged when Debug, Info, Warn, Error, Fatal or Panic is called on it. These objects can be reused and passed around as much as you wish to avoid field duplication.

func NewEntry

func NewEntry(logger *Logger) *Entry

NewEntry returns a new logger entry.

func WithError

func WithError(err error) *Entry

WithError creates an entry from the standard logger and adds an error to it, using the value defined in ErrorKey as key.

func WithField

func WithField(key string, value interface{}) *Entry

WithField creates an entry from the standard logger and adds a field to it. If you want multiple fields, use `WithFields`.

Note that it doesn't log until you call Debug, Print, Info, Warn, Fatal or Panic on the Entry it returns.

func WithFields

func WithFields(fields Fields) *Entry

WithFields creates an entry from the standard logger and adds multiple fields to it. This is simply a helper for `WithField`, invoking it once for each field.

Note that it doesn't log until you call Debug, Print, Info, Warn, Fatal or Panic on the Entry it returns.

func WithTime

func WithTime(t time.Time) *Entry

WithTime creats an entry from the standard logger and overrides the time of logs generated with it.

Note that it doesn't log until you call Debug, Print, Info, Warn, Fatal or Panic on the Entry it returns.

func (*Entry) Debug

func (entry *Entry) Debug(args ...interface{})

Debug logs a debug-level message using Println.

func (*Entry) Debugf

func (entry *Entry) Debugf(format string, args ...interface{})

Debugf logs a debug-level message using Printf.

func (*Entry) Debugln

func (entry *Entry) Debugln(args ...interface{})

Debugln logs a debug-level message using Println.

func (*Entry) Error

func (entry *Entry) Error(args ...interface{})

Error logs a error-level message using Println.

func (*Entry) Errorf

func (entry *Entry) Errorf(format string, args ...interface{})

Errorf logs a error-level message using Printf.

func (*Entry) Errorln

func (entry *Entry) Errorln(args ...interface{})

Errorln logs a error-level message using Println.

func (*Entry) Fatal

func (entry *Entry) Fatal(args ...interface{})

Fatal logs a fatal-level message using Println.

func (*Entry) Fatalf

func (entry *Entry) Fatalf(format string, args ...interface{})

Fatalf logs a fatal-level message using Printf.

func (*Entry) Fatalln

func (entry *Entry) Fatalln(args ...interface{})

Fatalln logs a fatal-level message using Println.

func (*Entry) Info

func (entry *Entry) Info(args ...interface{})

Info logs a info-level message using Println.

func (*Entry) Infof

func (entry *Entry) Infof(format string, args ...interface{})

Infof logs a info-level message using Printf.

func (*Entry) Infoln

func (entry *Entry) Infoln(args ...interface{})

Infoln logs a info-level message using Println.

func (*Entry) Panic

func (entry *Entry) Panic(args ...interface{})

Panic logs a panic-level message using Println.

func (*Entry) Panicf

func (entry *Entry) Panicf(format string, args ...interface{})

Panicf logs a panic-level message using Printf.

func (*Entry) Panicln

func (entry *Entry) Panicln(args ...interface{})

Panicln logs a panic-level message using Println.

func (*Entry) Print

func (entry *Entry) Print(args ...interface{})

Print logs a info-level message using Println.

func (*Entry) Printf

func (entry *Entry) Printf(format string, args ...interface{})

Printf logs a info-level message using Printf.

func (*Entry) Println

func (entry *Entry) Println(args ...interface{})

Println logs a info-level message using Println.

func (*Entry) String

func (entry *Entry) String() (string, error)

String returns the string representation from the reader and ultimately the formatter.

func (*Entry) Warn

func (entry *Entry) Warn(args ...interface{})

Warn logs a warn-level message using Println.

func (*Entry) Warnf

func (entry *Entry) Warnf(format string, args ...interface{})

Warnf logs a warn-level message using Printf.

func (*Entry) Warning

func (entry *Entry) Warning(args ...interface{})

Warning logs a warn-level message using Println.

func (*Entry) Warningf

func (entry *Entry) Warningf(format string, args ...interface{})

Warningf logs a warn-level message using Printf.

func (*Entry) Warningln

func (entry *Entry) Warningln(args ...interface{})

Warningln logs a warn-level message using Println.

func (*Entry) Warnln

func (entry *Entry) Warnln(args ...interface{})

Warnln logs a warn-level message using Println.

func (*Entry) WithError

func (entry *Entry) WithError(err error) *Entry

WithError add an error as single field (using the key defined in ErrorKey) to the Entry.

func (*Entry) WithField

func (entry *Entry) WithField(key string, value interface{}) *Entry

WithField add a single field to the Entry.

func (*Entry) WithFields

func (entry *Entry) WithFields(fields Fields) *Entry

WithFields adds a map of fields to the Entry.

func (*Entry) WithTime

func (entry *Entry) WithTime(t time.Time) *Entry

WithTime overrides the time of the Entry.

func (*Entry) Writer

func (entry *Entry) Writer() *io.PipeWriter

Writer returns an info-level log writer.

func (*Entry) WriterLevel

func (entry *Entry) WriterLevel(level stdLogger.Level) *io.PipeWriter

WriterLevel returns a log writer with a specified leve.

type FieldLabel

type FieldLabel string

FieldLabel is a type for defining label keys.

type FieldLogger

type FieldLogger interface {
	WithField(key string, value interface{}) *Entry
	WithFields(fields Fields) *Entry
	WithError(err error) *Entry

	Debugf(format string, args ...interface{})
	Infof(format string, args ...interface{})
	Printf(format string, args ...interface{})
	Warnf(format string, args ...interface{})
	Warningf(format string, args ...interface{})
	Errorf(format string, args ...interface{})
	Fatalf(format string, args ...interface{})
	Panicf(format string, args ...interface{})

	Debug(args ...interface{})
	Info(args ...interface{})
	Print(args ...interface{})
	Warn(args ...interface{})
	Warning(args ...interface{})
	Error(args ...interface{})
	Fatal(args ...interface{})
	Panic(args ...interface{})

	Debugln(args ...interface{})
	Infoln(args ...interface{})
	Println(args ...interface{})
	Warnln(args ...interface{})
	Warningln(args ...interface{})
	Errorln(args ...interface{})
	Fatalln(args ...interface{})
	Panicln(args ...interface{})
}

The FieldLogger interface generalizes the Entry and Logger types

type FieldMap

type FieldMap map[FieldLabel]string

FieldMap allows customization of the key names for default fields.

type Fields

type Fields map[string]interface{}

Fields type, used to pass to `WithFields`.

type Formatter

type Formatter interface {
	Format(*Entry) ([]byte, error)
}

The Formatter interface is used to implement a custom Formatter. It takes an `Entry`. It exposes all the fields, including the default ones:

* `entry.Data["msg"]`. The message passed from Info, Warn, Error .. * `entry.Data["time"]`. The timestamp. * `entry.Data["level"]. The level the entry was logged at.

Any additional fields added with `WithField` or `WithFields` are also in `entry.Data`. Format is expected to return an array of bytes which are then logged to `logger.Out`.

type Hook

type Hook interface {
	Levels() []logger.Level
	Fire(*Entry) error
}

Hook defines a hook to be fired when logging on the logging levels returned from `Levels()` on your implementation of the interface. Note that this is not fired in a goroutine or a channel with workers, you should handle such functionality yourself if your call is non-blocking and you don't wish for the logging calls for levels returned from `Levels()` to block.

type JSONFormatter

type JSONFormatter struct {
	// DataKey allows users to put all the log entry parameters into a
	// nested dictionary at a given key.
	DataKey string

	// DisableCaller disables caller data output.
	DisableCaller bool

	// DisableHostname disables hostname output.
	DisableHostname bool

	// DisableLevel disables level output.
	DisableLevel bool

	// DisableMessage disables message output.
	DisableMessage bool

	// DisableTimestamp disables timestamp output.
	DisableTimestamp bool

	// DisableTTY disables TTY formatted output.
	DisableTTY bool

	// Enable full backtrace output.
	EnableTrace bool

	// EscapeHTML is a flag that notes whether HTML characters should be
	// escaped.
	EscapeHTML bool

	// ForceTTY forces TTY formatted output.
	ForceTTY bool

	// FieldMap allows users to customize the names of keys for default
	// fields.
	//
	// For example:
	// 	formatter := &TextFormatter{FieldMap: FieldMap{
	//      LabelCaller: "@caller",
	//      LabelData:   "@data",
	//      LabelHost:   "@hostname",
	//      LabelLevel:  "@loglevel",
	//      LabelMsg:    "@message",
	//      LabelTime:   "@timestamp",
	// 	}}
	FieldMap FieldMap

	// TimestampFormat allows a custom timestamp format to be used.
	TimestampFormat string

	sync.Once
	// contains filtered or unexported fields
}

JSONFormatter formats logs into parsable json.

func (*JSONFormatter) Format

func (f *JSONFormatter) Format(entry *Entry) ([]byte, error)

Format renders a single log entry

type LevelHooks

type LevelHooks map[logger.Level][]Hook

LevelHooks is an internal type for storing the hooks on a logger instance.

func (LevelHooks) Add

func (hooks LevelHooks) Add(hook Hook)

Add a hook to an instance of logger. This is called with `log.Hooks.Add(new(MyHook))` where `MyHook` implements the `Hook` interface.

func (LevelHooks) Fire

func (hooks LevelHooks) Fire(level logger.Level, entry *Entry) error

Fire all the hooks for the passed level. Used by `entry.log` to fire appropriate hooks for a log entry.

type Logger

type Logger struct {
	// The logs are `io.Copy`'d to this in a mutex. It's common to set this to a
	// file, or leave it default which is `os.Stderr`. You can also set this to
	// something more adventurous, such as logging to Kafka.
	Out io.Writer
	// Hooks for the logger instance. These allow firing events based on logging
	// levels and log entries. For example, to send errors to an error tracking
	// service, log to StatsD or dump the core on fatal errors.
	Hooks LevelHooks
	// All log entries pass through the formatter before logged to Out. The
	// included formatters are `TextFormatter` and `JSONFormatter` for which
	// TextFormatter is the default. In development (when a TTY is attached) it
	// logs with colors, but to a file it wouldn't. You can easily implement your
	// own that implements the `Formatter` interface, see the `README` or included
	// formatters for examples.
	Formatter Formatter
	// The logging level the logger should log at. This is typically (and defaults
	// to) `log.Info`, which allows Info(), Warn(), Error() and Fatal() to be
	// logged.
	Level stdLogger.Level
	// contains filtered or unexported fields
}

Logger defines properties for managing logs and implements the std.Logger interface.

func New

func New() *Logger

New creates a new logger. Configuration should be set by changing `Formatter`, `Out` and `Hooks` directly on the default logger instance. You can also just instantiate your own:

var log = &Logger{
  Out: os.Stderr,
  Formatter: new(JSONFormatter),
  Hooks: make(LevelHooks),
  Level: log.DebugLevel,
}

It's recommended to make this a global instance called `log`.

func StandardLogger

func StandardLogger() *Logger

StandardLogger returns the Logger pointer.

func (*Logger) AddHook

func (logger *Logger) AddHook(hook Hook)

AddHook adds a hook to the stack.

func (*Logger) Debug

func (logger *Logger) Debug(args ...interface{})

Debug logs a debug-level message using Println.

func (*Logger) Debugf

func (logger *Logger) Debugf(format string, args ...interface{})

Debugf logs a debug-level message using Printf.

func (*Logger) Debugln

func (logger *Logger) Debugln(args ...interface{})

Debugln logs a debug-level message using Println.

func (*Logger) Error

func (logger *Logger) Error(args ...interface{})

Error logs a error-level message using Println.

func (*Logger) Errorf

func (logger *Logger) Errorf(format string, args ...interface{})

Errorf logs a error-level message using Printf.

func (*Logger) Errorln

func (logger *Logger) Errorln(args ...interface{})

Errorln logs a error-level message using Println.

func (*Logger) Fatal

func (logger *Logger) Fatal(args ...interface{})

Fatal logs a fatal-level message using Println.

func (*Logger) Fatalf

func (logger *Logger) Fatalf(format string, args ...interface{})

Fatalf logs a fatal-level message using Printf.

func (*Logger) Fatalln

func (logger *Logger) Fatalln(args ...interface{})

Fatalln logs a fatal-level message using Println.

func (*Logger) Info

func (logger *Logger) Info(args ...interface{})

Info logs a info-level message using Println.

func (*Logger) Infof

func (logger *Logger) Infof(format string, args ...interface{})

Infof logs a info-level message using Printf.

func (*Logger) Infoln

func (logger *Logger) Infoln(args ...interface{})

Infoln logs a info-level message using Println.

func (*Logger) Panic

func (logger *Logger) Panic(args ...interface{})

Panic logs a panic-level message using Println.

func (*Logger) Panicf

func (logger *Logger) Panicf(format string, args ...interface{})

Panicf logs a panic-level message using Printf.

func (*Logger) Panicln

func (logger *Logger) Panicln(args ...interface{})

Panicln logs a panic-level message using Println.

func (*Logger) Print

func (logger *Logger) Print(args ...interface{})

Print logs a info-level message using Println.

func (*Logger) Printf

func (logger *Logger) Printf(format string, args ...interface{})

Printf logs a info-level message using Printf.

func (*Logger) Println

func (logger *Logger) Println(args ...interface{})

Println logs a info-level message using Println.

func (*Logger) SetLevel

func (logger *Logger) SetLevel(level stdLogger.Level)

SetLevel sets the minimum logging level.

func (*Logger) SetNoLock

func (logger *Logger) SetNoLock()

SetNoLock disables locking. When file is opened with appending mode, it's safe to write concurrently to a file (within 4k message on Linux). In these cases user can choose to disable the lock.

func (*Logger) SetOutput

func (logger *Logger) SetOutput(out io.Writer)

SetOutput sets the logger output writer.

func (*Logger) Warn

func (logger *Logger) Warn(args ...interface{})

Warn logs a warn-level message using Println.

func (*Logger) Warnf

func (logger *Logger) Warnf(format string, args ...interface{})

Warnf logs a warn-level message using Printf.

func (*Logger) Warning

func (logger *Logger) Warning(args ...interface{})

Warning logs a warn-level message using Println.

func (*Logger) Warningf

func (logger *Logger) Warningf(format string, args ...interface{})

Warningf logs a warn-level message using Printf.

func (*Logger) Warningln

func (logger *Logger) Warningln(args ...interface{})

Warningln logs a warn-level message using Println.

func (*Logger) Warnln

func (logger *Logger) Warnln(args ...interface{})

Warnln logs a warn-level message using Println.

func (*Logger) WithError

func (logger *Logger) WithError(err error) *Entry

WithError adds an error as single field to the log entry. All it does is call `WithError` for the given `error`.

func (*Logger) WithField

func (logger *Logger) WithField(key string, value interface{}) *Entry

WithField adds a field to the log entry, note that it doesn't log until you call Debug, Print, Info, Warn, Error, Fatal or Panic. It only creates a log entry. If you want multiple fields, use `WithFields`.

func (*Logger) WithFields

func (logger *Logger) WithFields(fields Fields) *Entry

WithFields adds a struct of fields to the log entry. All it does is call `WithField` for each `Field`.

func (*Logger) WithTime

func (logger *Logger) WithTime(t time.Time) *Entry

WithTime overrides the time of the log entry.

func (*Logger) Writer

func (logger *Logger) Writer() *io.PipeWriter

Writer returns an info-level log writer.

func (*Logger) WriterLevel

func (logger *Logger) WriterLevel(level stdLogger.Level) *io.PipeWriter

WriterLevel returns a log writer with a specified leve.

type MutexWrap

type MutexWrap struct {
	// contains filtered or unexported fields
}

MutexWrap contains the mutex lock.

func (*MutexWrap) Disable

func (mw *MutexWrap) Disable()

Disable disables mutex locking.

func (*MutexWrap) Lock

func (mw *MutexWrap) Lock()

Lock locks the mutex.

func (*MutexWrap) Unlock

func (mw *MutexWrap) Unlock()

Unlock unlocks the mutex.

type StdFormatter added in v0.1.10

type StdFormatter struct {
	// DataKey allows users to put all the log entry parameters into a
	// nested dictionary at a given key.
	DataKey string

	// DisableCaller disables caller data output.
	DisableCaller bool

	// DisableHostname disables hostname output.
	DisableHostname bool

	// DisableLevel disables level output.
	DisableLevel bool

	// DisableMessage disables message output.
	DisableMessage bool

	// DisableTimestamp disables timestamp output.
	DisableTimestamp bool

	// Enable full backtrace output.
	EnableTrace bool

	// EscapeHTML is a flag that notes whether HTML characters should be
	// escaped.
	EscapeHTML bool

	// FieldMap allows users to customize the names of keys for default
	// fields.
	//
	// For example:
	// 	formatter := &StdFormatter{FieldMap: FieldMap{
	//      LabelCaller: "@caller",
	//      LabelData:   "@data",
	//      LabelHost:   "@hostname",
	//      LabelLevel:  "@loglevel",
	//      LabelMsg:    "@message",
	//      LabelTime:   "@timestamp",
	// 	}}
	FieldMap FieldMap

	// TimestampFormat allows a custom timestamp format to be used.
	TimestampFormat string
}

StdFormatter formats logs into text.

func (*StdFormatter) Format added in v0.1.10

func (f *StdFormatter) Format(entry *Entry) ([]byte, error)

Format renders a single log entry

type StdLogger

type StdLogger interface {
	Print(...interface{})
	Printf(string, ...interface{})
	Println(...interface{})

	Fatal(...interface{})
	Fatalf(string, ...interface{})
	Fatalln(...interface{})

	Panic(...interface{})
	Panicf(string, ...interface{})
	Panicln(...interface{})
}

StdLogger is what your bdlm/log-enabled library should take, that way it'll accept a stdlib logger and a bdlm/log logger. There's no standard interface, this is the closest we get, unfortunately.

type Termios

type Termios unix.Termios

Termios contains the unix Termios value.

type TextFormatter

type TextFormatter struct {
	// DataKey allows users to put all the log entry parameters into a
	// nested dictionary at a given key.
	DataKey string

	// DisableCaller disables caller data output.
	DisableCaller bool

	// DisableHostname disables hostname output.
	DisableHostname bool

	// DisableLevel disables level output.
	DisableLevel bool

	// DisableMessage disables message output.
	DisableMessage bool

	// DisableTimestamp disables timestamp output.
	DisableTimestamp bool

	// DisableTTY disables TTY formatted output.
	DisableTTY bool

	// Enable full backtrace output.
	EnableTrace bool

	// EscapeHTML is a flag that notes whether HTML characters should be
	// escaped.
	EscapeHTML bool

	// ForceTTY forces TTY formatted output.
	ForceTTY bool

	// FieldMap allows users to customize the names of keys for default
	// fields.
	//
	// For example:
	// 	formatter := &TextFormatter{FieldMap: FieldMap{
	//      LabelCaller: "@caller",
	//      LabelData:   "@data",
	//      LabelHost:   "@hostname",
	//      LabelLevel:  "@loglevel",
	//      LabelMsg:    "@message",
	//      LabelTime:   "@timestamp",
	// 	}}
	FieldMap FieldMap

	// TimestampFormat allows a custom timestamp format to be used.
	TimestampFormat string

	sync.Once
	// contains filtered or unexported fields
}

TextFormatter formats logs into text.

func (*TextFormatter) Format

func (f *TextFormatter) Format(entry *Entry) ([]byte, error)

Format renders a single log entry

Directories

Path Synopsis
hooks
Package interceptor provides gRPC interceptors for common middleware requirements.
Package interceptor provides gRPC interceptors for common middleware requirements.
log
Package log contains interceptor/middleware helpers for logging.
Package log contains interceptor/middleware helpers for logging.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL