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

alog

package module
v0.0.0-...-a3dcc96 Latest Latest
Warning

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

 Go to latest Published: May 12, 2022 License: BSD-3-Clause, ISC Imports: 16 Imported by: 0

Documentation

Overview

Package log implements a simple logging package. It defines a type, Logger, with methods for formatting output. It also has a predefined 'standard' Logger accessible through helper functions Print[f|ln], Fatal[f|ln], and Panic[f|ln], which are easier to use than creating a Logger manually. That logger writes to standard error and prints the date and time of each logged message. The Fatal functions call os.Exit(1) after writing the log message. The Panic functions call panic after writing the log message.

Index

Constants

View Source 
const (
	// Bits or'ed together to control what's printed.
	// There is no control over the order they appear (the order listed
	// here) or the format they present (as described in the comments).
	// The prefix is followed by a colon only when Llongfile or Lshortfile
	// is specified.
	// For example, flags Ldate | Ltime (or LstdFlags) produce,
	//  2009/01/23 01:23:23 message
	// while flags Ldate | Ltime | Lmicroseconds | Llongfile produce,
	//  2009/01/23 01:23:23.123123 /a/b/c/d.go:23: message
	Ldate         = 1 << iota // the date in the local time zone: 2009/01/23
	Ltime                     // the time in the local time zone: 01:23:23
	Lmicroseconds             // microsecond resolution: 01:23:23.123123.  assumes Ltime.
	Llongfile                 // full file name and line number: /a/b/c/d.go:23
	Lshortfile                // final file name element and line number: d.go:23. overrides Llongfile
	LUTC                      // if Ldate or Ltime is set, use UTC rather than the local time zone
	Lelapsed                  // elapsed time since this line was first started
	Lisodate
	LstdFlags = Ldate | Ltime // initial values for the standard logger
)

These flags define which text to prefix to each log entry generated by the Logger.

View Source 
const (
	ColorNone     ColorCode = 0
	ColorReset              = 39
	ColorResetAll           = 128
	ColorBright             = 256
	ColorDim                = 512
)
View Source 
const ROTATE_SIZE = 10 * (1 << 20)

Variables

View Source 
var DefaultLogger = newStd()

Functions

func AddAnsiColorCode 

func AddAnsiColorCode(s string, code ColorCode)

func Bail 

func Bail(err error)

func BailIf 

func BailIf(err error)

func Colorify 

func Colorify(s string) string

func DisableAutoNewlines 

func DisableAutoNewlines()

func DisableColor 

func DisableColor()

func DisableColorTemplate 

func DisableColorTemplate()

func EnableAutoNewlines 

func EnableAutoNewlines()

func EnableColor 

func EnableColor()

func EnableColorTemplate 

func EnableColorTemplate()

func EnableMultilineMode 

func EnableMultilineMode()

func EnableSinglelineMode 

func EnableSinglelineMode()

func Error 

func Error(format string, v ...interface{})

func Fatal 

func Fatal(v ...interface{})

Fatal is equivalent to Print() followed by a call to os.Exit(1).

func Fatalf 

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

Fatalf is equivalent to Printf() followed by a call to os.Exit(1).

func Fatalln 

func Fatalln(v ...interface{})

Fatalln is equivalent to Println() followed by a call to os.Exit(1).

func Flags 

func Flags() int

Flags returns the output flags for the standard logger.

func FormatDuration 

func FormatDuration(duration time.Duration) string

func FormatDurationColor 

func FormatDurationColor(duration time.Duration, mediumTime time.Duration, longTime time.Duration) string

func HidePartialLines 

func HidePartialLines()

func Info 

func Info(format string, v ...interface{})

func Log 

func Log(format string, v ...interface{})

func Output 

func Output(calldepth int, s string) error

Output writes the output for a logging event. The string s contains the text to print after the prefix specified by the flags of the Logger. A newline is appended if the last character of s is not already a newline. Calldepth is the count of the number of frames to skip when computing the file name and line number if Llongfile or Lshortfile is set; a value of 1 will print the details for the caller of Output.

func Panic 

func Panic(v ...interface{})

Panic is equivalent to Print() followed by a call to panic().

func Panicf 

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

Panicf is equivalent to Printf() followed by a call to panic().

func Panicln 

func Panicln(v ...interface{})

Panicln is equivalent to Println() followed by a call to panic().

func Prefix 

func Prefix() string

Prefix returns the output prefix for the standard logger.

func Print 

func Print(v ...interface{})

