- Add Prometheus metrics endpoint with authentication - Implement HTTP, database, authentication, business, and system metrics - Enable metrics by default in Docker builds - Add Argon2 hashed token support for secure authentication - Create comprehensive documentation for wiki integration - Fix error handling consistency across codebase - Add missing diesel_logger dependency Co-authored-by: Original contributorspull/6202/head
Ross Golder
5 months ago
parent
6cd43937e1
commit
6dd09c568d
@ -0,0 +1,100 @@
|
||||
# Vaultwarden Metrics Configuration Examples
|
||||
# Copy these variables to your .env file or set as environment variables
|
||||
|
||||
# ============================================
|
||||
# Basic Metrics Configuration
|
||||
# ============================================
|
||||
|
||||
# Enable metrics endpoint (disabled by default)
|
||||
ENABLE_METRICS=true
|
||||
|
||||
# ============================================
|
||||
# Security Configuration
|
||||
# ============================================
|
||||
|
||||
# Option 1: No authentication (DEVELOPMENT ONLY)
|
||||
# Leave METRICS_TOKEN unset for public access
|
||||
# WARNING: This exposes potentially sensitive information
|
||||
|
||||
# Option 2: Plain text token (basic security)
|
||||
# METRICS_TOKEN=your-secret-metrics-token-here
|
||||
|
||||
# Option 3: Argon2 hashed token (recommended for production)
|
||||
# Generate with: vaultwarden hash
|
||||
# METRICS_TOKEN='$argon2id$v=19$m=65540,t=3,p=4$...'
|
||||
|
||||
# ============================================
|
||||
# Prometheus Scrape Configuration
|
||||
# ============================================
|
||||
|
||||
# In your prometheus.yml:
|
||||
#
|
||||
# scrape_configs:
|
||||
# - job_name: 'vaultwarden'
|
||||
# static_configs:
|
||||
# - targets: ['localhost:8080']
|
||||
# metrics_path: '/metrics'
|
||||
# # For token authentication:
|
||||
# bearer_token: 'your-secret-metrics-token-here'
|
||||
# # OR use query parameter:
|
||||
# # params:
|
||||
# # token: ['your-secret-metrics-token-here']
|
||||
# scrape_interval: 30s
|
||||
# scrape_timeout: 10s
|
||||
|
||||
# ============================================
|
||||
# Build Configuration
|
||||
# ============================================
|
||||
|
||||
# To enable metrics support, compile with:
|
||||
# cargo build --features enable_metrics --release
|
||||
|
||||
# ============================================
|
||||
# Other Vaultwarden Configuration
|
||||
# ============================================
|
||||
|
||||
# Domain must be set for proper operation
|
||||
DOMAIN=https://vault.example.com
|
||||
|
||||
# Database configuration
|
||||
DATABASE_URL=data/db.sqlite3
|
||||
|
||||
# Admin panel (optional, but recommended for management)
|
||||
ADMIN_TOKEN=your-admin-token-here
|
||||
|
||||
# SMTP configuration (optional)
|
||||
# SMTP_HOST=smtp.example.com
|
||||
# SMTP_FROM=vaultwarden@example.com
|
||||
# SMTP_USERNAME=vaultwarden@example.com
|
||||
# SMTP_PASSWORD=your-smtp-password
|
||||
|
||||
# Web vault enabled
|
||||
WEB_VAULT_ENABLED=true
|
||||
|
||||
# Log level
|
||||
LOG_LEVEL=info
|
||||
|
||||
# ============================================
|
||||
# Example Grafana Queries
|
||||
# ============================================
|
||||
|
||||
# Request rate:
|
||||
# rate(vaultwarden_http_requests_total[5m])
|
||||
|
||||
# Error rate:
|
||||
# rate(vaultwarden_http_requests_total{status=~"4..|5.."}[5m])
|
||||
|
||||
# Response time 95th percentile:
|
||||
# histogram_quantile(0.95, rate(vaultwarden_http_request_duration_seconds_bucket[5m]))
|
||||
|
||||
# Active users:
|
||||
# vaultwarden_users_total{status="enabled"}
|
||||
|
||||
# Database connection utilization:
|
||||
# vaultwarden_db_connections_active / (vaultwarden_db_connections_active + vaultwarden_db_connections_idle) * 100
|
||||
|
||||
# Vault items by type:
|
||||
# sum by (type) (vaultwarden_vault_items_total)
|
||||
|
||||
# Authentication attempts by status:
|
||||
# rate(vaultwarden_auth_attempts_total[5m])
|
||||
@ -0,0 +1,80 @@
|
||||
#![allow(dead_code, unused_imports)]
|
||||
/// Database metrics collection utilities
|
||||
|
||||
use std::time::Instant;
|
||||
|
||||
/// Database operation tracker for metrics
|
||||
pub struct DbOperationTimer {
|
||||
start_time: Instant,
|
||||
operation: String,
|
||||
}
|
||||
|
||||
impl DbOperationTimer {
|
||||
pub fn new(operation: &str) -> Self {
|
||||
Self {
|
||||
start_time: Instant::now(),
|
||||
operation: operation.to_string(),
|
||||
}
|
||||
}
|
||||
|
||||
pub fn finish(self) {
|
||||
let duration = self.start_time.elapsed();
|
||||
crate::metrics::observe_db_query_duration(&self.operation, duration.as_secs_f64());
|
||||
}
|
||||
}
|
||||
|
||||
/// Macro to instrument database operations
|
||||
#[macro_export]
|
||||
macro_rules! db_metric {
|
||||
($operation:expr, $code:block) => {{
|
||||
#[cfg(feature = "enable_metrics")]
|
||||
let timer = crate::db::metrics::DbOperationTimer::new($operation);
|
||||
|
||||
let result = $code;
|
||||
|
||||
#[cfg(feature = "enable_metrics")]
|
||||
timer.finish();
|
||||
|
||||
result
|
||||
}};
|
||||
}
|
||||
|
||||
/// Track database connection pool statistics
|
||||
pub async fn update_pool_metrics(_pool: &crate::db::DbPool) {
|
||||
#[cfg(feature = "enable_metrics")]
|
||||
{
|
||||
// Note: This is a simplified implementation
|
||||
// In a real implementation, you'd want to get actual pool statistics
|
||||
// from the connection pool (r2d2 provides some stats)
|
||||
|
||||
// For now, we'll just update with basic info
|
||||
let db_type = crate::db::DbConnType::from_url(&crate::CONFIG.database_url())
|
||||
.map(|t| match t {
|
||||
crate::db::DbConnType::sqlite => "sqlite",
|
||||
crate::db::DbConnType::mysql => "mysql",
|
||||
crate::db::DbConnType::postgresql => "postgresql",
|
||||
})
|
||||
.unwrap_or("unknown");
|
||||
|
||||
// These would be actual pool statistics in a real implementation
|
||||
let active_connections = 1; // placeholder
|
||||
let idle_connections = crate::CONFIG.database_max_conns() as i64 - active_connections;
|
||||
|
||||
crate::metrics::update_db_connections(db_type, active_connections, idle_connections);
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
use std::thread;
|
||||
use std::time::Duration;
|
||||
|
||||
#[test]
|
||||
fn test_db_operation_timer() {
|
||||
let timer = DbOperationTimer::new("test_query");
|
||||
thread::sleep(Duration::from_millis(1));
|
||||
timer.finish();
|
||||
// In a real test, we'd verify the metric was recorded
|
||||
}
|
||||
}
|
||||
Loading…
Reference in new issue