log

Documentation

Overview

Package log contains necessary logging functions

Index

• Constants
• func Debug(format string, args ...interface{})
• func Error(format string, args ...interface{})
• func Fatal(args ...interface{})
• func Fatalf(format string, args ...interface{})
• func Info(format string, args ...interface{})
• func OnPanic(prefix string)
• func Print(args ...interface{})
• func Printf(format string, args ...interface{})
• func Println(args ...interface{})
• func SetFlags(flags int)
• func SetLevel(l Level)
• func SetOutput(w io.Writer)
• func StdLog(prefix string, l Level) (std *log.Logger)
• func Tracef(format string, args ...interface{})
• func Writer() io.Writer
• type Level
  • func GetLevel() (l Level)
• type Timer
  • func StartTimer() Timer
  • func (t *Timer) LogElapsed(message string, args ...interface{})

Examples

• OnPanic

Constants

const (
	Ldate = 1 << iota
	Ltime
	Lmicroseconds
	Llongfile
	Lshortfile
	LUTC
	Lmsgprefix
	LstdFlags = Ldate | Ltime
)

These constants are the same as in the standard package "log".

See the output of:

go doc log.Ldate

Functions

func Debug

func Debug(format string, args ...interface{})

Debug writes to debug log

func Error

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

Error writes to error log

func Fatal

func Fatal(args ...interface{})

Fatal writes to error log and exits application

func Fatalf

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

Fatalf writes to error log and exits application

func Info

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

Info writes to info log

func OnPanic

func OnPanic(prefix string)

OnPanic is a convinient deferred helper function to log a panic in a goroutine. It should not be used where proper error handling is required.

Example

package main

import (
	"os"

	"github.com/AdguardTeam/golibs/log"
)

func main() {
	log.SetOutput(os.Stdout)
	log.SetFlags(0)

	f := func() {
		defer log.OnPanic("")

		panic("fail")
	}

	f()

	f = func() {
		defer log.OnPanic("f")

		panic("fail")
	}

	f()

}

Output:


[error] recovered from panic: fail
[error] f: recovered from panic: fail

func Print

func Print(args ...interface{})

Print writes to info log

func Printf

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

Printf writes to info log

func Println

func Println(args ...interface{})

Println writes to info log

func SetFlags

func SetFlags(flags int)

SetFlags sets the output flags for the default logger. The flag bits are Ldate, Ltime, and so on.

func SetLevel

func SetLevel(l Level)

SetLevel sets logging level.

func SetOutput

func SetOutput(w io.Writer)

SetOutput sets output printing method

func StdLog

func StdLog(prefix string, l Level) (std *log.Logger)

StdLog returns a Go standard library logger that writes everything to logs the way this library's logger would. This is useful for cases that require a stdlib logger, for example http.Server.ErrorLog.

func Tracef

func Tracef(format string, args ...interface{})

Tracef writes to debug log and adds the calling function's name

func Writer

func Writer() io.Writer

Writer returns the output destination for the default logger.

Types

type Level

type Level uint32

Level is the log level type.

const (
	ERROR Level = iota
	INFO
	DEBUG
)

Level constants.

func GetLevel

func GetLevel() (l Level)

GetLevel returns level

type Timer

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

Timer is a wrapper for time

func StartTimer

func StartTimer() Timer

StartTimer returns a Timer with a start time

func (*Timer) LogElapsed

func (t *Timer) LogElapsed(message string, args ...interface{})

LogElapsed writes to log message and elapsed time