Print calls Output to print to the standard logger. Arguments are handled in the manner of fmt.Print.

func Printf 

func Printf(format string, v ...interface{})

Printf calls Output to print to the standard logger. Arguments are handled in the manner of fmt.Printf.

func Println 

func Println(v ...interface{})

Println calls Output to print to the standard logger. Arguments are handled in the manner of fmt.Println.

func Replace 

func Replace(v ...interface{})

func Replacef 

func Replacef(format string, v ...interface{})

func SetColorTemplateRegexp 

func SetColorTemplateRegexp(rgx *regexp.Regexp)

func SetFlags 

func SetFlags(flag int)

SetFlags sets the output flags for the standard logger.

func SetOutput 

func SetOutput(w io.Writer)

SetOutput sets the output destination for the standard logger.

func SetPrefix 

func SetPrefix(prefix string)

SetPrefix sets the output prefix for the standard logger.

func SetTerminalWidth 

func SetTerminalWidth(width int)

func ShowPartialLines 

func ShowPartialLines()

func Uncolorize 

func Uncolorize(buf []byte) []byte

func VisibleStringLen 

func VisibleStringLen(buf []byte) int

Types

type ActiveAnsiCodes 

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

type ColorCode 

type ColorCode int
const (
	ColorBlack ColorCode = 30 + iota
	ColorRed
	ColorGreen
	ColorYellow
	ColorBlue
	ColorMagenta
	ColorCyan
	ColorWhite
)

func (ColorCode) GetAnsiCodes 

func (code ColorCode) GetAnsiCodes() []int

type Logger 

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

A Logger represents an active logging object that generates lines of output to an io.Writer. Each logging operation makes a single call to the Writer's Write method. A Logger can be used simultaneously from multiple goroutines; it guarantees to serialize access to the Writer.

func New 

func New(out io.Writer, prefix string, flag int) *Logger

New creates a new Logger. The out variable sets the destination to which log data will be written. The prefix appears at the beginning of each generated log line. The flag argument defines the logging properties.

func (*Logger) Bail 

func (l *Logger) Bail(err error)

func (*Logger) BailIf 

func (l *Logger) BailIf(err error)

func (*Logger) Close 

func (l *Logger) Close() error

func (*Logger) Colorify 

func (l *Logger) Colorify(s string) string

func (*Logger) DisableAutoNewlines 

func (l *Logger) DisableAutoNewlines()

func (*Logger) DisableColor 

func (l *Logger) DisableColor()

func (*Logger) DisableColorTemplate 

func (l *Logger) DisableColorTemplate()

func (*Logger) EnableAutoNewlines 

func (l *Logger) EnableAutoNewlines()

func (*Logger) EnableColor 

func (l *Logger) EnableColor()

func (*Logger) EnableColorTemplate 

func (l *Logger) EnableColorTemplate()

func (*Logger) EnableMultilineMode 

func (l *Logger) EnableMultilineMode()

func (*Logger) EnableSinglelineMode 

func (l *Logger) EnableSinglelineMode()

func (*Logger) Error 

func (l *Logger) Error(format string, v ...interface{})

func (*Logger) Fatal 

func (l *Logger) Fatal(v ...interface{})

Fatal is equivalent to l.Print() followed by a call to os.Exit(1).

func (*Logger) Fatalf 

func (l *Logger) Fatalf(format string, v ...interface{})

Fatalf is equivalent to l.Printf() followed by a call to os.Exit(1).

func (*Logger) Fatalln 

func (l *Logger) Fatalln(v ...interface{})

Fatalln is equivalent to l.Println() followed by a call to os.Exit(1).

func (*Logger) Flags 

func (l *Logger) Flags() int

Flags returns the output flags for the logger.

func (*Logger) Flush 

func (l *Logger) Flush()

func (*Logger) HidePartialLines 

func (l *Logger) HidePartialLines()

func (*Logger) Info 

func (l *Logger) Info(format string, v ...interface{})

Info is a synomym for Log

func (*Logger) Log 

func (l *Logger) Log(format string, v ...interface{})

Log calls l.Output to print to the logger, adding a newline at the end of the format string. Arguments are handled in the manner of fmt.Printf.

func (*Logger) Output 

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

func (*Logger) Panic 

func (l *Logger) Panic(v ...interface{})

Panic is equivalent to l.Print() followed by a call to panic().

func (*Logger) Panicf 

func (l *Logger) Panicf(format string, v ...interface{})

