log

package

v0.0.0-...-7a50a3a Latest Latest Go to latest Published: Apr 27, 2024 License: AGPL-3.0, Apache-2.0, MIT Imports: 7 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

This section is empty.

View Source

var (
	AvailableFormats = Formats{FormatJSON, FormatConsole}
)

func New(debug bool, format Format) *zap.Logger

func NewDefault() *zap.Logger

NewDefault creates new default logger.

func NewFromOptions(o Options) *zap.Logger

type Format string

const (
	FormatJSON    Format = "JSON"
	FormatConsole Format = "Console"
)

func (f *Format) Set(s string) error

Set implements the cli.Value and flag.Value interfaces.

func (f *Format) String() string

String implements the cli.Value and flag.Value interfaces.

func (f *Format) Type() string

Type implements the pflag.Value interfaces.

type Formats []Format

func (f Formats) Contains(s Format) bool

func (f Formats) String() string

type Options struct {
	// Enable debug logs
	Debug bool
	// Log format (JSON or plain text)
	Format Format
}

Options exports options struct to be used by cmd's.

var (
	Logger         *zap.SugaredLogger
	DefaultOptions Options
)

func NewDefaultOptions() Options

func (o *Options) AddFlags(fs *flag.FlagSet)

func (o *Options) AddPFlags(fs *pflag.FlagSet)

func (o *Options) Validate() error