log: github.com/phuslu/log Index | Files

package log

import "github.com/phuslu/log"

Index

Package Files

buffer.go console.go console_posix.go file.go goid.go grpc.go journal.go level.go logger.go logr.go std.go sugar.go time_linux.go tsv.go

Constants

const (
    // TimeFormatUnix defines a time format that makes time fields to be
    // serialized as Unix timestamp integers.
    TimeFormatUnix = "\x01"

    // TimeFormatUnixMs defines a time format that makes time fields to be
    // serialized as Unix timestamp integers in milliseconds.
    TimeFormatUnixMs = "\x02"
)
const ColorTemplate = "" /* 552 byte string literal not displayed */

ColorTemplate provides a pre-defined text/template for console color output

type . struct {
    Time     string    // "2019-07-10T05:35:54.277Z"
    Level    string    // "info"
    Caller   string    // "prog.go:42"
    Goid     string    // "123"
    Message  string    // "a structure message"
    Stack    string    // "<stack string>"
    KeyValue []struct {
        Key   string       // "foo"
        Value interface{}  // "bar"
    }
}

A quick example is

log.DefaultLogger.Writer = &log.ConsoleWriter{
    Template: template.Must(template.New("").Funcs(log.ColorFuncMap).Parse(log.ColorTemplate)),
    Writer:   os.Stderr,
}

