vikunja-api/pkg/log/logging.go

174 lines
5.1 KiB
Go
Raw Normal View History

// Vikunja is a todo-list application to facilitate your life.
2020-01-09 18:33:22 +01:00
// Copyright 2018-2020 Vikunja and contributors. All rights reserved.
2018-11-26 21:17:33 +01:00
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
2018-11-26 21:17:33 +01:00
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
2018-11-26 21:17:33 +01:00
//
// You should have received a copy of the GNU General Public License
// along with this program. If not, see <https://www.gnu.org/licenses/>.
2018-11-26 21:17:33 +01:00
2018-10-31 13:42:38 +01:00
package log
2018-09-19 08:35:53 +02:00
import (
"code.vikunja.io/api/pkg/config"
2018-09-19 08:35:53 +02:00
"github.com/op/go-logging"
2019-01-25 12:40:54 +01:00
"github.com/spf13/viper"
"io"
"log"
2018-09-19 08:35:53 +02:00
"os"
2019-01-25 12:40:54 +01:00
"time"
2018-09-19 08:35:53 +02:00
)
2019-01-25 12:40:54 +01:00
// ErrFmt holds the format for all the console logging
const ErrFmt = `${time_rfc3339_nano}: ${level} ` + "\t" + `▶ ${prefix} ${short_file}:${line}`
// WebFmt holds the format for all logging related to web requests
const WebFmt = `${time_rfc3339_nano}: WEB ` + "\t" + `▶ ${remote_ip} ${id} ${method} ${status} ${uri} ${latency_human} - ${user_agent}`
// Fmt is the general log format
const Fmt = `%{color}%{time:` + time.RFC3339Nano + `}: %{level}` + "\t" + `▶ %{shortpkg}/%{shortfunc} %{id:03x}%{color:reset} %{message}`
2019-07-20 20:12:10 +02:00
// loginstance is the instance of the logger which is used under the hood to log
var logInstance = logging.MustGetLogger("vikunja")
2018-09-19 08:35:53 +02:00
2018-09-20 07:31:36 +02:00
// InitLogger initializes the global log handler
2018-09-19 08:35:53 +02:00
func InitLogger() {
if !config.LogEnabled.GetBool() {
2019-01-25 12:40:54 +01:00
// Disable all logging when loggin in general is disabled, overwriting everything a user might have set.
config.LogErrors.Set("off")
config.LogStandard.Set("off")
config.LogDatabase.Set("off")
config.LogHTTP.Set("off")
config.LogEcho.Set("off")
2019-01-25 12:40:54 +01:00
return
}
// This show correct caller functions
logInstance.ExtraCalldepth = 1
if config.LogErrors.GetString() == "file" || config.LogStandard.GetString() == "file" {
err := os.Mkdir(config.LogPath.GetString(), 0744)
2019-01-25 12:40:54 +01:00
if err != nil && !os.IsExist(err) {
log.Fatal("Could not create log folder: ", err.Error())
}
}
var logBackends []logging.Backend
// We define our two backends
if config.LogStandard.GetString() != "off" {
2019-01-25 12:40:54 +01:00
stdWriter := GetLogWriter("standard")
stdBackend := logging.NewLogBackend(stdWriter, "", 0)
// Set the standard backend
logBackends = append(logBackends, logging.NewBackendFormatter(stdBackend, logging.MustStringFormatter(Fmt+"\n")))
}
if config.LogErrors.GetString() != "off" {
2019-01-25 12:40:54 +01:00
errWriter := GetLogWriter("error")
errBackend := logging.NewLogBackend(errWriter, "", 0)
// Only warnings and more severe messages should go to the error backend
errBackendLeveled := logging.AddModuleLevel(errBackend)
errBackendLeveled.SetLevel(logging.WARNING, "")
logBackends = append(logBackends, errBackendLeveled)
}
// Set our backends
logging.SetBackend(logBackends...)
}
// GetLogWriter returns the writer to where the normal log goes, depending on the config
func GetLogWriter(logfile string) (writer io.Writer) {
writer = os.Stdout // Set the default case to prevent nil pointer panics
2019-01-25 12:40:54 +01:00
switch viper.GetString("log." + logfile) {
case "file":
f, err := os.OpenFile(config.LogPath.GetString()+"/"+logfile+".log", os.O_APPEND|os.O_CREATE|os.O_WRONLY, 0644)
2019-01-25 12:40:54 +01:00
if err != nil {
log.Fatal(err)
}
writer = f
case "stderr":
writer = os.Stderr
2019-01-25 12:40:54 +01:00
case "stdout":
default:
writer = os.Stdout
}
return
2018-09-19 08:35:53 +02:00
}
2019-07-20 20:12:10 +02:00
// GetLogger returns the logging instance. DO NOT USE THIS TO LOG STUFF.
func GetLogger() *logging.Logger {
return logInstance
}
/////
// The following functions are to be used as an "eye-candy", so one can just write log.Error() instead of log.Log.Error()
// Debug is for debug messages
func Debug(args ...interface{}) {
logInstance.Debug(args)
}
// Debugf is for debug messages
func Debugf(format string, args ...interface{}) {
2019-07-21 23:27:30 +02:00
logInstance.Debugf(format, args...)
2019-07-20 20:12:10 +02:00
}
// Info is for info messages
func Info(args ...interface{}) {
logInstance.Info(args)
}
// Infof is for info messages
func Infof(format string, args ...interface{}) {
2019-07-21 23:27:30 +02:00
logInstance.Infof(format, args...)
2019-07-20 20:12:10 +02:00
}
// Error is for error messages
func Error(args ...interface{}) {
logInstance.Error(args)
}
// Errorf is for error messages
func Errorf(format string, args ...interface{}) {
2019-07-21 23:27:30 +02:00
logInstance.Errorf(format, args...)
2019-07-20 20:12:10 +02:00
}
// Warning is for warning messages
func Warning(args ...interface{}) {
logInstance.Warning(args)
}
// Warningf is for warning messages
func Warningf(format string, args ...interface{}) {
2019-07-21 23:27:30 +02:00
logInstance.Warningf(format, args...)
2019-07-20 20:12:10 +02:00
}
// Critical is for critical messages
func Critical(args ...interface{}) {
logInstance.Critical(args)
}
// Criticalf is for critical messages
func Criticalf(format string, args ...interface{}) {
2019-07-21 23:27:30 +02:00
logInstance.Criticalf(format, args...)
2019-07-20 20:12:10 +02:00
}
// Fatal is for fatal messages
func Fatal(args ...interface{}) {
logInstance.Fatal(args)
}
// Fatalf is for fatal messages
func Fatalf(format string, args ...interface{}) {
2019-07-21 23:27:30 +02:00
logInstance.Fatalf(format, args...)
2019-07-20 20:12:10 +02:00
}