loggdb

README

#+title: LogGgb
#+HTML: <a href="https://pkg.go.dev/github.com/m1ndo/LogGdb"></a><img src="https://pkg.go.dev/badge/github.com/m1ndo/LogGdb.svg" alt="Go Reference"></img>

*LogGdb* is a go package that uses /charmbracelet/ "Log" to quickly add a logger in your project.
Its also supports debugging code incase of a Fatal error.
* Install && Usage
To use LogGdb
#+begin_src bash
go get github.com/m1ndo/LogGdb
#+end_src
#+begin_src go
import loggdb "github.com/m1ndo/LogGdb"

type App struct {
	Logger *loggdb.Logger
}

func NewApp() *App {
	a := &App{Logger: &loggdb.Logger{}}
	if err := Logger.NewLogger(); err!= nil {
		panic(err)
	}
	a.Logger.Log.Info("Hello World")
	// To Disable The GDB backTrace .
	a.Logger.Gdb.Disable(true)
	// Rest of the App / Project
	return a
}
#+end_src
*Further* examples check folder =examples/=

* License
GPLv3

Documentation

Index

• Constants
• Variables
• type CustomOpt
• type Logger
  • func (Log *Logger) NewLogger() error

Constants

const (
	Info  = log.InfoLevel
	Debug = log.DebugLevel
	Warn  = log.WarnLevel
	Error = log.ErrorLevel
	Fatal = log.FatalLevel
)

Constants

Variables

var (
	DebugPrint = func(format string, data ...interface{}) {
		fmt.Printf(format+"\n", data...)
	}
)

Types

type CustomOpt

type CustomOpt struct {
	Prefix          string
	TimeFunction    func() time.Time
	TimeFormat      string
	ReportTimestamp bool
	ReportCaller    bool
	LogFileName     string
}

CustomOpt Optional Options to pass to log

type Logger

type Logger struct {
	*log.Logger
	Options    *log.Options
	LogWriter  io.Writer
	LogOptions *CustomOpt
	LogDir     string
	Gdb        errlog.Logger
}

Logger Main Logger Definition

func (*Logger) NewLogger

func (Log *Logger) NewLogger() error

NewLogger Creates a new Logger.