wklog

package module

v0.0.0-...-e9f9ccb Latest Latest Go to latest Published: May 14, 2022 License: Apache-2.0 Imports: 12 Imported by: 1

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/rebirthmonkey/pkg

Documentation ¶

Index ¶

Constants
Variables
func Debug(args ...interface{})
func Debugf(format string, args ...interface{})
func Error(args ...interface{})
func Errorf(format string, args ...interface{})
func Fatal(args ...interface{})
func Fatalf(format string, args ...interface{})
func Info(args ...interface{})
func Infof(format string, args ...interface{})
func New(opts ...Option) *logger
func Panic(args ...interface{})
func Panicf(format string, args ...interface{})
func SetOptions(opts ...Option)
func StdLogger() *logger
func Warn(args ...interface{})
func Warnf(format string, args ...interface{})
func Writer() io.Writer
type Entry
type Formatter
type JsonFormatter
- func (f *JsonFormatter) Format(e *Entry) error
type Level
- func (l *Level) UnmarshalText(text []byte) error
type Option
- func WithDisableCaller(caller bool) Option
- func WithFormatter(formatter Formatter) Option
- func WithLevel(level Level) Option
- func WithOutput(output io.Writer) Option
- func WithStdLevel(level Level) Option
type TextFormatter
- func (f *TextFormatter) Format(e *Entry) error

Constants ¶

View Source

const (
	FmtEmptySeparate = ""
)

Variables ¶

View Source

var LevelNameMapping = map[Level]string{
	DebugLevel: "DEBUG",
	InfoLevel:  "INFO",
	WarnLevel:  "WARN",
	ErrorLevel: "ERROR",
	PanicLevel: "PANIC",
	FatalLevel: "FATAL",
}

log level string name mapping

Functions ¶

func Debug ¶

func Debug(args ...interface{})

std logger

func Debugf ¶

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

func Error ¶

func Error(args ...interface{})

func Errorf ¶

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

func Fatal ¶

func Fatal(args ...interface{})

func Fatalf ¶

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

func Info ¶

func Info(args ...interface{})

func Infof ¶

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

func New ¶

func New(opts ...Option) *logger

func Panic ¶

func Panic(args ...interface{})

func Panicf ¶

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

func SetOptions ¶

func SetOptions(opts ...Option)

func StdLogger ¶

func StdLogger() *logger

func Warn ¶

func Warn(args ...interface{})

func Warnf ¶

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

func Writer ¶

func Writer() io.Writer

Types ¶

type Entry ¶

type Entry struct {
	Buffer *bytes.Buffer
	Map    map[string]interface{}
	Level  Level
	Time   time.Time
	File   string
	Line   int
	Func   string
	Format string
	Args   []interface{}
	// contains filtered or unexported fields
}

type Formatter ¶

type Formatter interface {
	// Maybe in async goroutine
	// Please write the result to buffer
	Format(entry *Entry) error
}

type JsonFormatter ¶

type JsonFormatter struct {
	IgnoreBasicFields bool
}

func (*JsonFormatter) Format ¶

func (f *JsonFormatter) Format(e *Entry) error

type Level ¶

type Level uint8

log level

const (
	// DebugLevel logs are typically voluminous, and are usually disabled in
	// production.
	DebugLevel Level = iota
	// InfoLevel is the default logging priority.
	InfoLevel
	// WarnLevel logs are more important than Info, but don't need individual
	// human review.
	WarnLevel
	// ErrorLevel logs are high-priority. If an application is running smoothly,
	// it shouldn't generate any error-level logs.
	ErrorLevel
	// PanicLevel logs a message, then panics.
	PanicLevel
	// FatalLevel logs a message, then calls os.Exit(1).
	FatalLevel
)

const log level

func (*Level) UnmarshalText ¶

func (l *Level) UnmarshalText(text []byte) error

UnmarshalText unmarshals text to a level.

type Option ¶

type Option func(*options)

func WithDisableCaller ¶

func WithDisableCaller(caller bool) Option

func WithFormatter ¶

func WithFormatter(formatter Formatter) Option

func WithLevel ¶

func WithLevel(level Level) Option

func WithOutput ¶

func WithOutput(output io.Writer) Option

func WithStdLevel ¶

func WithStdLevel(level Level) Option

type TextFormatter ¶

type TextFormatter struct {
	IgnoreBasicFields bool
}

func (*TextFormatter) Format ¶

func (f *TextFormatter) Format(e *Entry) error

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
examples

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