mirror of
https://github.com/jesseduffield/lazygit.git
synced 2024-12-12 11:15:00 +02:00
e0ecc9e835
I'll be honest, for all I know logging should be global in general: it is a pain to pass a logger to any struct that needs it. But smart people on the internet tell me otherwise, and I do like the idea of not having any global variables lying around. Nonetheless, I often need to log things when locally debugging and that's a different kind of logging than the kind you would include in the actual released binary. For example if I want to log something from gocui, I would rather not have gocui depend on lazygit's logging setup.
65 lines
1.7 KiB
Go
65 lines
1.7 KiB
Go
package logs
|
|
|
|
import (
|
|
"io"
|
|
"log"
|
|
"os"
|
|
|
|
"github.com/sirupsen/logrus"
|
|
)
|
|
|
|
// It's important that this package does not depend on any other package because we
|
|
// may want to import it from anywhere, and we don't want to create a circular dependency
|
|
// (because Go refuses to compile circular dependencies).
|
|
|
|
// Global is a global logger that can be used anywhere in the app, for
|
|
// _development purposes only_. I want to avoid global variables when possible,
|
|
// so if you want to log something that's printed when the -debug flag is set,
|
|
// you'll need to ensure the struct you're working with has a logger field (
|
|
// and most of them do).
|
|
// Global is only available if the LAZYGIT_LOG_PATH environment variable is set.
|
|
var Global *logrus.Entry
|
|
|
|
func init() {
|
|
logPath := os.Getenv("LAZYGIT_LOG_PATH")
|
|
if logPath != "" {
|
|
Global = NewDevelopmentLogger(logPath)
|
|
}
|
|
}
|
|
|
|
func NewProductionLogger() *logrus.Entry {
|
|
logger := logrus.New()
|
|
logger.Out = io.Discard
|
|
logger.SetLevel(logrus.ErrorLevel)
|
|
return formatted(logger)
|
|
}
|
|
|
|
func NewDevelopmentLogger(logPath string) *logrus.Entry {
|
|
logger := logrus.New()
|
|
logger.SetLevel(getLogLevel())
|
|
|
|
file, err := os.OpenFile(logPath, os.O_CREATE|os.O_WRONLY|os.O_APPEND, 0o666)
|
|
if err != nil {
|
|
log.Fatalf("Unable to log to log file: %v", err)
|
|
}
|
|
logger.SetOutput(file)
|
|
return formatted(logger)
|
|
}
|
|
|
|
func formatted(log *logrus.Logger) *logrus.Entry {
|
|
// highly recommended: tail -f development.log | humanlog
|
|
// https://github.com/aybabtme/humanlog
|
|
log.Formatter = &logrus.JSONFormatter{}
|
|
|
|
return log.WithFields(logrus.Fields{})
|
|
}
|
|
|
|
func getLogLevel() logrus.Level {
|
|
strLevel := os.Getenv("LOG_LEVEL")
|
|
level, err := logrus.ParseLevel(strLevel)
|
|
if err != nil {
|
|
return logrus.DebugLevel
|
|
}
|
|
return level
|
|
}
|