Help us shape the future of Go! Take the 2026 Go Developer Survey

log

package
v0.10.4 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 13, 2018 License: MIT Imports: 6 Imported by: 0

Documentation

Overview

Package log contains utilities for logging in a modular interface. This package can be used to wrap a third party library.

Index

Constants

View Source
const (
	LogOff   int = 0
	LogFatal int = 1
	LogError int = 2
	LogWarn  int = 3
	LogInfo  int = 4
	LogDebug int = 5
	LogTrace int = 6
	LogAll   int = 7
)

Logger level constants

Variables

View Source
var (
	ErrClientNil = errors.New("the client pointer was nil")
)

Errors used throughout the package.

Functions

This section is empty.

Types

type Logger

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

Logger is an object with support for levelled logging and modular components.

func (*Logger) Debugf

func (l *Logger) Debugf(message string, other ...interface{})

Debugf prints a debug message to the console.

func (*Logger) Debugln

func (l *Logger) Debugln(message string)

Debugln prints a debug message to the console.

func (*Logger) Errorf

func (l *Logger) Errorf(message string, other ...interface{})

Errorf prints an error message to the console.

func (*Logger) Errorln

func (l *Logger) Errorln(message string)

Errorln prints an error message to the console.

func (*Logger) Fatalf

func (l *Logger) Fatalf(message string, other ...interface{})

Fatalf prints a fatal message to the console. Does NOT cause panic.

func (*Logger) Fatalln

func (l *Logger) Fatalln(message string)

Fatalln prints a fatal message to the console. Does NOT cause panic.

func (*Logger) Infof

func (l *Logger) Infof(message string, other ...interface{})

Infof prints an information message to the console.

func (*Logger) Infoln

func (l *Logger) Infoln(message string)

Infoln prints an information message to the console.

func (*Logger) NewModule

func (l *Logger) NewModule(prefix string) Modular

NewModule creates a new logger object from the previous, using the same configuration, but adds an extra prefix to represent a submodule.

func (*Logger) Output

func (l *Logger) Output(calldepth int, s string) error

Output prints s to our output. Calldepth is ignored.

func (*Logger) Tracef

func (l *Logger) Tracef(message string, other ...interface{})

Tracef prints a trace message to the console.

func (*Logger) Traceln

func (l *Logger) Traceln(message string)

Traceln prints a trace message to the console.

func (*Logger) Warnf

func (l *Logger) Warnf(message string, other ...interface{})

Warnf prints a warning message to the console.

func (*Logger) Warnln

func (l *Logger) Warnln(message string)

Warnln prints a warning message to the console.

type LoggerConfig

type LoggerConfig struct {
	Prefix       string `json:"prefix" yaml:"prefix"`
	LogLevel     string `json:"log_level" yaml:"log_level"`
	AddTimeStamp bool   `json:"add_timestamp" yaml:"add_timestamp"`
	JSONFormat   bool   `json:"json_format" yaml:"json_format"`
}

LoggerConfig holds configuration options for a logger object.

func NewLoggerConfig

func NewLoggerConfig() LoggerConfig

NewLoggerConfig returns a logger configuration with the default values for each field.

type Modular

type Modular interface {
	NewModule(prefix string) Modular

	Fatalf(message string, other ...interface{})
	Errorf(message string, other ...interface{})
	Warnf(message string, other ...interface{})
	Infof(message string, other ...interface{})
	Debugf(message string, other ...interface{})
	Tracef(message string, other ...interface{})

	Fatalln(message string)
	Errorln(message string)
	Warnln(message string)
	Infoln(message string)
	Debugln(message string)
	Traceln(message string)

	Output(calldepth int, s string) error
}

Modular is a log printer that allows you to branch new modules.

func NewLogger

func NewLogger(stream io.Writer, config LoggerConfig) Modular

NewLogger creates and returns a new logger object.

Jump to

Keyboard shortcuts

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