agent: remove leading whitespace from agent log lines #10338
Conversation
The version args are static and passed in from the caller. Instead read the static values in New. The shutdownCh was never closed, so did nothing. Remove it as a field and an arg.
This will allow commands to do the right thing, and write to the proper output stream.
Remove the leading whitespace on every log line. This was causing problems for a customer because their logging system was interpretting the logs as a single multi-line log.
Previously this line was mixed up with logging, which made the output quite ugly. Use the logger to output this message, instead of printing directly to stdout. This has the advantage that the message will be visible when json logs are enabled.
The intent of this struct was to prevent non-json output to stdout. With the previous cleanup, this can now be done by simply changing the stdout stream to io.Discard. This is just one example of why passing around io.Writers for the streams is better than the UI interface.
github-actions
bot
added
the
theme/cli
| // FIXME: logs should always go to stderr, but previously they were sent to | ||
| // stdout, so continue to use Stdout for now, and fix this in a future release. | ||
| logGate := &logging.GatedWriter{Writer: c.ui.Stdout()} |
There was a problem hiding this comment.
This is the fix for the primary issue, but other changes were required to make this possible.
| @@ -119,7 +113,7 @@ func (c *cmd) startupJoin(agent *agent.Agent, cfg *config.RuntimeConfig) error { | |||
| return nil | |||
| } | |||
|
|
|||
| c.UI.Output("Joining cluster...") | |||
| c.logger.Info("Joining cluster") | |||
There was a problem hiding this comment.
This change to use a logger (and mentioned in the commit message). Using the logger for this seems much better, that way the output is not lost when json logging is enabled.
Same below.
| return 1 | ||
| } | ||
|
|
||
| // Let the agent know we've finished registration | ||
| agent.StartSync() | ||
|
|
||
| cli.output("Consul agent running!") | ||
| c.logger.Info("Consul agent running!") |
There was a problem hiding this comment.
This also changed to use the logger (as mentioned in the commit message). Previously this was leading to very odd looking output, where the log lines were broken up by a random ==> Consul agent running!" line.
With this change the message will be included in the logs when json logs are enabled.
| case <-c.shutdownCh: | ||
| sig = os.Interrupt |
There was a problem hiding this comment.
This was removed because it did nothing (the channel was never closed), and we already have a case for handling signals.
|
🍒 If backport labels were added before merging, cherry-picking will start automatically. To retroactively trigger a backport after merging, add backport labels and re-run https://circleci.com/gh/hashicorp/consul/380243. |
|
🍒✅ Cherry pick of commit f204daf onto |
agent: remove leading whitespace from agent log lines
agent: remove leading whitespace from agent log lines
This PR fixes a problem reported by a user:
Every log line had 4 spaces prepended. This was caused by the
UIinterface that is used in the CLI. We have encountered a number of problems with theUIinterface. This PR takes the first step to fix the interface by exposing the underlying Stdout/Stderr streams asio.Writer.The PR includes some other cleanup, and is best viewed by individual commit.
I tested this by running
consul agent -devandconsul agent -dev -log-jsonto verify it worked as it did before, with the exception of the leading spaces and other small improvements which I have commented on below.