mirror of
https://github.com/rustfs/rustfs.git
synced 2026-08-22 04:16:38 +00:00
feat(ecstore): add object lock diagnostics (#3178)
* feat(ecstore): add object lock diagnostics Add configurable namespace lock diagnostics for object operations so production contention can be traced by operation, owner, and key. Wrap object read/write lock acquisition in diagnostic guards across get, head, put, delete, copy, and multipart flows, and log slow acquisition and long hold durations behind new RUSTFS_OBJECT_LOCK_DIAG_* settings. Verification: - make pre-commit * feat(obs): expose object lock diagnostics metrics Add Prometheus metrics and Grafana panels for object namespace lock diagnostics, covering slow acquire counts, slow hold counts, acquire duration, hold duration, and the diagnostics-enabled state. Adopt PR review feedback by keeping diagnostic guards alive through the guarded operation so long-hold warnings and metrics are emitted, reusing shared env helpers, and reducing default-path overhead when diagnostics are disabled. Verification: - cargo check -p rustfs-ecstore -p rustfs-io-metrics - cargo test -p rustfs-ecstore store::object -- --nocapture - make pre-commit * perf(obs): reduce object lock diag overhead Avoid repeated environment parsing on hot object-lock paths by caching the diagnostics-enabled flag, and stop allocating label strings for object lock metrics by recording static labels directly. Strengthen io-metrics tests by using a local recorder and asserting that the expected object lock diagnostic counters, gauges, and histograms are emitted. Verification: - cargo check -p rustfs-ecstore -p rustfs-io-metrics - cargo test -p rustfs-io-metrics -- --nocapture - make pre-commit
This commit is contained in:
@@ -112,7 +112,8 @@ pub use deadlock_metrics::{
|
||||
// Lock metrics exports
|
||||
pub use lock_metrics::{
|
||||
LockMetricsSummary, record_contention_event, record_early_release, record_lock_hold_time, record_lock_optimization_enabled,
|
||||
record_spin_attempt, record_spin_count_change,
|
||||
record_object_lock_diag_acquire_duration, record_object_lock_diag_enabled, record_object_lock_diag_hold_duration,
|
||||
record_object_lock_diag_slow_acquire, record_object_lock_diag_slow_hold, record_spin_attempt, record_spin_count_change,
|
||||
};
|
||||
|
||||
pub use process_lock_metrics::{
|
||||
|
||||
@@ -62,6 +62,61 @@ pub fn record_contention_event() {
|
||||
counter!("rustfs_lock_contentions").increment(1);
|
||||
}
|
||||
|
||||
/// Record object namespace lock diagnostics being enabled.
|
||||
#[inline(always)]
|
||||
pub fn record_object_lock_diag_enabled(enabled: bool) {
|
||||
use metrics::gauge;
|
||||
gauge!("rustfs_object_lock_diag_enabled").set(if enabled { 1.0 } else { 0.0 });
|
||||
}
|
||||
|
||||
/// Record object namespace lock acquire duration.
|
||||
#[inline(always)]
|
||||
pub fn record_object_lock_diag_acquire_duration(op: &'static str, mode: &'static str, duration: Duration) {
|
||||
use metrics::histogram;
|
||||
histogram!(
|
||||
"rustfs_object_lock_diag_acquire_duration_seconds",
|
||||
"op" => op,
|
||||
"mode" => mode
|
||||
)
|
||||
.record(duration.as_secs_f64());
|
||||
}
|
||||
|
||||
/// Record object namespace lock hold duration.
|
||||
#[inline(always)]
|
||||
pub fn record_object_lock_diag_hold_duration(op: &'static str, mode: &'static str, duration: Duration) {
|
||||
use metrics::histogram;
|
||||
histogram!(
|
||||
"rustfs_object_lock_diag_hold_duration_seconds",
|
||||
"op" => op,
|
||||
"mode" => mode
|
||||
)
|
||||
.record(duration.as_secs_f64());
|
||||
}
|
||||
|
||||
/// Record an object namespace lock slow-acquire event.
|
||||
#[inline(always)]
|
||||
pub fn record_object_lock_diag_slow_acquire(op: &'static str, mode: &'static str) {
|
||||
use metrics::counter;
|
||||
counter!(
|
||||
"rustfs_object_lock_diag_slow_acquire_total",
|
||||
"op" => op,
|
||||
"mode" => mode
|
||||
)
|
||||
.increment(1);
|
||||
}
|
||||
|
||||
/// Record an object namespace lock slow-hold event.
|
||||
#[inline(always)]
|
||||
pub fn record_object_lock_diag_slow_hold(op: &'static str, mode: &'static str) {
|
||||
use metrics::counter;
|
||||
counter!(
|
||||
"rustfs_object_lock_diag_slow_hold_total",
|
||||
"op" => op,
|
||||
"mode" => mode
|
||||
)
|
||||
.increment(1);
|
||||
}
|
||||
|
||||
/// Lock statistics summary.
|
||||
#[derive(Debug, Clone, Default)]
|
||||
pub struct LockMetricsSummary {
|
||||
@@ -108,6 +163,97 @@ impl LockMetricsSummary {
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
use metrics::{Counter, CounterFn, Gauge, GaugeFn, Histogram, HistogramFn, Key, KeyName, Metadata, SharedString, Unit};
|
||||
use std::sync::{Arc, Mutex};
|
||||
|
||||
#[derive(Clone, Default)]
|
||||
struct SeenMetricsRecorder {
|
||||
counters: Arc<Mutex<Vec<Key>>>,
|
||||
gauges: Arc<Mutex<Vec<Key>>>,
|
||||
histograms: Arc<Mutex<Vec<Key>>>,
|
||||
}
|
||||
|
||||
impl SeenMetricsRecorder {
|
||||
fn saw_counter_named(&self, name: &str) -> bool {
|
||||
self.counters
|
||||
.lock()
|
||||
.expect("counter key collection should be lockable")
|
||||
.iter()
|
||||
.any(|key| key.name() == name)
|
||||
}
|
||||
|
||||
fn saw_gauge_named(&self, name: &str) -> bool {
|
||||
self.gauges
|
||||
.lock()
|
||||
.expect("gauge key collection should be lockable")
|
||||
.iter()
|
||||
.any(|key| key.name() == name)
|
||||
}
|
||||
|
||||
fn saw_histogram_named(&self, name: &str) -> bool {
|
||||
self.histograms
|
||||
.lock()
|
||||
.expect("histogram key collection should be lockable")
|
||||
.iter()
|
||||
.any(|key| key.name() == name)
|
||||
}
|
||||
}
|
||||
|
||||
impl metrics::Recorder for SeenMetricsRecorder {
|
||||
fn describe_counter(&self, _key: KeyName, _unit: Option<Unit>, _description: SharedString) {}
|
||||
|
||||
fn describe_gauge(&self, _key: KeyName, _unit: Option<Unit>, _description: SharedString) {}
|
||||
|
||||
fn describe_histogram(&self, _key: KeyName, _unit: Option<Unit>, _description: SharedString) {}
|
||||
|
||||
fn register_counter(&self, key: &Key, _metadata: &Metadata<'_>) -> Counter {
|
||||
self.counters
|
||||
.lock()
|
||||
.expect("counter key collection should be lockable")
|
||||
.push(key.clone());
|
||||
Counter::from_arc(Arc::new(NoopCounter))
|
||||
}
|
||||
|
||||
fn register_gauge(&self, key: &Key, _metadata: &Metadata<'_>) -> Gauge {
|
||||
self.gauges
|
||||
.lock()
|
||||
.expect("gauge key collection should be lockable")
|
||||
.push(key.clone());
|
||||
Gauge::from_arc(Arc::new(NoopGauge))
|
||||
}
|
||||
|
||||
fn register_histogram(&self, key: &Key, _metadata: &Metadata<'_>) -> Histogram {
|
||||
self.histograms
|
||||
.lock()
|
||||
.expect("histogram key collection should be lockable")
|
||||
.push(key.clone());
|
||||
Histogram::from_arc(Arc::new(NoopHistogram))
|
||||
}
|
||||
}
|
||||
|
||||
struct NoopCounter;
|
||||
|
||||
impl CounterFn for NoopCounter {
|
||||
fn increment(&self, _value: u64) {}
|
||||
|
||||
fn absolute(&self, _value: u64) {}
|
||||
}
|
||||
|
||||
struct NoopGauge;
|
||||
|
||||
impl GaugeFn for NoopGauge {
|
||||
fn increment(&self, _value: f64) {}
|
||||
|
||||
fn decrement(&self, _value: f64) {}
|
||||
|
||||
fn set(&self, _value: f64) {}
|
||||
}
|
||||
|
||||
struct NoopHistogram;
|
||||
|
||||
impl HistogramFn for NoopHistogram {
|
||||
fn record(&self, _value: f64) {}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_record_lock_optimization_enabled() {
|
||||
@@ -143,6 +289,60 @@ mod tests {
|
||||
record_contention_event();
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_record_object_lock_diag_enabled() {
|
||||
let recorder = SeenMetricsRecorder::default();
|
||||
metrics::with_local_recorder(&recorder, || {
|
||||
record_object_lock_diag_enabled(true);
|
||||
record_object_lock_diag_enabled(false);
|
||||
});
|
||||
assert!(
|
||||
recorder.saw_gauge_named("rustfs_object_lock_diag_enabled"),
|
||||
"expected object lock diagnostics enabled gauge to be emitted"
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_record_object_lock_diag_acquire_duration() {
|
||||
let recorder = SeenMetricsRecorder::default();
|
||||
metrics::with_local_recorder(&recorder, || {
|
||||
record_object_lock_diag_acquire_duration("get_object", "read", Duration::from_millis(10));
|
||||
});
|
||||
assert!(
|
||||
recorder.saw_histogram_named("rustfs_object_lock_diag_acquire_duration_seconds"),
|
||||
"expected object lock diagnostics acquire histogram to be emitted"
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_record_object_lock_diag_hold_duration() {
|
||||
let recorder = SeenMetricsRecorder::default();
|
||||
metrics::with_local_recorder(&recorder, || {
|
||||
record_object_lock_diag_hold_duration("put_object_commit", "write", Duration::from_millis(20));
|
||||
});
|
||||
assert!(
|
||||
recorder.saw_histogram_named("rustfs_object_lock_diag_hold_duration_seconds"),
|
||||
"expected object lock diagnostics hold histogram to be emitted"
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_record_object_lock_diag_slow_events() {
|
||||
let recorder = SeenMetricsRecorder::default();
|
||||
metrics::with_local_recorder(&recorder, || {
|
||||
record_object_lock_diag_slow_acquire("get_object_info", "read");
|
||||
record_object_lock_diag_slow_hold("complete_multipart_upload_commit", "write");
|
||||
});
|
||||
assert!(
|
||||
recorder.saw_counter_named("rustfs_object_lock_diag_slow_acquire_total"),
|
||||
"expected object lock diagnostics slow-acquire counter to be emitted"
|
||||
);
|
||||
assert!(
|
||||
recorder.saw_counter_named("rustfs_object_lock_diag_slow_hold_total"),
|
||||
"expected object lock diagnostics slow-hold counter to be emitted"
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_lock_metrics_summary() {
|
||||
let mut summary = LockMetricsSummary::new();
|
||||
|
||||
Reference in New Issue
Block a user