GitList

Browse code

panic() instead of logrus.Fatal() in init funcs

Some packages were using `logrus.Fatal()` in init functions (which logs the error,
and (by default) calls `os.Exit(1)` after logging).

Given that logrus formatting and outputs have not yet been configured during the
initialization stage, it does not provide much benefits over a plain `panic()`.

This patch replaces some instances of `logrus.Fatal()` with `panic()`, which has
the added benefits of not introducing logrus as a dependency in some of these
packages, and also produces a stacktrace, which could help locating the problem
in the unlikely event an `init()` fails.

Before this change, an error would look like:

$ dockerd
FATA[0000] something bad happened

After this change, the same error looks like:

$ dockerd
panic: something bad happened

goroutine 1 [running]:
github.com/docker/docker/daemon/logger/awslogs.init.0()
/go/src/github.com/docker/docker/daemon/logger/awslogs/cloudwatchlogs.go:128 +0x89

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

Sebastiaan van Stijn authored on 2022/04/21 18:50:37
Showing 13 changed files

daemon/logger/awslogs/cloudwatchlogs.go index 7406046..14ef531 100644
daemon/logger/etwlogs/etwlogs_windows.go index 78d3477..9a410a1 100644
daemon/logger/fluentd/fluentd.go index b99c46e..17778d8 100644
daemon/logger/gcplogs/gcplogging.go index 4d1e741..94ef107 100644
daemon/logger/gelf/gelf.go index c7814e9..4adf2b3 100644
daemon/logger/journald/journald.go index e809ca7..dd7414e 100644
daemon/logger/jsonfilelog/jsonfilelog.go index e66a6b8..385f63a 100644
daemon/logger/local/local.go index f4411d0..169d2d3 100644
daemon/logger/logentries/logentries.go index 013b182..15d8c75 100644
daemon/logger/splunk/splunk.go index ebdc88b..d194334 100644
daemon/logger/syslog/syslog.go index 4469af8..3b58e22 100644
integration-cli/check_test.go index 9a710b5..0001d08 100644
libnetwork/ipamutils/utils.go index 3fd37cd..9be126f 100644

daemon/logger/awslogs/cloudwatchlogs.go

History View file @ df650a1

@@ -120,10 +120,10 @@ type byTimestamp []wrappedEvent
 // init registers the awslogs driver
 func init() {
 	if err := logger.RegisterLogDriver(name, New); err != nil {
-		logrus.Fatal(err)
+		panic(err)
 	}
 	if err := logger.RegisterLogOptValidator(name, ValidateLogOpt); err != nil {
-		logrus.Fatal(err)
+		panic(err)
 	}
 }
 

daemon/logger/etwlogs/etwlogs_windows.go

History View file @ df650a1

@@ -48,7 +48,7 @@ var mu sync.Mutex
 func init() {
 	providerHandle = windows.InvalidHandle
 	if err := logger.RegisterLogDriver(name, New); err != nil {
-		logrus.Fatal(err)
+		panic(err)
 	}
 }
 

daemon/logger/fluentd/fluentd.go

History View file @ df650a1

