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

package log

import "github.com/phuslu/log"

Index

Package Files

console.go console_posix.go file.go grpc.go json.go level.go time_linux.go tsv.go

Variables

var DefaultLogger = Logger{
    Level:      DebugLevel,
    Caller:     0,
    TimeField:  "",
    TimeFormat: "",
    Timestamp:  false,
    HostField:  "",
    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 IsTerminal Uses

func IsTerminal(fd uintptr) bool

IsTerminal returns whether the given file descriptor is a terminal.

func Print Uses

func Print(v ...interface{})

Print sends a log event using debug level and no extra field. Arguments are handled in the manner of fmt.Print.

func Printf Uses

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

Printf sends a log event using debug level and no extra field. Arguments are handled in the manner of fmt.Printf.

type ConsoleWriter Uses

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

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

func (*ConsoleWriter) Write Uses

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

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 Warn Uses

func Warn() (e *Event)

Warn starts a new message with warning level.

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) 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) Caller Uses

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

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

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) 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) 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) 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.

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 megabytes 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
    // backup 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 backup files.
    HostName bool
    // contains filtered or unexported fields
}

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

FileWriter opens or creates the logfile on first Write. If the file exists and is less than MaxSize megabytes, FileWriter will open and append to that file. If the file exists and its size is >= MaxSize megabytes, the file is renamed by putting the current time in a timestamp in the name immediately before the file's extension (or the end of the filename if there's no extension). A new log file is then created using original filename.

Whenever a write would cause the current log file exceed MaxSize megabytes, the current file is closed, renamed, and a new log file created with the original name. Thus, the filename you give FileWriter is always the "current" log file.

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.FileWriter. 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 GrpcLogger Uses

type GrpcLogger struct {
    Logger Logger
}

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

func (*GrpcLogger) Error Uses

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

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

func (*GrpcLogger) Errorf Uses

func (l *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 (l *GrpcLogger) Errorln(args ...interface{})

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

func (*GrpcLogger) Fatal Uses

func (l *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 (l *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 (l *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 (l *GrpcLogger) Info(args ...interface{})

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

func (*GrpcLogger) Infof Uses

func (l *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 (l *GrpcLogger) Infoln(args ...interface{})

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

func (*GrpcLogger) V Uses

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

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

func (*GrpcLogger) Warning Uses

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

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

func (*GrpcLogger) Warningf Uses

func (l *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 (l *GrpcLogger) Warningln(args ...interface{})

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

type Level Uses

type Level uint32

Level defines log levels.

const (

    // DebugLevel defines debug log level.
    DebugLevel Level
    // InfoLevel defines info log level.
    InfoLevel
    // WarnLevel defines warn log level.
    WarnLevel
    // ErrorLevel defines error log level.
    ErrorLevel
    // FatalLevel defines fatal log level.
    FatalLevel
)

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.

type Logger Uses

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

    // Timestamp determines if time is formatted as an UNIX timestamp as integer.
    // If set, the value of TimeField and TimeFormat will be ignored.
    Timestamp bool

    // 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.
    TimeFormat string

    // HostField specifies the key for hostname in output if not empty
    HostField 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) Info Uses

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

Info starts a new message with info level.

func (*Logger) Print Uses

func (l *Logger) Print(v ...interface{})

Print sends a log event using debug level and no extra field. Arguments are handled in the manner of fmt.Print.

func (*Logger) Printf Uses

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

Printf sends a log event using debug level and no 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) 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 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 append the val as a bool 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

Package log imports 17 packages (graph). Updated 2020-05-30. Refresh now. Tools for package owners.