[VAULT-33970] Ensure logger writes to log_file by preventing overwrite of InterceptLogger's output #29917
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This fixes a bug with how vault handles logging to the log_file in configuration.
Initially,
ServerCommand.run
sets up a gated writer to standard error, which is passed through configureLogging tologhelper.Setup
. This setup combines the gated writer with a file (log_file) using a multiwriter, ensuring logs go to both destinations. Later inserver.Run
, vault flushes the gated writer by calling the functionResetOutputWithFlush
. Unfortunately, this replaces the InterceptLogger’s output with a single writer that logs only to standard error. Some logs still get written to both destinations. This is likely because vault defines some subloggers (like core) before the flush occurs. Naming a sublogger creates a copy of the underlying writer, which remains connected to the original multiwriter.As a result, loggers created before the flush continue to log to both standard error and the file, while the base logger’s writer gets reset to standard error. This PR removes the logic that replaces the InterceptLogger's output, and instead just flushes the gated writer.
I did some digging into why we introduced the
ResetOutputWithFlush
function in the first place and found this PR. Originally, it seems we replaced the gated writer with regular standard err to avoid a dealing with mutexes, but right now we're just replacing the multiwriter (which includes the gated writer) with another gated writer, so I don't think we're reaping the benefit anymore. Simply flushing the gated writer also matches what we do in agent and proxy.TODO only if you're a HashiCorp employee
backport/
label that matches the desired release branch. Note that in the CE repo, the latest release branch will look likebackport/x.x.x
, but older release branches will bebackport/ent/x.x.x+ent
.of a public function, even if that change is in a CE file, double check that
applying the patch for this PR to the ENT repo and running tests doesn't
break any tests. Sometimes ENT only tests rely on public functions in CE
files.
in the PR description, commit message, or branch name.
description. Also, make sure the changelog is in this PR, not in your ENT PR.