@@ -62,10 +62,10 @@ const (
 
 func init() {
 	if err := logger.RegisterLogDriver(name, New); err != nil {
-		logrus.Fatal(err)
+		panic(err)
 	}
 	if err := logger.RegisterLogOptValidator(name, ValidateLogOpt); err != nil {
-		logrus.Fatal(err)
+		panic(err)
 	}
 }
 

daemon/logger/gcplogs/gcplogging.go

History View file @ df650a1

@@ -43,13 +43,12 @@ var (
 )
 
 func init() {
-
 	if err := logger.RegisterLogDriver(name, New); err != nil {
-		logrus.Fatal(err)
+		panic(err)
 	}
 
 	if err := logger.RegisterLogOptValidator(name, ValidateLogOpts); err != nil {
-		logrus.Fatal(err)
+		panic(err)
 	}
 }
 

daemon/logger/gelf/gelf.go

History View file @ df650a1

@@ -14,7 +14,6 @@ import (
 	"github.com/Graylog2/go-gelf/gelf"
 	"github.com/docker/docker/daemon/logger"
 	"github.com/docker/docker/daemon/logger/loggerutils"
-	"github.com/sirupsen/logrus"
 )
 
 const name = "gelf"
@@ -28,10 +27,10 @@ type gelfLogger struct {
 
 func init() {
 	if err := logger.RegisterLogDriver(name, New); err != nil {
-		logrus.Fatal(err)
+		panic(err)
 	}
 	if err := logger.RegisterLogOptValidator(name, ValidateLogOpt); err != nil {
-		logrus.Fatal(err)
+		panic(err)
 	}
 }
 

daemon/logger/journald/journald.go

History View file @ df650a1

@@ -14,7 +14,6 @@ import (
 	"github.com/coreos/go-systemd/v22/journal"
 	"github.com/docker/docker/daemon/logger"
 	"github.com/docker/docker/daemon/logger/loggerutils"
-	"github.com/sirupsen/logrus"
 )
 
 const name = "journald"
@@ -27,10 +26,10 @@ type journald struct {
 
 func init() {
 	if err := logger.RegisterLogDriver(name, New); err != nil {
-		logrus.Fatal(err)
+		panic(err)
 	}
 	if err := logger.RegisterLogOptValidator(name, validateLogOpt); err != nil {
-		logrus.Fatal(err)
+		panic(err)
 	}
 }
 

daemon/logger/jsonfilelog/jsonfilelog.go

History View file @ df650a1

@@ -15,7 +15,6 @@ import (
 	"github.com/docker/docker/daemon/logger/loggerutils"
 	units "github.com/docker/go-units"
 	"github.com/pkg/errors"
-	"github.com/sirupsen/logrus"
 )
 
 // Name is the name of the file that the jsonlogger logs to.
@@ -32,10 +31,10 @@ type JSONFileLogger struct {
 
 func init() {
 	if err := logger.RegisterLogDriver(Name, New); err != nil {
-		logrus.Fatal(err)
+		panic(err)
 	}
 	if err := logger.RegisterLogOptValidator(Name, ValidateLogOpt); err != nil {
-		logrus.Fatal(err)
+		panic(err)
 	}
 }
 

daemon/logger/local/local.go

History View file @ df650a1

@@ -14,7 +14,6 @@ import (
 	"github.com/docker/docker/errdefs"
 	units "github.com/docker/go-units"
 	"github.com/pkg/errors"
-	"github.com/sirupsen/logrus"
 )
 
 const (
@@ -49,10 +48,10 @@ func ValidateLogOpt(cfg map[string]string) error {
 
 func init() {
 	if err := logger.RegisterLogDriver(Name, New); err != nil {
-		logrus.Fatal(err)
+		panic(err)
 	}
 	if err := logger.RegisterLogOptValidator(Name, ValidateLogOpt); err != nil {
-		logrus.Fatal(err)
+		panic(err)
 	}
 }
 

daemon/logger/logentries/logentries.go

History View file @ df650a1

@@ -29,10 +29,10 @@ const (
 
 func init() {
 	if err := logger.RegisterLogDriver(name, New); err != nil {
-		logrus.Fatal(err)
+		panic(err)
 	}
 	if err := logger.RegisterLogOptValidator(name, ValidateLogOpt); err != nil {
-		logrus.Fatal(err)
+		panic(err)
 	}
 }
 

daemon/logger/splunk/splunk.go

History View file @ df650a1

@@ -142,10 +142,10 @@ const (
 
 func init() {
 	if err := logger.RegisterLogDriver(driverName, New); err != nil {
-		logrus.Fatal(err)
+		panic(err)
 	}
 	if err := logger.RegisterLogOptValidator(driverName, ValidateLogOpt); err != nil {
-		logrus.Fatal(err)
+		panic(err)
 	}
 }
 

daemon/logger/syslog/syslog.go

History View file @ df650a1

@@ -16,7 +16,6 @@ import (
 	"github.com/docker/docker/daemon/logger"
 	"github.com/docker/docker/daemon/logger/loggerutils"
 	"github.com/docker/go-connections/tlsconfig"
-	"github.com/sirupsen/logrus"
 )
 
 const (
@@ -54,10 +53,10 @@ type syslogger struct {
 
 func init() {
 	if err := logger.RegisterLogDriver(name, New); err != nil {
-		logrus.Fatal(err)
+		panic(err)
 	}
 	if err := logger.RegisterLogOptValidator(name, ValidateLogOpt); err != nil {
-		logrus.Fatal(err)
+		panic(err)
 	}
 }
 

integration-cli/check_test.go

History View file @ df650a1

@@ -54,8 +54,7 @@ func init() {
 
 	testEnv, err = environment.New()
 	if err != nil {
-		fmt.Println(err)
-		os.Exit(1)
+		panic(err)
 	}
 }
 

libnetwork/ipamutils/utils.go

History View file @ df650a1

@@ -34,13 +34,11 @@ type NetworkToSplit struct {
 func init() {
 	var err error
 	if PredefinedGlobalScopeDefaultNetworks, err = splitNetworks(globalScopeDefaultNetworks); err != nil {
-		//we are going to panic in case of error as we should never get into this state
-		panic("InitAddressPools failed to initialize the global scope default address pool")
+		panic("failed to initialize the global scope default address pool: " + err.Error())
 	}
 
 	if PredefinedLocalScopeDefaultNetworks, err = splitNetworks(localScopeDefaultNetworks); err != nil {
-		//we are going to panic in case of error as we should never get into this state
-		panic("InitAddressPools failed to initialize the local scope default address pool")
+		panic("failed to initialize the local scope default address pool: " + err.Error())
 	}
 }
 

...	...	@@ -120,10 +120,10 @@ type byTimestamp []wrappedEvent
120	120	// init registers the awslogs driver
121	121	func init() {
122	122	if err := logger.RegisterLogDriver(name, New); err != nil {
123		- logrus.Fatal(err)
	123	+ panic(err)
124	124	}
125	125	if err := logger.RegisterLogOptValidator(name, ValidateLogOpt); err != nil {
126		- logrus.Fatal(err)
	126	+ panic(err)
127	127	}
128	128	}
129	129

...	...	@@ -142,10 +142,10 @@ const (
142	142
143	143	func init() {
144	144	if err := logger.RegisterLogDriver(driverName, New); err != nil {
145		- logrus.Fatal(err)
	145	+ panic(err)
146	146	}
147	147	if err := logger.RegisterLogOptValidator(driverName, ValidateLogOpt); err != nil {
148		- logrus.Fatal(err)
	148	+ panic(err)
149	149	}
150	150	}
151	151

...	...	@@ -48,7 +48,7 @@ var mu sync.Mutex
48	48	func init() {
49	49	providerHandle = windows.InvalidHandle
50	50	if err := logger.RegisterLogDriver(name, New); err != nil {
51		- logrus.Fatal(err)
	51	+ panic(err)
52	52	}
53	53	}
54	54

...	...	@@ -62,10 +62,10 @@ const (
62	62
63	63	func init() {
64	64	if err := logger.RegisterLogDriver(name, New); err != nil {
65		- logrus.Fatal(err)
	65	+ panic(err)
66	66	}
67	67	if err := logger.RegisterLogOptValidator(name, ValidateLogOpt); err != nil {
68		- logrus.Fatal(err)
	68	+ panic(err)
69	69	}
70	70	}
71	71

...	...	@@ -43,13 +43,12 @@ var (
43	43	)
44	44
45	45	func init() {
46		-
47	46	if err := logger.RegisterLogDriver(name, New); err != nil {
48		- logrus.Fatal(err)
	47	+ panic(err)
49	48	}
50	49
51	50	if err := logger.RegisterLogOptValidator(name, ValidateLogOpts); err != nil {
52		- logrus.Fatal(err)
	51	+ panic(err)
53	52	}
54	53	}
55	54

...	...	@@ -14,7 +14,6 @@ import (
14	14	"github.com/Graylog2/go-gelf/gelf"
15	15	"github.com/docker/docker/daemon/logger"
16	16	"github.com/docker/docker/daemon/logger/loggerutils"
17		- "github.com/sirupsen/logrus"
18	17	)
19	18
20	19	const name = "gelf"
...	...	@@ -28,10 +27,10 @@ type gelfLogger struct {
28	28
29	29	func init() {
30	30	if err := logger.RegisterLogDriver(name, New); err != nil {
31		- logrus.Fatal(err)
	31	+ panic(err)
32	32	}
33	33	if err := logger.RegisterLogOptValidator(name, ValidateLogOpt); err != nil {
34		- logrus.Fatal(err)
	34	+ panic(err)
35	35	}
36	36	}
37	37

...	...	@@ -14,7 +14,6 @@ import (
14	14	"github.com/coreos/go-systemd/v22/journal"
15	15	"github.com/docker/docker/daemon/logger"
16	16	"github.com/docker/docker/daemon/logger/loggerutils"
17		- "github.com/sirupsen/logrus"
18	17	)
19	18
20	19	const name = "journald"
...	...	@@ -27,10 +26,10 @@ type journald struct {
27	27
28	28	func init() {
29	29	if err := logger.RegisterLogDriver(name, New); err != nil {
30		- logrus.Fatal(err)
	30	+ panic(err)
31	31	}
32	32	if err := logger.RegisterLogOptValidator(name, validateLogOpt); err != nil {
33		- logrus.Fatal(err)
	33	+ panic(err)
34	34	}
35	35	}
36	36

...	...	@@ -15,7 +15,6 @@ import (
15	15	"github.com/docker/docker/daemon/logger/loggerutils"
16	16	units "github.com/docker/go-units"
17	17	"github.com/pkg/errors"
18		- "github.com/sirupsen/logrus"
19	18	)
20	19
21	20	// Name is the name of the file that the jsonlogger logs to.
...	...	@@ -32,10 +31,10 @@ type JSONFileLogger struct {
32	32
33	33	func init() {
34	34	if err := logger.RegisterLogDriver(Name, New); err != nil {
35		- logrus.Fatal(err)
	35	+ panic(err)
36	36	}
37	37	if err := logger.RegisterLogOptValidator(Name, ValidateLogOpt); err != nil {
38		- logrus.Fatal(err)
	38	+ panic(err)
39	39	}
40	40	}
41	41

...	...	@@ -14,7 +14,6 @@ import (
14	14	"github.com/docker/docker/errdefs"
15	15	units "github.com/docker/go-units"
16	16	"github.com/pkg/errors"
17		- "github.com/sirupsen/logrus"
18	17	)
19	18
20	19	const (
...	...	@@ -49,10 +48,10 @@ func ValidateLogOpt(cfg map[string]string) error {
49	49
50	50	func init() {
51	51	if err := logger.RegisterLogDriver(Name, New); err != nil {
52		- logrus.Fatal(err)
	52	+ panic(err)
53	53	}
54	54	if err := logger.RegisterLogOptValidator(Name, ValidateLogOpt); err != nil {
55		- logrus.Fatal(err)
	55	+ panic(err)
56	56	}
57	57	}
58	58

...	...	@@ -29,10 +29,10 @@ const (
29	29
30	30	func init() {
31	31	if err := logger.RegisterLogDriver(name, New); err != nil {
32		- logrus.Fatal(err)
	32	+ panic(err)
33	33	}
34	34	if err := logger.RegisterLogOptValidator(name, ValidateLogOpt); err != nil {
35		- logrus.Fatal(err)
	35	+ panic(err)
36	36	}
37	37	}
38	38

...	...	@@ -16,7 +16,6 @@ import (
16	16	"github.com/docker/docker/daemon/logger"
17	17	"github.com/docker/docker/daemon/logger/loggerutils"
18	18	"github.com/docker/go-connections/tlsconfig"
19		- "github.com/sirupsen/logrus"
20	19	)
21	20
22	21	const (
...	...	@@ -54,10 +53,10 @@ type syslogger struct {
54	54
55	55	func init() {
56	56	if err := logger.RegisterLogDriver(name, New); err != nil {
57		- logrus.Fatal(err)
	57	+ panic(err)
58	58	}
59	59	if err := logger.RegisterLogOptValidator(name, ValidateLogOpt); err != nil {
60		- logrus.Fatal(err)
	60	+ panic(err)
61	61	}
62	62	}
63	63

...	...	@@ -54,8 +54,7 @@ func init() {
54	54
55	55	testEnv, err = environment.New()
56	56	if err != nil {
57		- fmt.Println(err)
58		- os.Exit(1)
	57	+ panic(err)
59	58	}
60	59	}
61	60

...	...	@@ -34,13 +34,11 @@ type NetworkToSplit struct {
34	34	func init() {
35	35	var err error
36	36	if PredefinedGlobalScopeDefaultNetworks, err = splitNetworks(globalScopeDefaultNetworks); err != nil {
37		- //we are going to panic in case of error as we should never get into this state
38		- panic("InitAddressPools failed to initialize the global scope default address pool")
	37	+ panic("failed to initialize the global scope default address pool: " + err.Error())
39	38	}
40	39
41	40	if PredefinedLocalScopeDefaultNetworks, err = splitNetworks(localScopeDefaultNetworks); err != nil {
42		- //we are going to panic in case of error as we should never get into this state
43		- panic("InitAddressPools failed to initialize the local scope default address pool")
	41	+ panic("failed to initialize the local scope default address pool: " + err.Error())
44	42	}
45	43	}
46	44