From 4f005d739048cdd243f33167e15efc2fe5b56a39 Mon Sep 17 00:00:00 2001
From: Travis Ralston <travpc@gmail.com>
Date: Thu, 10 Mar 2022 19:41:26 -0700
Subject: [PATCH] Add support for changing the log level
---
CHANGELOG.md | 1 +
cmd/export_synapse_for_import/main.go | 7 ++++++-
cmd/gdpr_export/main.go | 9 +++++++--
cmd/gdpr_import/main.go | 9 +++++++--
cmd/import_synapse/main.go | 7 ++++++-
cmd/media_repo/main.go | 7 ++++++-
common/config/conf_main.go | 1 +
common/config/models_main.go | 1 +
common/logging/logger.go | 11 ++++++++++-
config.sample.yaml | 5 +++++
10 files changed, 50 insertions(+), 8 deletions(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 07974e9b..8623aca7 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -13,6 +13,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
* Added support for `image/jxl` thumbnailing.
* Built-in early support for content ranges (being able to skip around in audio and video). This is only available if
caching is enabled.
+* New config option for changing the log level.
### Removed
diff --git a/cmd/export_synapse_for_import/main.go b/cmd/export_synapse_for_import/main.go
index 84a86203..1a9cb49f 100644
--- a/cmd/export_synapse_for_import/main.go
+++ b/cmd/export_synapse_for_import/main.go
@@ -58,7 +58,12 @@ func main() {
realPsqlPassword = *postgresPassword
}
- err := logging.Setup(config.Get().General.LogDirectory, config.Get().General.LogColors, config.Get().General.JsonLogs)
+ err := logging.Setup(
+ config.Get().General.LogDirectory,
+ config.Get().General.LogColors,
+ config.Get().General.JsonLogs,
+ config.Get().General.LogLevel,
+ )
if err != nil {
panic(err)
}
diff --git a/cmd/gdpr_export/main.go b/cmd/gdpr_export/main.go
index 06d31222..4b0e4bfa 100644
--- a/cmd/gdpr_export/main.go
+++ b/cmd/gdpr_export/main.go
@@ -45,7 +45,12 @@ func main() {
assets.SetupTemplates(*templatesPath)
var err error
- err = logging.Setup(config.Get().General.LogDirectory, config.Get().General.LogColors, config.Get().General.JsonLogs)
+ err = logging.Setup(
+ config.Get().General.LogDirectory,
+ config.Get().General.LogColors,
+ config.Get().General.JsonLogs,
+ config.Get().General.LogLevel,
+ )
if err != nil {
panic(err)
}
@@ -83,7 +88,7 @@ func main() {
if err != nil {
logrus.Error(err)
} else if task.EndTs > 0 {
- waitChan<-true
+ waitChan <- true
return
}
diff --git a/cmd/gdpr_import/main.go b/cmd/gdpr_import/main.go
index c69035a0..d2685251 100644
--- a/cmd/gdpr_import/main.go
+++ b/cmd/gdpr_import/main.go
@@ -35,7 +35,12 @@ func main() {
assets.SetupMigrations(*migrationsPath)
var err error
- err = logging.Setup(config.Get().General.LogDirectory, config.Get().General.LogColors, config.Get().General.JsonLogs)
+ err = logging.Setup(
+ config.Get().General.LogDirectory,
+ config.Get().General.LogColors,
+ config.Get().General.JsonLogs,
+ config.Get().General.LogLevel,
+ )
if err != nil {
panic(err)
}
@@ -155,7 +160,7 @@ func main() {
if err != nil {
logrus.Error(err)
} else if task.EndTs > 0 {
- waitChan<-true
+ waitChan <- true
return
}
diff --git a/cmd/import_synapse/main.go b/cmd/import_synapse/main.go
index db184c78..3c97b89c 100644
--- a/cmd/import_synapse/main.go
+++ b/cmd/import_synapse/main.go
@@ -72,7 +72,12 @@ func main() {
realPsqlPassword = *postgresPassword
}
- err := logging.Setup(config.Get().General.LogDirectory, config.Get().General.LogColors, config.Get().General.JsonLogs)
+ err := logging.Setup(
+ config.Get().General.LogDirectory,
+ config.Get().General.LogColors,
+ config.Get().General.JsonLogs,
+ config.Get().General.LogLevel,
+ )
if err != nil {
panic(err)
}
diff --git a/cmd/media_repo/main.go b/cmd/media_repo/main.go
index 06179992..ba828cb8 100644
--- a/cmd/media_repo/main.go
+++ b/cmd/media_repo/main.go
@@ -59,7 +59,12 @@ func main() {
assets.SetupTemplates(*templatesPath)
assets.SetupAssets(*assetsPath)
- err := logging.Setup(config.Get().General.LogDirectory, config.Get().General.LogColors, config.Get().General.JsonLogs)
+ err := logging.Setup(
+ config.Get().General.LogDirectory,
+ config.Get().General.LogColors,
+ config.Get().General.JsonLogs,
+ config.Get().General.LogLevel,
+ )
if err != nil {
panic(err)
}
diff --git a/common/config/conf_main.go b/common/config/conf_main.go
index 7e96d8c3..ecc508d0 100644
--- a/common/config/conf_main.go
+++ b/common/config/conf_main.go
@@ -27,6 +27,7 @@ func NewDefaultMainConfig() MainRepoConfig {
LogDirectory: "logs",
LogColors: false,
JsonLogs: false,
+ LogLevel: "info",
TrustAnyForward: false,
UseForwardedHost: true,
},
diff --git a/common/config/models_main.go b/common/config/models_main.go
index fc5fb516..084ff06c 100644
--- a/common/config/models_main.go
+++ b/common/config/models_main.go
@@ -6,6 +6,7 @@ type GeneralConfig struct {
LogDirectory string `yaml:"logDirectory"`
LogColors bool `yaml:"logColors"`
JsonLogs bool `yaml:"jsonLogs"`
+ LogLevel string `yaml:"logLevel"`
TrustAnyForward bool `yaml:"trustAnyForwardedAddress"`
UseForwardedHost bool `yaml:"useForwardedHost"`
}
diff --git a/common/logging/logger.go b/common/logging/logger.go
index 86cba363..e3531cd4 100644
--- a/common/logging/logger.go
+++ b/common/logging/logger.go
@@ -19,7 +19,16 @@ func (f utcFormatter) Format(entry *logrus.Entry) ([]byte, error) {
return f.Formatter.Format(entry)
}
-func Setup(dir string, colors bool, json bool) error {
+func Setup(dir string, colors bool, json bool, level string) error {
+ if level == "" {
+ level = "info"
+ }
+ lvl, err := logrus.ParseLevel(level)
+ if err != nil {
+ return err
+ }
+ logrus.SetLevel(lvl)
+
var lineFormatter logrus.Formatter
if json {
lineFormatter = &logrus.JSONFormatter{
diff --git a/config.sample.yaml b/config.sample.yaml
index 670aaf84..fa49e74f 100644
--- a/config.sample.yaml
+++ b/config.sample.yaml
@@ -19,6 +19,11 @@ repo:
# incompatible with the log color option and will always render without colors.
jsonLogs: false
+ # The log level to log at. Note that this will need to be at least "info" to receive support.
+ #
+ # Values (in increasing spam): panic | fatal | error | warn | info | debug | trace
+ logLevel: "info"
+
# If true, the media repo will accept any X-Forwarded-For header without validation. In most cases
# this option should be left as "false". Note that the media repo already expects an X-Forwarded-For
# header, but validates it to ensure the IP being given makes sense.
--
GitLab