Note: use [sprig](https://github.com/Masterminds/sprig) to provides more template functions.

Variables

var ColorFuncMap = template.FuncMap{
    "black":     func(s string) string { return "\x1b[30m" + s + "\x1b[0m" },
    "red":       func(s string) string { return "\x1b[31m" + s + "\x1b[0m" },
    "green":     func(s string) string { return "\x1b[32m" + s + "\x1b[0m" },
    "yellow":    func(s string) string { return "\x1b[33m" + s + "\x1b[0m" },
    "blue":      func(s string) string { return "\x1b[34m" + s + "\x1b[0m" },
    "magenta":   func(s string) string { return "\x1b[35m" + s + "\x1b[0m" },
    "cyan":      func(s string) string { return "\x1b[36m" + s + "\x1b[0m" },
    "white":     func(s string) string { return "\x1b[37m" + s + "\x1b[0m" },
    "gray":      func(s string) string { return "\x1b[90m" + s + "\x1b[0m" },
    "contains":  strings.Contains,
    "endsswith": strings.HasSuffix,
    "low":       strings.ToLower,
    "match":     path.Match,
    "quote":     strconv.Quote,
    "statswith": strings.HasPrefix,
    "title":     strings.ToTitle,
    "upper":     strings.ToUpper,
}

ColorFuncMap provides a pre-defined template functions for color string

var DefaultLogger = Logger{
    Level:      DebugLevel,
    Caller:     0,
    TimeField:  "",
    TimeFormat: "",
    Writer:     os.Stderr,
}

DefaultLogger is the global logger.

func Fastrandn Uses

func Fastrandn(x uint32) uint32

Fastrandn returns a pseudorandom uint32 in [0,n).

go:noescape go:linkname Fastrandn runtime.fastrandn

func Flush Uses

func Flush(writer io.Writer) (err error)

Flush writes any buffered data to the underlying io.Writer.

func Goid Uses

func Goid() int64

Goid returns the current goroutine id. It exactly matches goroutine id of the stack trace.

func IsTerminal Uses

func IsTerminal(fd uintptr) bool

IsTerminal returns whether the given file descriptor is a terminal.

func Printf Uses

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

Printf sends a log event without extra field. Arguments are handled in the manner of fmt.Printf.

type BufferWriter Uses

type BufferWriter struct {
    // BufferSize is the size in bytes of the buffer before it gets flushed.
    BufferSize int

    // FlushDuration is the period of the writer flush duration
    FlushDuration time.Duration

    // Writer specifies the writer of output.
    Writer io.Writer
    // contains filtered or unexported fields
}

BufferWriter is an io.WriteCloser that writes with fixed size buffer.

func (*BufferWriter) Close Uses

func (w *BufferWriter) Close() (err error)

Close implements io.Closer, and closes the underlaying Writer.

func (*BufferWriter) Flush Uses

func (w *BufferWriter) Flush() (err error)

Flush flushes all pending log I/O.

func (*BufferWriter) Write Uses

func (w *BufferWriter) Write(p []byte) (n int, err error)

Write implements io.Writer. If a write would cause the log buffer to be larger than Size, the buffer is written to the underlaying Writer and cleared.

type ConsoleWriter Uses

type ConsoleWriter struct {
    // ColorOutput determines if used colorized output.
    ColorOutput bool

    // Deprecated: Use ColorOutput instead.
    ANSIColor bool

    // QuoteString determines if quoting string values.
    QuoteString bool

    // EndWithMessage determines if output message in the end.
    EndWithMessage bool

    // TimeField specifies the field name for time in output.
    TimeField string

    // Template determines console output template if not empty.
    // see https://github.com/phuslu/log/blob/master/console.go#L328
    // for available Template Arguments.
    Template *template.Template

    // Writer is the output destination. using os.Stderr if empty.
    Writer io.Writer
}

ConsoleWriter parses the JSON input and writes it in an (optionally) colorized, human-friendly format to Writer.

func (*ConsoleWriter) Write Uses

func (w *ConsoleWriter) Write(p []byte) (int, error)

type Context Uses

type Context []byte

Context represents contextual fields.

type Event Uses

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

Event represents a log event. It is instanced by one of the level method of Logger and finalized by the Msg or Msgf method.

func Debug Uses

func Debug() (e *Event)

Debug starts a new message with debug level.

func Error Uses

func Error() (e *Event)

Error starts a new message with error level.

func Fatal Uses

func Fatal() (e *Event)

Fatal starts a new message with fatal level.

func Info Uses

func Info() (e *Event)

Info starts a new message with info level.

func NewContext Uses

func NewContext(dst []byte) (e *Event)

NewContext starts a new contextual event.

func Panic Uses

func Panic() (e *Event)

Panic starts a new message with panic level.

func Trace Uses

func Trace() (e *Event)

Trace starts a new message with trace level.

func Warn Uses

func Warn() (e *Event)

Warn starts a new message with warning level.

func (*Event) AnErr Uses

func (e *Event) AnErr(key string, err error) *Event

AnErr adds the field key with serialized err to the logger context.

func (*Event) Bool Uses

func (e *Event) Bool(key string, b bool) *Event

Bool append append the val as a bool to the event.

func (*Event) Bools Uses

func (e *Event) Bools(key string, b []bool) *Event

Bools adds the field key with val as a []bool to the event.

func (*Event) Byte Uses

func (e *Event) Byte(key string, val byte) *Event

Byte adds the field key with val as a byte to the event.

func (*Event) Bytes Uses

func (e *Event) Bytes(key string, val []byte) *Event

Bytes adds the field key with val as a string to the event.

func (*Event) BytesOrNil Uses

func (e *Event) BytesOrNil(key string, val []byte) *Event

BytesOrNil adds the field key with val as a string or nil to the event.

func (*Event) Caller Uses

func (e *Event) Caller(depth int) *Event

Caller adds the file:line of the "caller" key.

func (*Event) Context Uses

func (e *Event) Context(ctx Context) *Event

Context sends the contextual fields to event.

func (*Event) Dict Uses

func (e *Event) Dict(key string, ctx Context) *Event

Dict sends the contextual fields with key to event.

func (*Event) Discard Uses

func (e *Event) Discard() *Event

Discard disables the event so Msg(f) won't print it.

func (*Event) Dur Uses

func (e *Event) Dur(key string, d time.Duration) *Event

Dur adds the field key with duration d to the event.

func (*Event) Durs Uses

func (e *Event) Durs(key string, d []time.Duration) *Event

Durs adds the field key with val as a []time.Duration to the event.

func (*Event) Enabled Uses

func (e *Event) Enabled() bool

Enabled return false if the event is going to be filtered out by log level.

func (*Event) Err Uses

func (e *Event) Err(err error) *Event

Err adds the field "error" with serialized err to the event.

func (*Event) Errs Uses

func (e *Event) Errs(key string, errs []error) *Event

Errs adds the field key with errs as an array of serialized errors to the event.

func (*Event) Float32 Uses

func (e *Event) Float32(key string, f float32) *Event

Float32 adds the field key with f as a float32 to the event.

func (*Event) Float64 Uses

func (e *Event) Float64(key string, f float64) *Event

Float64 adds the field key with f as a float64 to the event.

func (*Event) Floats32 Uses

func (e *Event) Floats32(key string, f []float32) *Event

Floats32 adds the field key with f as a []float32 to the event.

func (*Event) Floats64 Uses

func (e *Event) Floats64(key string, f []float64) *Event

Floats64 adds the field key with f as a []float64 to the event.

func (*Event) GoStringer Uses

func (e *Event) GoStringer(key string, val fmt.GoStringer) *Event

GoStringer adds the field key with val.GoStringer() to the event.

func (*Event) Hex Uses

func (e *Event) Hex(key string, val []byte) *Event

Hex adds the field key with val as a hex string to the event.

func (*Event) IPAddr Uses

func (e *Event) IPAddr(key string, ip net.IP) *Event

IPAddr adds IPv4 or IPv6 Address to the event

func (*Event) IPPrefix Uses

func (e *Event) IPPrefix(key string, pfx net.IPNet) *Event

IPPrefix adds IPv4 or IPv6 Prefix (address and mask) to the event

func (*Event) Int Uses

func (e *Event) Int(key string, i int) *Event

Int adds the field key with i as a int to the event.

func (*Event) Int16 Uses

func (e *Event) Int16(key string, i int16) *Event

Int16 adds the field key with i as a int16 to the event.

func (*Event) Int32 Uses

func (e *Event) Int32(key string, i int32) *Event

Int32 adds the field key with i as a int32 to the event.

func (*Event) Int64 Uses

func (e *Event) Int64(key string, i int64) *Event

Int64 adds the field key with i as a int64 to the event.

func (*Event) Int8 Uses

func (e *Event) Int8(key string, i int8) *Event

Int8 adds the field key with i as a int8 to the event.

func (*Event) Interface Uses

func (e *Event) Interface(key string, i interface{}) *Event

Interface adds the field key with i marshaled using reflection.

func (*Event) MACAddr Uses

func (e *Event) MACAddr(key string, ha net.HardwareAddr) *Event

MACAddr adds MAC address to the event

func (*Event) Msg Uses

func (e *Event) Msg(msg string)

Msg sends the event with msg added as the message field if not empty.

func (*Event) Msgf Uses

func (e *Event) Msgf(format string, v ...interface{})

Msgf sends the event with formatted msg added as the message field if not empty.

func (*Event) RawJSON Uses

func (e *Event) RawJSON(key string, b []byte) *Event

RawJSON adds already encoded JSON to the log line under key.

func (*Event) RawJSONStr Uses

func (e *Event) RawJSONStr(key string, s string) *Event

RawJSONStr adds already encoded JSON String to the log line under key.

func (*Event) Stack Uses

func (e *Event) Stack(all bool) *Event

Stack enables stack trace printing for the error passed to Err().

func (*Event) Str Uses

func (e *Event) Str(key string, val string) *Event

Str adds the field key with val as a string to the event.

func (*Event) Stringer Uses

func (e *Event) Stringer(key string, val fmt.Stringer) *Event

Stringer adds the field key with val.String() to the event.

func (*Event) Strs Uses

func (e *Event) Strs(key string, vals []string) *Event

Strs adds the field key with vals as a []string to the event.

func (*Event) Time Uses

func (e *Event) Time(key string, t time.Time) *Event

Time append append t formated as string using time.RFC3339Nano.

func (*Event) TimeDiff Uses

func (e *Event) TimeDiff(key string, t time.Time, start time.Time) *Event

TimeDiff adds the field key with positive duration between time t and start. If time t is not greater than start, duration will be 0. Duration format follows the same principle as Dur().

func (*Event) TimeFormat Uses

func (e *Event) TimeFormat(key string, timefmt string, t time.Time) *Event

TimeFormat append append t formated as string using timefmt.

func (*Event) Uint16 Uses

func (e *Event) Uint16(key string, i uint16) *Event

Uint16 adds the field key with i as a uint16 to the event.

func (*Event) Uint32 Uses

func (e *Event) Uint32(key string, i uint32) *Event

Uint32 adds the field key with i as a uint32 to the event.

func (*Event) Uint64 Uses

func (e *Event) Uint64(key string, i uint64) *Event

Uint64 adds the field key with i as a uint64 to the event.

func (*Event) Uint8 Uses

func (e *Event) Uint8(key string, i uint8) *Event

Uint8 adds the field key with i as a uint8 to the event.

func (*Event) Value Uses

func (e *Event) Value() Context

Value builds the contextual fields.

func (*Event) Xid Uses

func (e *Event) Xid(key string, xid [12]byte) *Event

Xid adds the field key with xid.ID as a base32 string to the event.

type FileWriter Uses

type FileWriter struct {
    // Filename is the file to write logs to.  Backup log files will be retained
    // in the same directory.
    Filename string

    // MaxSize is the maximum size in bytes of the log file before it gets rotated.
    MaxSize int64

    // MaxBackups is the maximum number of old log files to retain.  The default
    // is to retain all old log files
    MaxBackups int

    // FileMode represents the file's mode and permission bits.  The default
    // mode is 0644
    FileMode os.FileMode

    // LocalTime determines if the time used for formatting the timestamps in
    // log files is the computer's local time.  The default is to use UTC time.
    LocalTime bool

    // HostName determines if the hostname used for formatting in log files.
    HostName bool

    // ProcessID determines if the pid used for formatting in log files.
    ProcessID bool
    // contains filtered or unexported fields
}

FileWriter is an io.WriteCloser that writes to the specified filename.

Backups use the log file name given to FileWriter, in the form `name.timestamp.ext` where name is the filename without the extension, timestamp is the time at which the log was rotated formatted with the time.Time format of `2006-01-02T15-04-05` and the extension is the original extension. For example, if your FileWriter.Filename is `/var/log/foo/server.log`, a backup created at 6:30pm on Nov 11 2016 would use the filename `/var/log/foo/server.2016-11-04T18-30-00.log`

Cleaning Up Old Log Files

Whenever a new logfile gets created, old log files may be deleted. The most recent files according to the encoded timestamp will be retained, up to a number equal to MaxBackups (or all of them if MaxBackups is 0). Any files with an encoded timestamp older than MaxAge days are deleted, regardless of MaxBackups. Note that the time encoded in the timestamp is the rotation time, which may differ from the last time that file was written to.

func (*FileWriter) Close Uses

func (w *FileWriter) Close() (err error)

Close implements io.Closer, and closes the current logfile.

func (*FileWriter) Rotate Uses

func (w *FileWriter) Rotate() (err error)

Rotate causes Logger to close the existing log file and immediately create a new one. This is a helper function for applications that want to initiate rotations outside of the normal rotation rules, such as in response to SIGHUP. After rotating, this initiates compression and removal of old log files according to the configuration.

func (*FileWriter) Write Uses

func (w *FileWriter) Write(p []byte) (n int, err error)

Write implements io.Writer. If a write would cause the log file to be larger than MaxSize, the file is closed, renamed to include a timestamp of the current time, and a new log file is created using the original log file name. If the length of the write is greater than MaxSize, an error is returned.

type Flusher Uses

type Flusher interface {
    // Flush sends any buffered data to the output.
    Flush() error
}

The Flusher interface is implemented by BufferWriters that allow an Logger to flush buffered data to the output.

type GrpcLogger Uses

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

GrpcLogger implements methods to satisfy interface google.golang.org/grpc/grpclog.LoggerV2.

func (*GrpcLogger) Error Uses

func (g *GrpcLogger) Error(args ...interface{})

Error logs to ERROR log. Arguments are handled in the manner of fmt.Print.

func (*GrpcLogger) Errorf Uses

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

Errorf logs to ERROR log. Arguments are handled in the manner of fmt.Printf.

func (*GrpcLogger) Errorln Uses

func (g *GrpcLogger) Errorln(args ...interface{})

Errorln logs to ERROR log. Arguments are handled in the manner of fmt.Println.

func (*GrpcLogger) Fatal Uses

func (g *GrpcLogger) Fatal(args ...interface{})

Fatal logs to ERROR log. Arguments are handled in the manner of fmt.Print. gRPC ensures that all Fatal logs will exit with os.Exit(1). Implementations may also call os.Exit() with a non-zero exit code.

func (*GrpcLogger) Fatalf Uses

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

Fatalf logs to ERROR log. Arguments are handled in the manner of fmt.Printf. gRPC ensures that all Fatal logs will exit with os.Exit(1). Implementations may also call os.Exit() with a non-zero exit code.

func (*GrpcLogger) Fatalln Uses

func (g *GrpcLogger) Fatalln(args ...interface{})

Fatalln logs to ERROR log. Arguments are handled in the manner of fmt.Println. gRPC ensures that all Fatal logs will exit with os.Exit(1). Implementations may also call os.Exit() with a non-zero exit code.

func (*GrpcLogger) Info Uses

func (g *GrpcLogger) Info(args ...interface{})

Info logs to INFO log. Arguments are handled in the manner of fmt.Print.

func (*GrpcLogger) Infof Uses

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

Infof logs to INFO log. Arguments are handled in the manner of fmt.Printf.

func (*GrpcLogger) Infoln Uses

func (g *GrpcLogger) Infoln(args ...interface{})

Infoln logs to INFO log. Arguments are handled in the manner of fmt.Println.

func (*GrpcLogger) V Uses

func (g *GrpcLogger) V(level int) bool

V reports whether verbosity level l is at least the requested verbose leveg.

func (*GrpcLogger) Warning Uses

func (g *GrpcLogger) Warning(args ...interface{})

Warning logs to WARNING log. Arguments are handled in the manner of fmt.Print.

func (*GrpcLogger) Warningf Uses

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

Warningf logs to WARNING log. Arguments are handled in the manner of fmt.Printf.

func (*GrpcLogger) Warningln Uses

func (g *GrpcLogger) Warningln(args ...interface{})

Warningln logs to WARNING log. Arguments are handled in the manner of fmt.Println.

type JournalWriter Uses

type JournalWriter struct {
    // journal socket, using `/run/systemd/journal/socket` if empty.
    JournalSocket string

    // TimeField specifies the field name for time in output.
    TimeField string
    // contains filtered or unexported fields
}

JournalWriter is an io.WriteCloser that writes logs to journald.

func (*JournalWriter) Close Uses

func (w *JournalWriter) Close() (err error)

Write implements io.Closer.

func (*JournalWriter) Write Uses

func (w *JournalWriter) Write(p []byte) (n int, err error)

Write implements io.Writer.

type Level Uses

type Level int32

Level defines log levels.

const (
    // TraceLevel defines trace log level.
    TraceLevel Level = -1
    // DebugLevel defines debug log level.
    DebugLevel Level = 0
    // InfoLevel defines info log level.
    InfoLevel Level = 1
    // WarnLevel defines warn log level.
    WarnLevel Level = 2
    // ErrorLevel defines error log level.
    ErrorLevel Level = 3
    // FatalLevel defines fatal log level.
    FatalLevel Level = 4
    // PanicLevel defines panic log level.
    PanicLevel Level = 5
)

func ParseLevel Uses

func ParseLevel(s string) (level Level)

ParseLevel converts a level string into a log Level value. returns an error if the input string does not match known values.

func (Level) First Uses

func (l Level) First() (s string)

First return first upper letter of Level

func (Level) Lower Uses

func (l Level) Lower() (s string)

Lower return lowe case string of Level

func (Level) Three Uses

func (l Level) Three() (s string)

Three return three letters of Level

func (Level) Title Uses

func (l Level) Title() (s string)

Title return title case string of Level

func (Level) Upper Uses

func (l Level) Upper() (s string)

Upper return upper case string of Level

type Logger Uses

type Logger struct {
    // Level defines log levels.
    Level Level

    // Caller determines if adds the file:line of the "caller" key.
    Caller int

    // TimeField defines the time filed name in output.  It uses "time" in if empty.
    TimeField string

    // TimeFormat specifies the time format in output. It uses time.RFC3389 in if empty.
    // If set with `TimeFormatUnix`, `TimeFormatUnixMs`, times are formated as UNIX timestamp.
    TimeFormat string

    // Writer specifies the writer of output. It uses os.Stderr in if empty.
    Writer io.Writer
}

A Logger represents an active logging object that generates lines of JSON output to an io.Writer.

func (*Logger) Debug Uses

func (l *Logger) Debug() (e *Event)

Debug starts a new message with debug level.

func (*Logger) Error Uses

func (l *Logger) Error() (e *Event)

Error starts a new message with error level.

func (*Logger) Fatal Uses

func (l *Logger) Fatal() (e *Event)

Fatal starts a new message with fatal level.

func (*Logger) Grpc Uses

func (l *Logger) Grpc(context Context) (g *GrpcLogger)

Grpc wraps the Logger to provide a LoggerV2 logger

func (*Logger) Info Uses

func (l *Logger) Info() (e *Event)

Info starts a new message with info level.

func (*Logger) Logr Uses

func (l *Logger) Logr(context Context) *LogrLogger

Logr wraps the Logger to provide a logr logger

func (*Logger) Panic Uses

func (l *Logger) Panic() (e *Event)

Panic starts a new message with panic level.

func (*Logger) Printf Uses

func (l *Logger) Printf(format string, v ...interface{})

Printf sends a log event without extra field. Arguments are handled in the manner of fmt.Printf.

func (*Logger) SetLevel Uses

func (l *Logger) SetLevel(level Level)

SetLevel changes logger default level.

func (*Logger) Std Uses

func (l *Logger) Std(level Level, context Context, prefix string, flag int) *stdLog.Logger

Std wraps the Logger to provide *stdLog.Logger

func (*Logger) Sugar Uses

func (l *Logger) Sugar(context Context) (s *SugaredLogger)

Sugar wraps the Logger to provide a more ergonomic, but a little bit slower, API. Sugaring a Logger is quite inexpensive, so it's reasonable for a single application to use both Loggers and SugaredLoggers, converting between them on the boundaries of performance-sensitive code.

func (*Logger) Trace Uses

func (l *Logger) Trace() (e *Event)

Trace starts a new message with trace level.

func (*Logger) Warn Uses

func (l *Logger) Warn() (e *Event)

Warn starts a new message with warning level.

func (*Logger) WithLevel Uses

func (l *Logger) WithLevel(level Level) (e *Event)

WithLevel starts a new message with level.

type LogrLogger Uses

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

LogrLogger implements methods to satisfy interface github.com/go-logr/logr.Logger.

func (*LogrLogger) Enabled Uses

func (l *LogrLogger) Enabled() bool

Enabled tests whether this Logger is enabled. For example, commandline flags might be used to set the logging verbosity and disable some info logs.

func (*LogrLogger) Error Uses

func (l *LogrLogger) Error(err error, msg string, keysAndValues ...interface{})

Error logs an error, with the given message and key/value pairs as context. It functions similarly to calling Info with the "error" named value, but may have unique behavior, and should be preferred for logging errors (see the package documentations for more information).

The msg field should be used to add context to any underlying error, while the err field should be used to attach the actual error that triggered this log line, if present.

func (*LogrLogger) Info Uses

func (l *LogrLogger) Info(msg string, keysAndValues ...interface{})

Info logs a non-error message with the given key/value pairs as context.

The msg argument should be used to add some constant description to the log line. The key/value pairs can then be used to add additional variable information. The key/value pairs should alternate string keys and arbitrary values.

func (*LogrLogger) V Uses

func (l *LogrLogger) V(level int) *LogrLogger

V returns an Logger value for a specific verbosity level, relative to this Logger. In other words, V values are additive. V higher verbosity level means a log message is less important. It's illegal to pass a log level less than zero.

func (*LogrLogger) WithName Uses

func (l *LogrLogger) WithName(name string) *LogrLogger

WithName adds a new element to the logger's name. Successive calls with WithName continue to append suffixes to the logger's name. It's strongly recommended that name segments contain only letters, digits, and hyphens (see the package documentation for more information).

func (*LogrLogger) WithValues Uses

func (l *LogrLogger) WithValues(keysAndValues ...interface{}) *LogrLogger

WithValues adds some key-value pairs of context to a logger. See Info for documentation on how key/value pairs work.

type SugaredLogger Uses

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

A SugaredLogger wraps the base Logger functionality in a slower, but less verbose, API. Any Logger can be converted to a SugaredLogger with its Sugar method.

Unlike the Logger, the SugaredLogger doesn't insist on structured logging. For each log level, it exposes three methods: one for loosely-typed structured logging, one for println-style formatting, and one for printf-style formatting.

func (*SugaredLogger) Debug Uses

func (s *SugaredLogger) Debug(args ...interface{})

Debug uses fmt.Sprint to construct and log a message.

func (*SugaredLogger) Debugf Uses

func (s *SugaredLogger) Debugf(template string, args ...interface{})

Debugf uses fmt.Sprintf to log a templated message.

func (*SugaredLogger) Debugw Uses

func (s *SugaredLogger) Debugw(msg string, keysAndValues ...interface{})

Debugw logs a message with some additional context.

func (*SugaredLogger) Error Uses

func (s *SugaredLogger) Error(args ...interface{})

Error uses fmt.Sprint to construct and log a message.

func (*SugaredLogger) Errorf Uses

func (s *SugaredLogger) Errorf(template string, args ...interface{})

Errorf uses fmt.Sprintf to log a templated message.

func (*SugaredLogger) Errorw Uses

func (s *SugaredLogger) Errorw(msg string, keysAndValues ...interface{})

Errorw logs a message with some additional context.

func (*SugaredLogger) Fatal Uses

func (s *SugaredLogger) Fatal(args ...interface{})

Fatal uses fmt.Sprint to construct and log a message.

func (*SugaredLogger) Fatalf Uses

func (s *SugaredLogger) Fatalf(template string, args ...interface{})

Fatalf uses fmt.Sprintf to log a templated message.

func (*SugaredLogger) Fatalw Uses

func (s *SugaredLogger) Fatalw(msg string, keysAndValues ...interface{})

Fatalw logs a message with some additional context.

func (*SugaredLogger) Info Uses

func (s *SugaredLogger) Info(args ...interface{})

Info uses fmt.Sprint to construct and log a message.

func (*SugaredLogger) Infof Uses

func (s *SugaredLogger) Infof(template string, args ...interface{})

Infof uses fmt.Sprintf to log a templated message.

func (*SugaredLogger) Infow Uses

func (s *SugaredLogger) Infow(msg string, keysAndValues ...interface{})

Infow logs a message with some additional context.

func (*SugaredLogger) Level Uses

func (s *SugaredLogger) Level(level Level) *SugaredLogger

Level creates a child logger with the minimum accepted level set to level.

func (*SugaredLogger) Log Uses

func (s *SugaredLogger) Log(keysAndValues ...interface{}) error

Log sends a log event with extra fields.

func (*SugaredLogger) Panic Uses

func (s *SugaredLogger) Panic(args ...interface{})

Panic uses fmt.Sprint to construct and log a message.

func (*SugaredLogger) Panicf Uses

func (s *SugaredLogger) Panicf(template string, args ...interface{})

Panicf uses fmt.Sprintf to log a templated message.

func (*SugaredLogger) Panicw Uses

func (s *SugaredLogger) Panicw(msg string, keysAndValues ...interface{})

Panicw logs a message with some additional context.

func (*SugaredLogger) Print Uses

func (s *SugaredLogger) Print(args ...interface{})

Print sends a log event without extra field. Arguments are handled in the manner of fmt.Print.

func (*SugaredLogger) Printf Uses

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

Printf sends a log event without extra field. Arguments are handled in the manner of fmt.Printf.

func (*SugaredLogger) Println Uses

func (s *SugaredLogger) Println(args ...interface{})

Println sends a log event without extra field. Arguments are handled in the manner of fmt.Print.

func (*SugaredLogger) Warn Uses

func (s *SugaredLogger) Warn(args ...interface{})

Warn uses fmt.Sprint to construct and log a message.

func (*SugaredLogger) Warnf Uses

func (s *SugaredLogger) Warnf(template string, args ...interface{})

Warnf uses fmt.Sprintf to log a templated message.

func (*SugaredLogger) Warnw Uses

func (s *SugaredLogger) Warnw(msg string, keysAndValues ...interface{})

Warnw logs a message with some additional context.

type TSVEvent Uses

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

TSVEvent represents a tsv log event. It is instanced by one of TSVLogger and finalized by the Msg method.

func (*TSVEvent) Bool Uses

func (e *TSVEvent) Bool(b bool) *TSVEvent

Bool append the b as a bool to the event.

func (*TSVEvent) Byte Uses

func (e *TSVEvent) Byte(b byte) *TSVEvent

Byte append the b as a byte to the event.

func (*TSVEvent) Bytes Uses

func (e *TSVEvent) Bytes(val []byte) *TSVEvent

Bytes adds a bytes as string to the event.

func (*TSVEvent) Float32 Uses

func (e *TSVEvent) Float32(f float32) *TSVEvent

Float32 adds a float32 to the event.

func (*TSVEvent) Float64 Uses

func (e *TSVEvent) Float64(f float64) *TSVEvent

Float64 adds a float64 to the event.

func (*TSVEvent) IPAddr Uses

func (e *TSVEvent) IPAddr(ip net.IP) *TSVEvent

IPAddr adds IPv4 or IPv6 Address to the event

func (*TSVEvent) Int Uses

func (e *TSVEvent) Int(i int) *TSVEvent

Int adds a int to the event.

func (*TSVEvent) Int16 Uses

func (e *TSVEvent) Int16(i int16) *TSVEvent

Int16 adds a int16 to the event.

func (*TSVEvent) Int32 Uses

func (e *TSVEvent) Int32(i int32) *TSVEvent

Int32 adds a int32 to the event.

func (*TSVEvent) Int64 Uses

func (e *TSVEvent) Int64(i int64) *TSVEvent

Int64 adds a int64 to the event.

func (*TSVEvent) Int8 Uses

func (e *TSVEvent) Int8(i int8) *TSVEvent

Int8 adds a int8 to the event.

func (*TSVEvent) Msg Uses

func (e *TSVEvent) Msg()

Msg sends the event.

func (*TSVEvent) Str Uses

func (e *TSVEvent) Str(val string) *TSVEvent

Str adds a string to the event.

func (*TSVEvent) Timestamp Uses

func (e *TSVEvent) Timestamp() *TSVEvent

Timestamp adds the current time as UNIX timestamp

func (*TSVEvent) TimestampMS Uses

func (e *TSVEvent) TimestampMS() *TSVEvent

TimestampMS adds the current time with milliseconds as UNIX timestamp

func (*TSVEvent) Uint16 Uses

func (e *TSVEvent) Uint16(i uint16) *TSVEvent

Uint16 adds a uint16 to the event.

func (*TSVEvent) Uint32 Uses

func (e *TSVEvent) Uint32(i uint32) *TSVEvent

Uint32 adds a uint32 to the event.

func (*TSVEvent) Uint64 Uses

func (e *TSVEvent) Uint64(i uint64) *TSVEvent

Uint64 adds a uint64 to the event.

func (*TSVEvent) Uint8 Uses

func (e *TSVEvent) Uint8(i uint8) *TSVEvent

Uint8 adds a uint8 to the event.

type TSVLogger Uses

type TSVLogger struct {
    Separator byte
    Writer    io.Writer
}

TSVLogger represents an active logging object that generates lines of TSV output to an io.Writer.

func (*TSVLogger) New Uses

func (l *TSVLogger) New() (e *TSVEvent)

New starts a new tsv message.

type Writer Uses

type Writer = FileWriter

Writer is an alias for FileWriter

Deprecated: Use FileWriter instead.

Package log imports 22 packages (graph). Updated 2020-08-08. Refresh now. Tools for package owners.