log

package module

v0.2.0 Latest Latest Go to latest Published: Oct 17, 2021 License: Apache-2.0 Imports: 6 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/arcadium-dev/log

README ¶

log

Documentation ¶

Index ¶

Constants
Variables
type Format
type Level
type Logger
- func New(opts ...Option) (Logger, error)
type Option

Constants ¶

View Source

const (
	// LevelDebug provides the most verbose logging, allowing logs for debug, info,
	// warn, and error.
	LevelDebug Level = iota

	// LevelInfo is the default log level. It allows logs for info, warn, and
	// error.
	LevelInfo

	// LevelWarn is reserved for logging warnings and errors.
	LevelWarn

	// LevelError provides the least verbose logging, allowing logs only for
	// errors.
	LevelError

	// FormatJSON encodes each log entry as a single JSON object.
	FormatJSON Format = iota

	// FormatLogfmt encodes each log entry in logfmt format.
	FormatLogfmt

	// FormatNop will suppress logging output entirely.
	FormatNop
)

Variables ¶

View Source

var (
	// ErrInvalidLevel will be returned when the level given to the WirhLevel
	// option is invalid.
	ErrInvalidLevel = errors.New("Invalid Level")

	// ErrInvalidFormat will be returned when the format given to the WithFormat
	// options is invalid.
	ErrInvalidFormat = errors.New("Invvalid Format")

	// ErrInvalidOutput will be returned when the output writer given to WithOuput
	// is nil.
	ErrInvalidOutput = errors.New("Invalid Format")
)

Functions ¶

This section is empty.

Types ¶

type Format ¶

type Format uint

Format defines the output formats of the logger. Supported formats are FormatJSON (the default), FormatLogfmt, and FormatNop (no loggin).

type Level ¶

type Level uint

Level defines the logging levels available to the Logger, with a level of debug logging all message and error logging only error message.

type Logger ¶

type Logger interface {
	Debug(...interface{})
	Info(...interface{})
	Warn(...interface{})
	Error(...interface{})
}

Logger is the interface for all logging operations.

func New ¶

func New(opts ...Option) (Logger, error)

New returns a Logger.

type Option ¶

type Option interface {
	// contains filtered or unexported methods
}

Option provides for Logger configuration.

func WithFormat ¶

func WithFormat(format Format) Option

WithFormat allows the format to be configured. The default format is FormatJSON.

func WithLevel ¶

func WithLevel(level Level) Option

WithLevel allows the level to be configured. The default level is LevelInfo.

func WithOutput ¶

func WithOutput(writer io.Writer) Option

WithOutput allows the format to be configured. The default writer is os.Stderr.

Source Files ¶

View all Source files

log.go

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