Skip to content

Backport of Ensure logger writes to log_file by preventing overwrite of InterceptLogger's output into release/1.18.x #29918

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Conversation

hc-github-team-secure-vault-core
Copy link
Collaborator

Backport

This PR is auto-generated from #29917 to be assessed for backporting due to the inclusion of the label backport/1.18.x.

The below text is copied from the body of the original PR.


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 to loghelper.Setup. This setup combines the gated writer with a file (log_file) using a multiwriter, ensuring logs go to both destinations. Later in server.Run, vault flushes the gated writer by calling the function ResetOutputWithFlush. 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 Labels: If this fix needs to be backported, use the appropriate backport/ label that matches the desired release branch. Note that in the CE repo, the latest release branch will look like backport/x.x.x, but older release branches will be backport/ent/x.x.x+ent.
    • LTS: If this fixes a critical security vulnerability or severity 1 bug, it will also need to be backported to the current LTS versions of Vault. To ensure this, use all available enterprise labels.
  • ENT Breakage: If this PR either 1) removes a public function OR 2) changes the signature
    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.
  • Jira: If this change has an associated Jira, it's referenced either
    in the PR description, commit message, or branch name.
  • RFC: If this change has an associated RFC, please link it in the description.
  • ENT PR: If this change has an associated ENT PR, please link it in the
    description. Also, make sure the changelog is in this PR, not in your ENT PR.

Overview of commits

@hc-github-team-secure-vault-core hc-github-team-secure-vault-core force-pushed the backport/elliesterner/loggate-flush/reliably-tidy-aardvark branch from d1be998 to f860bd8 Compare March 13, 2025 18:44
@github-actions github-actions bot added the hashicorp-contributed-pr If the PR is HashiCorp (i.e. not-community) contributed label Mar 13, 2025
@elliesterner elliesterner added this to the 1.18.7 milestone Mar 13, 2025
Copy link

CI Results:
All Go tests succeeded! ✅

Copy link

Build Results:
All builds succeeded! ✅

@elliesterner elliesterner merged commit 5fa7a50 into release/1.18.x Mar 13, 2025
83 of 84 checks passed
@elliesterner elliesterner deleted the backport/elliesterner/loggate-flush/reliably-tidy-aardvark branch March 13, 2025 19:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
hashicorp-contributed-pr If the PR is HashiCorp (i.e. not-community) contributed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants