log

package
v1.0.15 Latest Latest
Warning

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

Go to latest
Published: Sep 20, 2021 License: AGPL-3.0 Imports: 9 Imported by: 0

Documentation

Index

Constants

View Source
const (
	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
	LstdFlags     = Ldate | Ltime // initial values for the standard logger
)

These flags define which text to prefix to each log entry generated by the Logger. Bits are 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

Variables

This section is empty.

Functions

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 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 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.

Types

type Logger

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

Logger satisfies the logger interface

func New

func New(projectID string, options ...LoggerOption) *Logger

New creates a new logger with specified LoggerOptions

func (*Logger) Close

func (l *Logger) Close()

Close closes the loggingClient

func (*Logger) Critical

func (l *Logger) Critical(message interface{})

Critical outputs a logline with Critical severity

func (*Logger) Criticalf

func (l *Logger) Criticalf(format string, a ...interface{})

Criticalf is like Critical but uses a format statement

func (*Logger) Debug

func (l *Logger) Debug(message interface{})

Debug outputs a logline with Debug severity

func (*Logger) Debugf

func (l *Logger) Debugf(format string, a ...interface{})

Debugf is like Debug but uses a format statement

func (*Logger) Error

func (l *Logger) Error(message interface{})

Error outputs a logline with Error severity

func (*Logger) Errorf

func (l *Logger) Errorf(format string, a ...interface{})

Errorf is like Error but uses a format statement

func (*Logger) Fatalf

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

Fatalf outputs a logline with critical severity and then calls os.Exit(1)

func (*Logger) Flags

func (l *Logger) Flags() int

Flags returns the output flags for the logger.

func (*Logger) Info

func (l *Logger) Info(message interface{})

Info outputs a logline with Info severity

func (*Logger) Infof

func (l *Logger) Infof(format string, a ...interface{})

Infof is like Info but uses a format statement

func (*Logger) Output

func (l *Logger) 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 used to recover the PC and is provided for generality, although at the moment on all pre-defined paths it will be 2.

func (*Logger) Prefix

func (l *Logger) Prefix() string

Prefix returns the output prefix for the logger.

func (*Logger) SetFlags

func (l *Logger) SetFlags(flag int)

SetFlags sets the output flags for the logger.

func (*Logger) SetPrefix

func (l *Logger) SetPrefix(prefix string)

SetPrefix sets the output prefix for the logger.

func (*Logger) WithRequest

func (l *Logger) WithRequest(r *http.Request) *Logger

WithRequest returns a shallow copy of logger with a request present

type LoggerOption

type LoggerOption func(*LoggerOptions)

LoggerOption defines a function to set LoggerOptions

func WithContext

func WithContext(ctx context.Context) LoggerOption

WithContext sets logger context

func WithDebug

func WithDebug(debug bool) LoggerOption

WithDebug sets whether or not debug logs should be written

func WithDefaultSeverity

func WithDefaultSeverity(defaultSeverity logging.Severity) LoggerOption

WithDefaultSeverity sets the severity for all logs that don't have one specified.

func WithLogName

func WithLogName(logname string) LoggerOption

WithLogName sets the name for the logs

func WithPrefix

func WithPrefix(prefix string) LoggerOption

WithPrefix sets a string prefix for all loglines

type LoggerOptions

type LoggerOptions struct {
	LogName         string
	Prefix          string
	Debug           bool
	DefaultSeverity logging.Severity
	Context         context.Context
}

LoggerOptions define the behavior of a new Logger

Jump to

Keyboard shortcuts

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