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

Backport of Audit: explain 'failure' metrics better into release/1.17.x #27956

Conversation

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

Backport

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

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


Description

There has been confusion around the vault.audit.log_request_failure and vault.audit.log_response_failure metrics, which are documented as counters.

The metrics emit a number of values that can be checked e.g. count, mean, min... the count for this metric just indicates how many times it was called, however Vault will increment the metric on every success or failure (supplying either the value 0 or 1 respectively). This is done so that systems like Prometheus don't 'forget' the metric if they don't see it fail for a while.

HashiCorp Checklist

  • Labels: If this PR is the CE portion of an ENT change, and that ENT change is
    getting backported to N-2, use the new style backport/ent/x.x.x+ent labels
    instead of the old style backport/x.x.x labels.
  • Labels: If this PR is a CE only change, it can only be backported to N, so use
    the normal backport/x.x.x label (there should be only 1).
  • 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/peteski22/docs/audit-telemetry-failure-clarification/oddly-lucky-opossum branch from bce7b3c to 2fe7d40 Compare August 2, 2024 19:21
@github-actions github-actions bot added the hashicorp-contributed-pr If the PR is HashiCorp (i.e. not-community) contributed label Aug 2, 2024
Copy link

github-actions bot commented Aug 2, 2024

CI Results:
All Go tests succeeded! ✅

Copy link

github-actions bot commented Aug 2, 2024

Build Results:
All builds succeeded! ✅

@peteski22 peteski22 merged commit 7ab6024 into release/1.17.x Aug 2, 2024
22 of 24 checks passed
@peteski22 peteski22 deleted the backport/peteski22/docs/audit-telemetry-failure-clarification/oddly-lucky-opossum branch August 2, 2024 19:24
Copy link
Collaborator

@JMGoldsmith JMGoldsmith left a comment

Choose a reason for hiding this comment

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

lgtm, I think the mention of the mean should be sufficient.

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.

3 participants