Panicf is equivalent to l.Printf() followed by a call to panic().

func (*Logger) Panicln 

func (l *Logger) Panicln(v ...interface{})

Panicln is equivalent to l.Println() followed by a call to panic().

func (*Logger) Prefix 

func (l *Logger) Prefix() string

Prefix returns the output prefix for the logger.

func (*Logger) Print 

func (l *Logger) Print(v ...interface{})

Print calls l.Output to print to the logger. Arguments are handled in the manner of fmt.Print.

func (*Logger) Printf 

func (l *Logger) Printf(format string, v ...interface{})

Printf calls l.Output to print to the logger. Arguments are handled in the manner of fmt.Printf.

func (*Logger) Println 

func (l *Logger) Println(v ...interface{})

Println calls l.intOutput to print to the logger. Arguments are handled in the manner of fmt.Println.

func (*Logger) Replace 

func (l *Logger) Replace(v ...interface{})

func (*Logger) Replacef 

func (l *Logger) Replacef(format string, v ...interface{})

func (*Logger) SetAutoNewlines 

func (l *Logger) SetAutoNewlines(flag bool)

func (*Logger) SetColorEnabled 

func (l *Logger) SetColorEnabled(flag bool)

func (*Logger) SetColorTemplateEnabled 

func (l *Logger) SetColorTemplateEnabled(flag bool)

func (*Logger) SetColorTemplateRegexp 

func (l *Logger) SetColorTemplateRegexp(rgx *regexp.Regexp)

func (*Logger) SetFlags 

func (l *Logger) SetFlags(flag int)

SetFlags sets the output flags for the logger.

func (*Logger) SetMultilineEnabled 

func (l *Logger) SetMultilineEnabled(flag bool)

func (*Logger) SetOutput 

func (l *Logger) SetOutput(w io.Writer)

SetOutput sets the output destination for the logger.

func (*Logger) SetPartialLinesEnabled 

func (l *Logger) SetPartialLinesEnabled(flag bool)

func (*Logger) SetPrefix 

func (l *Logger) SetPrefix(prefix string)

SetPrefix sets the output prefix for the logger.

func (*Logger) SetTerminalWidth 

func (l *Logger) SetTerminalWidth(width int)

func (*Logger) ShowPartialLines 

func (l *Logger) ShowPartialLines()

func (*Logger) Write 

func (l *Logger) Write(p []byte) (n int, err error)

type LoggerInt 

type LoggerInt interface {
	Printf(string, ...interface{})
	Print(...interface{})
	Replacef(string, ...interface{})
	Replace(...interface{})
	Println(...interface{})
	Fatal(...interface{})
	Fatalf(string, ...interface{})
	Fatalln(...interface{})
	Panic(...interface{})
	Panicf(string, ...interface{})
	Panicln(...interface{})
	Bail(error)
	BailIf(error)
	Flags() int
	SetFlags(int)
	Prefix() string
	SetPrefix(string)
	Write([]byte) (int, error)
	Colorify(string) string

	Flush()
	Close() error
	SetPartialLinesEnabled(bool)
	ShowPartialLines()
	HidePartialLines()
	SetColorEnabled(bool)
	EnableColor()
	DisableColor()
	SetColorTemplateEnabled(bool)
	EnableColorTemplate()
	DisableColorTemplate()
	SetAutoNewlines(bool)
	EnableAutoNewlines()
	DisableAutoNewlines()
	SetColorTemplateRegexp(*regexp.Regexp)
	SetTerminalWidth(int)
	SetMultilineEnabled(bool)
	EnableMultilineMode()
	EnableSinglelineMode()
	// contains filtered or unexported methods
}

type PrintLogger 

type PrintLogger interface {
	Printf(format string, a ...interface{})
	Println(a ...interface{})
	Write(buf []byte) (int, error)
}

type RotatingLogger 

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

func NewRotatingLogger 

func NewRotatingLogger(path string, loggerInt PrintLogger) (*RotatingLogger, error)

func (*RotatingLogger) Write 

func (l *RotatingLogger) Write(buf []byte) (int, error)

type Timer 

type Timer time.Time

func NewTimer 

func NewTimer() Timer

func (Timer) Elapsed 

func (t Timer) Elapsed() time.Duration

func (Timer) FormatElapsed 

func (t Timer) FormatElapsed() string

func (Timer) FormatElapsedColor 

func (t Timer) FormatElapsedColor(mediumTime time.Duration, longTime time.Duration) string

type WriterState 

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.