vikunja-api/pkg/log/logging.go

174 lines
5.1 KiB
Go
Raw Normal View History

2020-02-07 17:27:45 +01:00
// Vikunja is a to-do list application to facilitate your life.
2021-02-02 20:19:13 +01:00
// Copyright 2018-2021 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
2020-12-23 16:41:52 +01:00
// it under the terms of the GNU Affero General Public Licensee 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
2020-12-23 16:41:52 +01:00
// GNU Affero General Public Licensee for more details.
2018-11-26 21:17:33 +01:00
//
2020-12-23 16:41:52 +01:00
// You should have received a copy of the GNU Affero General Public Licensee
// 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 (
2019-01-25 12:40:54 +01:00
"io"
2018-09-19 08:35:53 +02:00
"os"
"strings"
2019-01-25 12:40:54 +01:00
"time"
"code.vikunja.io/api/pkg/config"
"github.com/op/go-logging"
"github.com/spf13/viper"
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}`
const logModule = `vikunja`
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(logModule)
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.LogStandard.Set("off")
config.LogDatabase.Set("off")
config.LogHTTP.Set("off")
config.LogEcho.Set("off")
config.LogEvents.Set("off")
2019-01-25 12:40:54 +01:00
return
}
// This show correct caller functions
logInstance.ExtraCalldepth = 1
if 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) {
Fatalf("Could not create log folder: %s", err.Error())
2019-01-25 12:40:54 +01:00
}
}
// The backend is the part which actually handles logging the log entries somewhere.
cf := config.LogStandard.GetString()
var backend logging.Backend
backend = &NoopBackend{}
if cf != "off" && cf != "false" {
2019-01-25 12:40:54 +01:00
stdWriter := GetLogWriter("standard")
logBackend := logging.NewLogBackend(stdWriter, "", 0)
backend = logging.NewBackendFormatter(logBackend, logging.MustStringFormatter(Fmt+"\n"))
}
2019-01-25 12:40:54 +01:00
level, err := logging.LogLevel(strings.ToUpper(config.LogLevel.GetString()))
if err != nil {
Fatalf("Error setting database log level: %s", err.Error())
}
backendLeveled := logging.AddModuleLevel(backend)
backendLeveled.SetLevel(level, logModule)
logInstance.SetBackend(backendLeveled)
2019-01-25 12:40:54 +01:00
}
// 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":
fullLogFilePath := config.LogPath.GetString() + "/" + logfile + ".log"
2020-04-13 22:30:09 +02:00
f, err := os.OpenFile(fullLogFilePath, os.O_APPEND|os.O_CREATE|os.O_WRONLY, 0600)
2019-01-25 12:40:54 +01:00
if err != nil {
Fatalf("Could not create logfile %s: %s", fullLogFilePath, err.Error())
2019-01-25 12:40:54 +01:00
}
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...)
2019-07-20 20:12:10 +02:00
}
// 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...)
2019-07-20 20:12:10 +02:00
}
// 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...)
2019-07-20 20:12:10 +02:00
}
// 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...)
2019-07-20 20:12:10 +02:00
}
// 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...)
2019-07-20 20:12:10 +02:00
}
// 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...)
2019-07-20 20:12:10 +02:00
}
// 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
}