Backport of VAULT-31409: trace postUnseal function into release/1.18.x #29030
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.
Backport
This PR is auto-generated from #28895 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 PR adds 2 new settings to the top-level Vault server configuration:
enable_post_unseal_trace
that when enabled will cause Vault to generate a Go trace during the execution ofcore.postUnseal
and save it to disk under the directory configured inpost_unseal_trace_dir
, defaulting to/tmp/vault-traces/
instead if the field isn't set. This file can be inspected using thego tool trace
command and will help us debug cases where the leadership transfer operation takes too long.Most of the feature was split into a reusable
StartDebugTrace
function in a separate package. It could be used for similar debug purposes in the future but most importantly for now it avoids adding more code and dependencies to the already-bloatedcore
package.Manually tested the functionality to ensure that it was possible to generate the traces by updating the new fields in the config, then sending a
SIGHUP
signal to the running Vault process and triggering a leadership election viavault operator step-down
. Disabling the generation of the traces via the sameSIGHUP
process also works. Post-unseal only runs on the active node so restarting a follower won't generate the post-unseal traces.Jira: VAULT-31409
TODO only if you're a HashiCorp employee
to N, N-1, and N-2, using the
backport/ent/x.x.x+ent
labels. If this PR is in the CE repo, you should only backport to N, using thebackport/x.x.x
label, not the enterprise labels.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.
Overview of commits