Skip to content
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

VAULT-31409: trace unsealInternal function #28895

Draft
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

bosouza
Copy link

@bosouza bosouza commented Nov 13, 2024

Description

This PR adds the environment variable VAULT_ENABLE_UNSEAL_TRACE that when enabled will cause Vault to write a Go trace file to the /tmp directory, like /tmp/trace_unsealInternal_2024-11-13T12:06:13-03:00. This file can be inspected using the go tool trace command and will help us debug cases where the unseal operation takes too long.

Jira: VAULT-31409

TODO only if you're a HashiCorp employee

  • Backport Labels: If this PR is in the ENT repo and needs to be backported, backport
    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 the backport/x.x.x label, not the enterprise labels.
    • 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.

@github-actions github-actions bot added the hashicorp-contributed-pr If the PR is HashiCorp (i.e. not-community) contributed label Nov 13, 2024
Copy link

github-actions bot commented Nov 13, 2024

CI Results: failed ❌
Failures:

Test Type Package Test Logs
standard command/server TestConfig_Sanitized view test results
standard http TestSysConfigState_Sanitized view test results
standard http TestSysConfigState_Sanitized/inmem_storage,_no_HA_storage view test results
standard http TestSysConfigState_Sanitized/inmem_storage,_raft_HA_storage view test results
standard http TestSysConfigState_Sanitized/raft_storage view test results

helper/trace/debug_trace.go Show resolved Hide resolved
helper/trace/debug_trace.go Show resolved Hide resolved
vault/core.go Show resolved Hide resolved
Comment on lines +14 to +15
path := fmt.Sprintf("%s/%s_%s", os.TempDir(), filePrefix, time.Now().Format(time.RFC3339))
traceFile, err := os.Create(path)
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

still want to make this more similar to VAULT_STACKTRACE_WRITE_TO_FILE for the sake of consistency

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