github-starred/vaultwarden
2
0
Fork 0
mirror of https://github.com/dani-garcia/vaultwarden.git synced 2026-07-16 17:02:14 -05:00
Code Issues 480 Packages Projects Releases 83 Wiki Activity

[PR #6202] [CLOSED] feat: Add comprehensive Prometheus metrics support #20572

New Issue
Closed
opened 2026-04-25 22:35:51 -05:00 by GiteaMirror · 0 comments
GiteaMirror commented 2026-04-25 22:35:51 -05:00
Owner
Copy Link

📋 Pull Request Information

Original PR: https://github.com/dani-garcia/vaultwarden/pull/6202
Author: @rossigee
Created: 8/20/2025
Status: ❌ Closed

Base: main ← Head: feature/prometheus-metrics

📝 Commits (10+)

  • 9ed01ae feat: add comprehensive Prometheus metrics support
  • 0502936 Drop verbose metrics functionality description.
  • a4106ae Drop examples (should be in docs).
  • c9563d6 Remove introduced development dependency.
  • 2b1e989 Whitespace fixes.
  • 387c2e9 Merge branch 'main' into feature/prometheus-metrics
  • 672a1e5 Add Prometheus metrics support
  • 5226d2f fix email as 2fa with auth requests (#6736)
  • b5adeb5 Update crates, web-vault, js, workflows (#6749)
  • 10e4476 refactor: improve tooltips in diagnostics page (#6765)

📊 Changes

20 files changed (+1164 additions, -12 deletions)

View changed files

📝 Cargo.lock (+16 -0)
📝 Cargo.toml (+8 -0)
📝 README.md (+36 -0)
📝 docker/Dockerfile.alpine (+1 -1)
📝 docker/Dockerfile.debian (+1 -1)
📝 docker/Dockerfile.j2 (+2 -2)
➕ examples/metrics-config.env (+100 -0)
📝 src/api/identity.rs (+11 -2)
➕ src/api/metrics.rs (+120 -0)
➕ src/api/middleware.rs (+105 -0)
📝 src/api/mod.rs (+4 -0)
📝 src/api/web.rs (+4 -1)
📝 src/config.rs (+34 -0)
➕ src/db/metrics.rs (+80 -0)
📝 src/db/models/cipher.rs (+68 -0)
📝 src/db/models/organization.rs (+10 -0)
📝 src/db/models/user.rs (+22 -0)
📝 src/main.rs (+29 -5)
➕ src/metrics.rs (+316 -0)
➕ src/metrics_test.rs (+197 -0)

📄 Description

Summary

This PR adds comprehensive Prometheus metrics support to Vaultwarden, providing observability into application performance, database health, authentication patterns, and business metrics.

Key Features

  • Optional metrics endpoint at /metrics (disabled by default)
  • Token-based authentication with support for plain text and Argon2 hashed tokens
  • Comprehensive metric categories: HTTP, database, authentication, business, and system metrics
  • Secure by default: Feature must be explicitly enabled and compiled with --features enable_metrics
  • Production-ready: Path normalization prevents metric explosion, proper error handling

Metrics Categories

  • HTTP Metrics: Request rates, response times, status codes by endpoint
  • Database Metrics: Connection pool utilization, query performance
  • Authentication Metrics: Login attempts, session counts by method and status
  • Business Metrics: User counts, vault items by type, organization data
  • System Metrics: Uptime, build information, version details

Security Considerations

  • Disabled by default - requires explicit ENABLE_METRICS=true
  • Token authentication prevents unauthorized access
  • Path normalization prevents high cardinality issues
  • Network isolation recommended for production

Documentation

  • Complete configuration guide in METRICS.md
  • Comprehensive monitoring setup in MONITORING.md
  • Prometheus/Grafana examples and alerting rules
  • Security best practices and troubleshooting

Test Plan

  • Metrics compilation with feature flag
  • Authentication (no token, valid token, invalid token)
  • Metric format validation (Prometheus format)
  • All metric categories populated correctly
  • Path normalization working
  • Docker build with metrics feature
  • Security token hashing (Argon2)

Breaking Changes

None - this is an optional feature that's disabled by default.

Files Added/Modified

  • New: src/api/metrics.rs - Metrics endpoint implementation
  • New: METRICS.md - Configuration and usage guide
  • New: MONITORING.md - Complete monitoring setup guide
  • New: examples/metrics-config.env - Configuration examples
  • New: scripts/test-metrics.sh - Testing script
  • Modified: Cargo.toml - Added optional prometheus dependency
  • Modified: README.md - Added metrics feature documentation
  • Modified: docker/Dockerfile.debian - Support for extra features in build

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/dani-garcia/vaultwarden/pull/6202 **Author:** [@rossigee](https://github.com/rossigee) **Created:** 8/20/2025 **Status:** ❌ Closed **Base:** `main` ← **Head:** `feature/prometheus-metrics` --- ### 📝 Commits (10+) - [`9ed01ae`](https://github.com/dani-garcia/vaultwarden/commit/9ed01ae9eb38469ad3be79596b43316079d88530) feat: add comprehensive Prometheus metrics support - [`0502936`](https://github.com/dani-garcia/vaultwarden/commit/05029365ee08669ab69a8ed7c2aedf927149132e) Drop verbose metrics functionality description. - [`a4106ae`](https://github.com/dani-garcia/vaultwarden/commit/a4106aeb4c35d7cacaf7f8e68727e8d454f3be11) Drop examples (should be in docs). - [`c9563d6`](https://github.com/dani-garcia/vaultwarden/commit/c9563d6c241110044b47e196799ffb0451e8a402) Remove introduced development dependency. - [`2b1e989`](https://github.com/dani-garcia/vaultwarden/commit/2b1e9890dc7e1578852e5a18bb8810eddc91407c) Whitespace fixes. - [`387c2e9`](https://github.com/dani-garcia/vaultwarden/commit/387c2e90829ba15713d05db9cf7b91a88fa77163) Merge branch 'main' into feature/prometheus-metrics - [`672a1e5`](https://github.com/dani-garcia/vaultwarden/commit/672a1e5c7207a10fd04365ce66cc953695be5f7d) Add Prometheus metrics support - [`5226d2f`](https://github.com/dani-garcia/vaultwarden/commit/5226d2f580d846a51829d61a760b1cd1e863d9fa) fix email as 2fa with auth requests (#6736) - [`b5adeb5`](https://github.com/dani-garcia/vaultwarden/commit/b5adeb5569af98dd31cde1d09cda7f4ce1bb02a8) Update crates, web-vault, js, workflows (#6749) - [`10e4476`](https://github.com/dani-garcia/vaultwarden/commit/10e4476743c246266a4e6af79f317662002b587f) refactor: improve tooltips in diagnostics page (#6765) ### 📊 Changes **20 files changed** (+1164 additions, -12 deletions) <details> <summary>View changed files</summary> 📝 `Cargo.lock` (+16 -0) 📝 `Cargo.toml` (+8 -0) 📝 `README.md` (+36 -0) 📝 `docker/Dockerfile.alpine` (+1 -1) 📝 `docker/Dockerfile.debian` (+1 -1) 📝 `docker/Dockerfile.j2` (+2 -2) ➕ `examples/metrics-config.env` (+100 -0) 📝 `src/api/identity.rs` (+11 -2) ➕ `src/api/metrics.rs` (+120 -0) ➕ `src/api/middleware.rs` (+105 -0) 📝 `src/api/mod.rs` (+4 -0) 📝 `src/api/web.rs` (+4 -1) 📝 `src/config.rs` (+34 -0) ➕ `src/db/metrics.rs` (+80 -0) 📝 `src/db/models/cipher.rs` (+68 -0) 📝 `src/db/models/organization.rs` (+10 -0) 📝 `src/db/models/user.rs` (+22 -0) 📝 `src/main.rs` (+29 -5) ➕ `src/metrics.rs` (+316 -0) ➕ `src/metrics_test.rs` (+197 -0) </details> ### 📄 Description ## Summary This PR adds comprehensive Prometheus metrics support to Vaultwarden, providing observability into application performance, database health, authentication patterns, and business metrics. ### Key Features - **Optional metrics endpoint** at `/metrics` (disabled by default) - **Token-based authentication** with support for plain text and Argon2 hashed tokens - **Comprehensive metric categories**: HTTP, database, authentication, business, and system metrics - **Secure by default**: Feature must be explicitly enabled and compiled with `--features enable_metrics` - **Production-ready**: Path normalization prevents metric explosion, proper error handling ### Metrics Categories - **HTTP Metrics**: Request rates, response times, status codes by endpoint - **Database Metrics**: Connection pool utilization, query performance - **Authentication Metrics**: Login attempts, session counts by method and status - **Business Metrics**: User counts, vault items by type, organization data - **System Metrics**: Uptime, build information, version details ### Security Considerations - Disabled by default - requires explicit `ENABLE_METRICS=true` - Token authentication prevents unauthorized access - Path normalization prevents high cardinality issues - Network isolation recommended for production ### Documentation - Complete configuration guide in `METRICS.md` - Comprehensive monitoring setup in `MONITORING.md` - Prometheus/Grafana examples and alerting rules - Security best practices and troubleshooting ### Test Plan - [x] Metrics compilation with feature flag - [x] Authentication (no token, valid token, invalid token) - [x] Metric format validation (Prometheus format) - [x] All metric categories populated correctly - [x] Path normalization working - [x] Docker build with metrics feature - [x] Security token hashing (Argon2) ### Breaking Changes None - this is an optional feature that's disabled by default. ### Files Added/Modified - New: `src/api/metrics.rs` - Metrics endpoint implementation - New: `METRICS.md` - Configuration and usage guide - New: `MONITORING.md` - Complete monitoring setup guide - New: `examples/metrics-config.env` - Configuration examples - New: `scripts/test-metrics.sh` - Testing script - Modified: `Cargo.toml` - Added optional prometheus dependency - Modified: `README.md` - Added metrics feature documentation - Modified: `docker/Dockerfile.debian` - Support for extra features in build --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
GiteaMirror added the pull-request label 2026-04-25 22:35:51 -05:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
better for forum
bug
documentation
duplicate
enhancement
future Vault
good first issue
help wanted
low priority
notes
pull-request
Mirrored from GitHub Pull Request
 question
SSO
Third party
troubleshooting
wontfix
No Label pull-request
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
GiteaMirror ninjasurge
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/vaultwarden#20572
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?