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.

Sign up for GitHub

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

Jump to bottom

Audit: explain 'failure' metrics better #27955

Merged
merged 1 commit into from
Aug 2, 2024
Merged

Audit: explain 'failure' metrics better #27955

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions website/content/partials/telemetry-metrics/vault/audit/log_request_failure.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,17 @@
### vault.audit.log_request_failure ((#vault-audit-log_request_failure))

| Metric type | Value | Description |
|-------------|--------|---------------------------------------------------------|
| counter | number | Number of audit log request failures across all devices |
| Metric type | Value | Description |
|-------------|--------|-------------------------------------------------------------------------------------------|
| gauge | number | Average (mean) number of audit log request failures across all devices during time period |

The number of request failures is a **crucial metric**.

A non-zero value for `vault.audit.log_request_failure` indicates that all your
configured audit devices failed to log a request (or response). If Vault cannot
A non-zero value for `vault.audit.log_request_failure` indicates that all
the configured audit devices failed to log a request (or response). If Vault cannot
properly audit a request, or the response to a request, the original request
will fail.

The `mean` value for this metric should be monitored, not the `count` which could be misleading.

Refer to the Vault logs and any device-specific metrics to troubleshoot the
failing audit log device.
12 changes: 7 additions & 5 deletions website/content/partials/telemetry-metrics/vault/audit/log_response_failure.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,17 @@
### vault.audit.log_response_failure ((#vault-audit-log_response_failure))

| Metric type | Value | Description |
|-------------|--------|---------------------------------------------------------|
| counter | number | Number of audit log response failures across all devices |
| Metric type | Value | Description |
|-------------|--------|--------------------------------------------------------------------------------------------|
| gauge | number | Average (mean) number of audit log response failures across all devices during time period |

The number of request failures is a **crucial metric**.

A non-zero value for `vault.audit.log_response_failure` indicates that all of
the configured audit log devices failed to log a response to a request to Vault. If Vault cannot
A non-zero value for `vault.audit.log_response_failure` indicates that all
the configured audit log devices failed to log a response to a request. If Vault cannot
properly audit a request, or the response to a request, the original request
will fail.

The `mean` value for this metric should be monitored, not the `count` which could be misleading.

Refer to the device-specific metrics and logs to troubleshoot the failing audit
log device.
Loading