release log gate if disable-gated-logs flag is set (#24280) (#24475)

* release log gate if disable-gated-logs flag is set * CL * Update changelog/24280.txt --------- Co-authored-by: Peter Wilson <[email protected]> Co-authored-by: Josh Black <[email protected]>
hashicorp · Dec 11, 2023 · 96cfe2c · 96cfe2c
1 parent 77d4cad
commit 96cfe2c
Show file tree

Hide file tree

Showing 5 changed files with 23 additions and 0 deletions.
diff --git a/changelog/24280.txt b/changelog/24280.txt
@@ -0,0 +1,3 @@
+```release-note:improvement
+command/server: display logs on startup immediately if disable-gated-logs flag is set
+```
diff --git a/command/agent.go b/command/agent.go
@@ -221,6 +221,11 @@ func (c *AgentCommand) Run(args []string) int {
 	}
 	c.logger = l
 
+	// release log gate if the disable-gated-logs flag is set
+	if c.logFlags.flagDisableGatedLogs {
+		c.logGate.Flush()
+	}
+
 	infoKeys := make([]string, 0, 10)
 	info := make(map[string]string)
 	info["log level"] = config.LogLevel

diff --git a/command/commands.go b/command/commands.go
@@ -149,6 +149,8 @@ const (
 	flagNameDisableRedirects = "disable-redirects"
 	// flagNameCombineLogs is used to specify whether log output should be combined and sent to stdout
 	flagNameCombineLogs = "combine-logs"
+	// flagDisableGatedLogs is used to disable gated logs and immediately show the vault logs as they become available
+	flagDisableGatedLogs = "disable-gated-logs"
 	// flagNameLogFile is used to specify the path to the log file that Vault should use for logging
 	flagNameLogFile = "log-file"
 	// flagNameLogRotateBytes is the flag used to specify the number of bytes a log file should be before it is rotated.

diff --git a/command/log_flags.go b/command/log_flags.go
@@ -12,6 +12,7 @@ import (
 // logFlags are the 'log' related flags that can be shared across commands.
 type logFlags struct {
 	flagCombineLogs       bool
+	flagDisableGatedLogs  bool
 	flagLogLevel          string
 	flagLogFormat         string
 	flagLogFile           string
@@ -38,6 +39,13 @@ func (f *FlagSet) addLogFlags(l *logFlags) {
 		Hidden:  true,
 	})
 
+	f.BoolVar(&BoolVar{
+		Name:    flagDisableGatedLogs,
+		Target:  &l.flagDisableGatedLogs,
+		Default: false,
+		Hidden:  true,
+	})
+
 	f.StringVar(&StringVar{
 		Name:       flagNameLogLevel,
 		Target:     &l.flagLogLevel,

diff --git a/command/server.go b/command/server.go
@@ -1077,6 +1077,11 @@ func (c *ServerCommand) Run(args []string) int {
 	c.logger = l
 	c.allLoggers = append(c.allLoggers, l)
 
+	// flush logs right away if the server is started with the disable-gated-logs flag
+	if c.logFlags.flagDisableGatedLogs {
+		c.flushLog()
+	}
+
 	// reporting Errors found in the config
 	for _, cErr := range configErrors {
 		c.logger.Warn(cErr.String())