fxlog

package

v1.13.2 Latest Latest Go to latest Published: Jun 22, 2021 License: MIT Imports: 4 Imported by: 0

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/bit2pixel/fx

Links

Open Source Insights

Documentation ¶

Index ¶

type Entry
- func Error(msg string, fields ...Field) Entry
- func Info(msg string, fields ...Field) Entry
- func (e Entry) WithStack(stack string) Entry
- func (e Entry) Write(logger Logger)
type Field
- func Err(value error) Field
- func F(key string, value interface{}) Field
type Level
type Logger
- func DefaultLogger(ws zapcore.WriteSyncer) Logger
type Spy

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Entry ¶ added in v1.13.2

type Entry struct {
	Level   Level
	Message string
	Fields  []Field
	Stack   string
}

Entry is an entry to be later serialized into zap message and fields.

func Error ¶ added in v1.13.2

func Error(msg string, fields ...Field) Entry

Error creates a logging Error entry.

func Info ¶ added in v1.13.2

func Info(msg string, fields ...Field) Entry

Info creates a logging Info entry.

func (Entry) WithStack ¶ added in v1.13.2

func (e Entry) WithStack(stack string) Entry

WithStack mutates an Entry to add a Stack field.

func (Entry) Write ¶ added in v1.13.2

func (e Entry) Write(logger Logger)

type Field ¶ added in v1.13.2

type Field struct {
	Key   string
	Value interface{}
}

Field defines a field used inside an internal logging Entry.

func Err ¶ added in v1.13.2

func Err(value error) Field

Err is a helper for error Fields.

func F ¶ added in v1.13.2

func F(key string, value interface{}) Field

F is a constructor for a Field.

type Level ¶ added in v1.13.2

type Level int

Level is the level of logging used by Logger.

const (
	// InfoLevel is Info logging level used to log messages via zap.
	InfoLevel Level = iota
	// ErrorLevel is Info logging level used to log messages via zap.
	ErrorLevel
)

type Logger ¶

type Logger interface {
	Log(entry Entry)
}

Logger defines interface used for logging.

func DefaultLogger ¶ added in v1.13.2

func DefaultLogger(ws zapcore.WriteSyncer) Logger

DefaultLogger constructs a Logger out of io.Writer.

type Spy ¶ added in v1.13.2

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

Spy is an Fx Printer that captures logged statements. It may be used in tests of Fx logs.

func (*Spy) Fields ¶ added in v1.13.2

func (s *Spy) Fields() []zap.Field

Fields returns all Fields members of entries.

func (*Spy) Log ¶ added in v1.13.2

func (s *Spy) Log(entry Entry)

Log append an Entry.

func (*Spy) Messages ¶ added in v1.13.2

func (s *Spy) Messages() []Entry

Messages returns a copy of all captured messages.

func (*Spy) Reset ¶ added in v1.13.2

func (s *Spy) Reset()

Reset clears all messages from the Spy.

func (*Spy) String ¶ added in v1.13.2

func (s *Spy) String() string

String returns all logged messages as a single newline-delimited string.

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
foovendor
sample.git

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