Feature/441 improve logging (#599)

* Added zerolog adapter * Zerolog configured as previous * Added config for pretty log format * fix pkg configs too * Added structured log methods * Simplified logger interface * Replaced go-logger to zerolog * fix time format in json log * Linter fixes: - mute errcheck - fix goimports * Added Logger.Clone() method * Fix logger mock Co-authored-by: Andrey Kolkov <[email protected]>
moira-alert · Jan 29, 2021 · ec3e4fb · ec3e4fb
1 parent 2828498
commit ec3e4fb
Show file tree

Hide file tree

Showing 88 changed files with 419 additions and 217 deletions.
diff --git a/api/controller/pattern_test.go b/api/controller/pattern_test.go
@@ -9,8 +9,8 @@ import (
 	"github.com/moira-alert/moira"
 	"github.com/moira-alert/moira/api"
 	"github.com/moira-alert/moira/api/dto"
+	logging "github.com/moira-alert/moira/logging/zerolog_adapter"
 	mock_moira_alert "github.com/moira-alert/moira/mock/moira-alert"
-	"github.com/op/go-logging"
 	. "github.com/smartystreets/goconvey/convey"
 )
 

diff --git a/api/controller/tag_test.go b/api/controller/tag_test.go
@@ -5,7 +5,7 @@ import (
 	"testing"
 
 	"github.com/golang/mock/gomock"
-	"github.com/op/go-logging"
+	logging "github.com/moira-alert/moira/logging/zerolog_adapter"
 
 	"github.com/moira-alert/moira"
 	"github.com/moira-alert/moira/api"

diff --git a/checker/check_test.go b/checker/check_test.go
@@ -10,12 +10,12 @@ import (
 	"github.com/moira-alert/moira"
 	"github.com/moira-alert/moira/checker/metrics/conversion"
 	"github.com/moira-alert/moira/expression"
+	logging "github.com/moira-alert/moira/logging/zerolog_adapter"
 	metricSource "github.com/moira-alert/moira/metric_source"
 	"github.com/moira-alert/moira/metric_source/local"
 	"github.com/moira-alert/moira/metrics"
 	mock_metric_source "github.com/moira-alert/moira/mock/metric_source"
 	mock_moira_alert "github.com/moira-alert/moira/mock/moira-alert"
-	"github.com/op/go-logging"
 	. "github.com/smartystreets/goconvey/convey"
 )
 
@@ -322,7 +322,7 @@ func TestTriggerChecker_PrepareMetrics(t *testing.T) {
 
 func TestGetMetricStepsStates(t *testing.T) {
 	logger, _ := logging.GetLogger("Test")
-	logging.SetLevel(logging.INFO, "Test")
+	logger.Level("info") // nolint: errcheck
 	var warnValue float64 = 10
 	var errValue float64 = 20
 
@@ -503,7 +503,7 @@ func TestGetMetricStepsStates(t *testing.T) {
 
 func TestCheckForNODATA(t *testing.T) {
 	logger, _ := logging.GetLogger("Test")
-	logging.SetLevel(logging.INFO, "Test")
+	logger.Level("info") // nolint: errcheck
 	metricLastState := moira.MetricState{
 		EventTimestamp: 11,
 		Maintenance:    11111,
@@ -907,7 +907,7 @@ func TestCheck(t *testing.T) {
 func TestIgnoreNodataToOk(t *testing.T) {
 	mockCtrl := gomock.NewController(t)
 	logger, _ := logging.GetLogger("Test")
-	logging.SetLevel(logging.INFO, "Test")
+	logger.Level("info") // nolint: errcheck
 	defer mockCtrl.Finish()
 
 	var retention int64 = 10
@@ -970,7 +970,7 @@ func TestHandleTrigger(t *testing.T) {
 	mockCtrl := gomock.NewController(t)
 	dataBase := mock_moira_alert.NewMockDatabase(mockCtrl)
 	logger, _ := logging.GetLogger("Test")
-	logging.SetLevel(logging.INFO, "Test")
+	logger.Level("info") // nolint: errcheck
 	defer mockCtrl.Finish()
 
 	var retention int64 = 10

diff --git a/checker/event_test.go b/checker/event_test.go
@@ -6,8 +6,8 @@ import (
 
 	"github.com/golang/mock/gomock"
 	"github.com/moira-alert/moira"
+	logging "github.com/moira-alert/moira/logging/zerolog_adapter"
 	mock_moira_alert "github.com/moira-alert/moira/mock/moira-alert"
-	"github.com/op/go-logging"
 	. "github.com/smartystreets/goconvey/convey"
 )
 

diff --git a/checker/trigger_checker_test.go b/checker/trigger_checker_test.go
@@ -7,11 +7,11 @@ import (
 	"github.com/golang/mock/gomock"
 	"github.com/moira-alert/moira"
 	"github.com/moira-alert/moira/database"
+	logging "github.com/moira-alert/moira/logging/zerolog_adapter"
 	metricSource "github.com/moira-alert/moira/metric_source"
 	"github.com/moira-alert/moira/metric_source/local"
 	"github.com/moira-alert/moira/metrics"
 	mock_moira_alert "github.com/moira-alert/moira/mock/moira-alert"
-	"github.com/op/go-logging"
 	. "github.com/smartystreets/goconvey/convey"
 )
 
@@ -77,21 +77,21 @@ func TestInitTriggerChecker(t *testing.T) {
 				Timestamp:      1502694427,
 				State:          moira.StateOK,
 				Suppressed:     false,
-				Values:          map[string]float64{"t1": value}, //nolint
+				Values:         map[string]float64{"t1": value}, //nolint
 				EventTimestamp: 1501680428,
 			},
 			"2": {
 				Timestamp:      1502694427,
 				State:          moira.StateOK,
 				Suppressed:     false,
-				Values:          map[string]float64{"t1": value}, //nolint
+				Values:         map[string]float64{"t1": value}, //nolint
 				EventTimestamp: 1501679827,
 			},
 			"3": {
 				Timestamp:      1502694427,
 				State:          moira.StateOK,
 				Suppressed:     false,
-				Values:          map[string]float64{"t1": value}, //nolint
+				Values:         map[string]float64{"t1": value}, //nolint
 				EventTimestamp: 1501679887,
 			},
 		},

diff --git a/cmd/api/config.go b/cmd/api/config.go
@@ -90,8 +90,9 @@ func getDefault() config {
 			MetricsTTL:      "1h",
 		},
 		Logger: cmd.LoggerConfig{
-			LogFile:  "stdout",
-			LogLevel: "info",
+			LogFile:         "stdout",
+			LogLevel:        "info",
+			LogPrettyFormat: false,
 		},
 		API: apiConfig{
 			Listen:     ":8081",

diff --git a/cmd/api/main.go b/cmd/api/main.go
@@ -16,7 +16,7 @@ import (
 	"github.com/moira-alert/moira/cmd"
 	"github.com/moira-alert/moira/database/redis"
 	"github.com/moira-alert/moira/index"
-	"github.com/moira-alert/moira/logging/go-logging"
+	logging "github.com/moira-alert/moira/logging/zerolog_adapter"
 	metricSource "github.com/moira-alert/moira/metric_source"
 	"github.com/moira-alert/moira/metric_source/local"
 	"github.com/moira-alert/moira/metric_source/remote"
@@ -61,7 +61,8 @@ func main() {
 
 	apiConfig := config.API.getSettings(config.Redis.MetricsTTL, config.Remote.MetricsTTL)
 
-	logger, err := logging.ConfigureLog(config.Logger.LogFile, config.Logger.LogLevel, serviceName)
+	logger, err := logging.ConfigureLog(config.Logger.LogFile, config.Logger.LogLevel, serviceName, config.Logger.LogPrettyFormat)
+
 	if err != nil {
 		fmt.Fprintf(os.Stderr, "Can not configure log: %s\n", err.Error())
 		os.Exit(1)

diff --git a/cmd/checker/config.go b/cmd/checker/config.go
@@ -50,8 +50,9 @@ func getDefault() config {
 			MetricsTTL:      "1h",
 		},
 		Logger: cmd.LoggerConfig{
-			LogFile:  "stdout",
-			LogLevel: "info",
+			LogFile:         "stdout",
+			LogLevel:        "info",
+			LogPrettyFormat: false,
 		},
 		Checker: checkerConfig{
 			NoDataCheckInterval:       "60s",

diff --git a/cmd/checker/main.go b/cmd/checker/main.go
@@ -18,7 +18,7 @@ import (
 	"github.com/moira-alert/moira/checker/worker"
 	"github.com/moira-alert/moira/cmd"
 	"github.com/moira-alert/moira/database/redis"
-	"github.com/moira-alert/moira/logging/go-logging"
+	logging "github.com/moira-alert/moira/logging/zerolog_adapter"
 	"github.com/moira-alert/moira/metrics"
 )
 
@@ -61,7 +61,7 @@ func main() {
 		os.Exit(1)
 	}
 
-	logger, err = logging.ConfigureLog(config.Logger.LogFile, config.Logger.LogLevel, serviceName)
+	logger, err = logging.ConfigureLog(config.Logger.LogFile, config.Logger.LogLevel, serviceName, config.Logger.LogPrettyFormat)
 	if err != nil {
 		fmt.Fprintf(os.Stderr, "Can not configure log: %s\n", err.Error())
 		os.Exit(1)
@@ -97,7 +97,7 @@ func main() {
 		SourceProvider:    metricSourceProvider,
 		Metrics:           checkerMetrics,
 		TriggerCache:      cache.New(checkerSettings.CheckInterval, time.Minute*60), //nolint
-		LazyTriggersCache: cache.New(time.Minute*10, time.Minute*60), //nolint
+		LazyTriggersCache: cache.New(time.Minute*10, time.Minute*60),                //nolint
 		PatternCache:      cache.New(checkerSettings.CheckInterval, time.Minute*60), //nolint
 	}
 	err = checkerWorker.Start()

diff --git a/cmd/cli/config.go b/cmd/cli/config.go
@@ -5,10 +5,11 @@ import (
 )
 
 type config struct {
-	LogFile  string          `yaml:"log_file"`
-	LogLevel string          `yaml:"log_level"`
-	Redis    cmd.RedisConfig `yaml:"redis"`
-	Cleanup  cleanupConfig   `yaml:"cleanup"`
+	LogFile         string          `yaml:"log_file"`
+	LogLevel        string          `yaml:"log_level"`
+	LogPrettyFormat bool            `yaml:"log_pretty_format"`
+	Redis           cmd.RedisConfig `yaml:"redis"`
+	Cleanup         cleanupConfig   `yaml:"cleanup"`
 }
 
 type cleanupConfig struct {
@@ -19,8 +20,9 @@ type cleanupConfig struct {
 
 func getDefault() config {
 	return config{
-		LogFile:  "stdout",
-		LogLevel: "info",
+		LogFile:         "stdout",
+		LogLevel:        "info",
+		LogPrettyFormat: false,
 		Redis: cmd.RedisConfig{
 			Host:            "localhost",
 			Port:            "6379",

diff --git a/cmd/cli/main.go b/cmd/cli/main.go
@@ -9,7 +9,7 @@ import (
 	"github.com/moira-alert/moira"
 	"github.com/moira-alert/moira/cmd"
 	"github.com/moira-alert/moira/database/redis"
-	"github.com/moira-alert/moira/logging/go-logging"
+	logging "github.com/moira-alert/moira/logging/zerolog_adapter"
 )
 
 // Moira version
@@ -121,7 +121,7 @@ func initApp() (cleanupConfig, moira.Logger, moira.Database) {
 		os.Exit(1)
 	}
 
-	logger, err := logging.ConfigureLog(config.LogFile, config.LogLevel, "cli")
+	logger, err := logging.ConfigureLog(config.LogFile, config.LogLevel, "cli", config.LogPrettyFormat)
 	if err != nil {
 		fmt.Fprintf(os.Stderr, "Can't configure main logger: %v\n", err)
 		os.Exit(1)

diff --git a/cmd/cli/user_test.go b/cmd/cli/user_test.go
@@ -5,7 +5,7 @@ import (
 	"testing"
 
 	"github.com/moira-alert/moira/database/redis"
-	"github.com/moira-alert/moira/logging/go-logging"
+	logging "github.com/moira-alert/moira/logging/zerolog_adapter"
 
 	"github.com/moira-alert/moira"
 
@@ -18,7 +18,7 @@ func TestUpdateUsers(t *testing.T) {
 	}
 
 	conf := getDefault()
-	logger, err := logging.ConfigureLog(conf.LogFile, conf.LogLevel, "cli")
+	logger, err := logging.ConfigureLog(conf.LogFile, conf.LogLevel, "cli", conf.LogPrettyFormat)
 	if err != nil {
 		t.Fatal(err)
 	}

diff --git a/cmd/config.go b/cmd/config.go
@@ -77,8 +77,9 @@ func (graphiteConfig *GraphiteConfig) GetSettings() metrics.GraphiteRegistryConf
 
 // LoggerConfig is logger settings structure that initialises at the start of moira
 type LoggerConfig struct {
-	LogFile  string `yaml:"log_file"`
-	LogLevel string `yaml:"log_level"`
+	LogFile         string `yaml:"log_file"`
+	LogLevel        string `yaml:"log_level"`
+	LogPrettyFormat bool   `yaml:"log_pretty_format"`
 }
 
 // TelemetryConfig is settings for listener, pprof, graphite

diff --git a/cmd/filter/config.go b/cmd/filter/config.go
@@ -37,8 +37,9 @@ func getDefault() config {
 			MetricsTTL:      "1h",
 		},
 		Logger: cmd.LoggerConfig{
-			LogFile:  "stdout",
-			LogLevel: "info",
+			LogFile:         "stdout",
+			LogLevel:        "info",
+			LogPrettyFormat: false,
 		},
 		Filter: filterConfig{
 			Listen:               ":2003",

diff --git a/cmd/filter/main.go b/cmd/filter/main.go
@@ -16,7 +16,7 @@ import (
 	"github.com/moira-alert/moira/filter/heartbeat"
 	matchedmetrics "github.com/moira-alert/moira/filter/matched_metrics"
 	"github.com/moira-alert/moira/filter/patterns"
-	"github.com/moira-alert/moira/logging/go-logging"
+	logging "github.com/moira-alert/moira/logging/zerolog_adapter"
 	"github.com/moira-alert/moira/metrics"
 	"github.com/xiam/to"
 )
@@ -59,7 +59,7 @@ func main() {
 		os.Exit(1)
 	}
 
-	logger, err = logging.ConfigureLog(config.Logger.LogFile, config.Logger.LogLevel, serviceName)
+	logger, err = logging.ConfigureLog(config.Logger.LogFile, config.Logger.LogLevel, serviceName, config.Logger.LogPrettyFormat)
 	if err != nil {
 		fmt.Fprintf(os.Stderr, "Can not configure log: %s\n", err.Error())
 		os.Exit(1)

diff --git a/cmd/notifier/config.go b/cmd/notifier/config.go
@@ -69,8 +69,9 @@ func getDefault() config {
 		},
 
 		Logger: cmd.LoggerConfig{
-			LogFile:  "stdout",
-			LogLevel: "info",
+			LogFile:         "stdout",
+			LogLevel:        "info",
+			LogPrettyFormat: false,
 		},
 		Notifier: notifierConfig{
 			SenderTimeout:    "10s",

diff --git a/cmd/notifier/main.go b/cmd/notifier/main.go
@@ -14,7 +14,7 @@ import (
 	"github.com/moira-alert/moira"
 	"github.com/moira-alert/moira/cmd"
 	"github.com/moira-alert/moira/database/redis"
-	"github.com/moira-alert/moira/logging/go-logging"
+	logging "github.com/moira-alert/moira/logging/zerolog_adapter"
 	"github.com/moira-alert/moira/metrics"
 	"github.com/moira-alert/moira/notifier"
 	"github.com/moira-alert/moira/notifier/events"
@@ -60,7 +60,7 @@ func main() {
 		os.Exit(1)
 	}
 
-	logger, err = logging.ConfigureLog(config.Logger.LogFile, config.Logger.LogLevel, serviceName)
+	logger, err = logging.ConfigureLog(config.Logger.LogFile, config.Logger.LogLevel, serviceName, config.Logger.LogPrettyFormat)
 	if err != nil {
 		fmt.Fprintf(os.Stderr, "Can not configure log: %s\n", err.Error())
 		os.Exit(1)

diff --git a/database/redis/bot_test.go b/database/redis/bot_test.go
@@ -6,11 +6,11 @@ import (
 	. "github.com/smartystreets/goconvey/convey"
 
 	"github.com/moira-alert/moira/database"
-	"github.com/moira-alert/moira/logging/go-logging"
+	logging "github.com/moira-alert/moira/logging/zerolog_adapter"
 )
 
 func TestBotDataStoring(t *testing.T) {
-	logger, _ := logging.ConfigureLog("stdout", "info", "test")
+	logger, _ := logging.ConfigureLog("stdout", "info", "test", true)
 	dataBase := newTestDatabase(logger, config)
 	dataBase.flush()
 	defer dataBase.flush()
@@ -59,7 +59,7 @@ func TestBotDataStoring(t *testing.T) {
 }
 
 func TestBotDataStoringErrorConnection(t *testing.T) {
-	logger, _ := logging.ConfigureLog("stdout", "info", "test")
+	logger, _ := logging.ConfigureLog("stdout", "info", "test", true)
 	dataBase := newTestDatabase(logger, emptyConfig)
 	dataBase.flush()
 	defer dataBase.flush()

diff --git a/database/redis/contact_test.go b/database/redis/contact_test.go
@@ -4,18 +4,19 @@ import (
 	"fmt"
 	"testing"
 
-	"github.com/op/go-logging"
 	. "github.com/smartystreets/goconvey/convey"
 
 	"github.com/moira-alert/moira"
 	"github.com/moira-alert/moira/database"
+	logging "github.com/moira-alert/moira/logging/zerolog_adapter"
 )
 
 var user1 = "user1"
 var user2 = "user2"
 
 func TestContacts(t *testing.T) {
 	logger, _ := logging.GetLogger("dataBase")
+
 	dataBase := newTestDatabase(logger, config)
 	dataBase.flush()
 	defer dataBase.flush()