Files
rustfs/crates/ecstore/src/bucket/replication/replication_state.rs
T
houseme fbec33bd29 Expose target-scoped durable MRF backlog metrics (#5584)
* feat(replication): expose target durable mrf backlog

Add target ARN attribution to durable MRF entries and surface target-scoped durable backlog metrics without changing existing bucket-only metric labels.

Keep legacy MRF files bucket-only by defaulting missing targetARNs to an empty list, and expose target snapshots through an additive API so existing DurableMrfBacklogSummary callers remain source-compatible.

Co-Authored-By: heihutu <heihutu@gmail.com>

* feat(replication): expose runtime target backlog (#5586)

Track runtime replication backlog by target ARN for regular, large, delete, and MRF admission paths while preserving the existing bucket-level backlog semantics.

Add target-scoped current backlog metrics and merge them with durable target backlog snapshots for observability.

Co-authored-by: heihutu <heihutu@gmail.com>

---------

Co-authored-by: heihutu <heihutu@gmail.com>
2026-08-01 17:31:50 +00:00

1205 lines
44 KiB
Rust

// Copyright 2024 RustFS Team
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
use super::replication_error_boundary::Error;
use super::replication_filemeta_boundary::{ReplicatedTargetInfo, ReplicationStatusType, ReplicationType};
use super::replication_resync_boundary::ResyncStatusType;
#[cfg(test)]
use super::replication_stats_boundary::FailStats;
use super::replication_stats_boundary::{
ActiveWorkerStat, BucketReplicationStat, BucketReplicationStats, BucketStats, InQueueMetric, ProxyMetric, ProxyStatsCache,
QueueCache, ReplicationMetricScope, SRMetricsSummary, XferStats,
};
use super::runtime_boundary as runtime_sources;
use std::collections::{HashMap, hash_map::Entry};
use std::sync::atomic::{AtomicI64, Ordering};
use std::sync::{Arc, LazyLock, Mutex as StdMutex, Weak};
use std::time::{Duration, SystemTime};
use tokio::sync::{Mutex, RwLock};
use tokio::time::interval;
#[derive(Debug, Clone)]
pub struct ReplStat {
pub arn: String,
pub completed: bool,
pub pending: bool,
pub failed: bool,
pub op_type: ReplicationType,
pub transfer_size: i64,
pub transfer_duration: Duration,
pub endpoint: String,
pub secure: bool,
pub err: Option<Error>,
}
impl ReplStat {
pub fn new() -> Self {
Self {
arn: String::new(),
completed: false,
pending: false,
failed: false,
op_type: ReplicationType::default(),
transfer_size: 0,
transfer_duration: Duration::default(),
endpoint: String::new(),
secure: false,
err: None,
}
}
pub fn endpoint(&self) -> String {
let scheme = if self.secure { "https" } else { "http" };
format!("{}://{}", scheme, self.endpoint)
}
#[allow(clippy::too_many_arguments)]
pub fn set(
&mut self,
arn: String,
size: i64,
duration: Duration,
status: ReplicationStatusType,
op_type: ReplicationType,
endpoint: String,
secure: bool,
err: Option<Error>,
) {
self.arn = arn;
self.transfer_size = size;
self.transfer_duration = duration;
self.op_type = op_type;
self.endpoint = endpoint;
self.secure = secure;
self.err = err;
// Reset status
self.completed = false;
self.pending = false;
self.failed = false;
match status {
ReplicationStatusType::Completed => self.completed = true,
ReplicationStatusType::Pending => self.pending = true,
ReplicationStatusType::Failed => self.failed = true,
_ => {}
}
}
}
impl Default for ReplStat {
fn default() -> Self {
Self::new()
}
}
/// Site replication statistics
#[derive(Debug, Default)]
pub struct SRStats {
pub replica_size: AtomicI64,
pub replica_count: AtomicI64,
// More site replication related statistics fields can be added here
}
impl SRStats {
pub fn new() -> Self {
Self::default()
}
pub fn update(&self, rs: &ReplStat, _depl_id: &str) {
// Update site replication statistics
// In actual implementation, statistics would be updated based on deployment ID
if rs.completed {
self.replica_size.fetch_add(rs.transfer_size, Ordering::Relaxed);
self.replica_count.fetch_add(1, Ordering::Relaxed);
}
}
pub fn get(&self) -> HashMap<String, i64> {
// Return current statistics
let mut stats = HashMap::new();
stats.insert("replica_size".to_string(), self.replica_size.load(Ordering::Relaxed));
stats.insert("replica_count".to_string(), self.replica_count.load(Ordering::Relaxed));
stats
}
}
/// Global replication statistics
#[derive(Debug)]
pub struct ReplicationStats {
// Site replication statistics - maintain global level statistics
pub sr_stats: Arc<SRStats>,
// Active worker statistics
pub workers: Arc<Mutex<ActiveWorkerStat>>,
// Queue statistics cache
pub q_cache: Arc<StdMutex<QueueCache>>,
// Proxy statistics cache
pub p_cache: Arc<Mutex<ProxyStatsCache>>,
// MRF backlog statistics (simplified)
pub mrf_stats: HashMap<String, i64>,
// Bucket replication cache
pub cache: Arc<RwLock<HashMap<String, BucketReplicationStats>>>,
pub most_recent_stats: Arc<Mutex<HashMap<String, BucketStats>>>,
}
#[derive(Debug, Clone, Default, PartialEq, Eq)]
pub struct RuntimeReplicationTargetBacklog {
pub bucket: String,
pub target_arn: String,
pub count: u64,
pub bytes: u64,
}
type TargetQueueKey = (String, String);
type TargetQueueCache = HashMap<TargetQueueKey, InQueueMetric>;
struct TargetQueueCacheSlot {
owner: Weak<StdMutex<QueueCache>>,
metrics: TargetQueueCache,
}
impl TargetQueueCacheSlot {
fn new(owner: &Arc<StdMutex<QueueCache>>) -> Self {
Self {
owner: Arc::downgrade(owner),
metrics: TargetQueueCache::default(),
}
}
fn belongs_to(&self, owner: &Arc<StdMutex<QueueCache>>) -> bool {
self.owner.upgrade().is_some_and(|current| Arc::ptr_eq(&current, owner))
}
}
// Keep runtime target counters outside ReplicationStats to preserve its public struct shape.
static TARGET_QUEUE_CACHES: LazyLock<StdMutex<Vec<TargetQueueCacheSlot>>> = LazyLock::new(|| StdMutex::new(Vec::new()));
fn i64_to_u64_floor_zero(value: i64) -> u64 {
u64::try_from(value.max(0)).unwrap_or(0)
}
fn normalized_target_arns(target_arns: &[String]) -> Vec<&str> {
let mut target_arns = target_arns
.iter()
.map(String::as_str)
.filter(|target_arn| !target_arn.is_empty())
.collect::<Vec<_>>();
target_arns.sort_unstable();
target_arns.dedup();
target_arns
}
fn target_queue_cache_snapshot(cache: &TargetQueueCache) -> Vec<RuntimeReplicationTargetBacklog> {
cache
.iter()
.filter_map(|((bucket, target_arn), metric)| {
let count = i64_to_u64_floor_zero(metric.curr.get_current_count());
let bytes = i64_to_u64_floor_zero(metric.curr.get_current_bytes());
(count > 0 || bytes > 0).then(|| RuntimeReplicationTargetBacklog {
bucket: bucket.clone(),
target_arn: target_arn.clone(),
count,
bytes,
})
})
.collect()
}
fn prune_stale_target_queue_caches(caches: &mut Vec<TargetQueueCacheSlot>) {
caches.retain(|slot| slot.owner.strong_count() > 0);
}
fn with_target_queue_caches<T>(f: impl FnOnce(&mut Vec<TargetQueueCacheSlot>) -> T) -> T {
match TARGET_QUEUE_CACHES.lock() {
Ok(mut caches) => f(&mut caches),
Err(poisoned) => {
let mut caches = poisoned.into_inner();
f(&mut caches)
}
}
}
impl ReplicationStats {
pub fn new() -> Self {
Self {
sr_stats: Arc::new(SRStats::new()),
workers: Arc::new(Mutex::new(ActiveWorkerStat::new())),
q_cache: Arc::new(StdMutex::new(QueueCache::new())),
p_cache: Arc::new(Mutex::new(ProxyStatsCache::new())),
mrf_stats: HashMap::new(),
cache: Arc::new(RwLock::new(HashMap::new())),
most_recent_stats: Arc::new(Mutex::new(HashMap::new())),
}
}
/// Initialize background tasks
pub async fn start_background_tasks(&self) {
// Start moving average calculation task
let cache_clone = Arc::clone(&self.cache);
tokio::spawn(async move {
let mut interval = interval(Duration::from_secs(5));
loop {
interval.tick().await;
Self::update_moving_avg_static(&cache_clone).await;
}
});
// Start worker statistics collection task
let workers_clone = Arc::clone(&self.workers);
tokio::spawn(async move {
let mut interval = interval(Duration::from_secs(2));
loop {
interval.tick().await;
let current = runtime_sources::replication_pool()
.map(|pool| pool.active_workers() + pool.active_lrg_workers() + pool.active_mrf_workers())
.unwrap_or(0);
let mut workers = workers_clone.lock().await;
workers.update(current);
}
});
// Start queue statistics collection task
let q_cache_clone = Arc::clone(&self.q_cache);
tokio::spawn(async move {
let mut interval = interval(Duration::from_secs(2));
loop {
interval.tick().await;
if let Ok(mut cache) = q_cache_clone.lock() {
cache.update();
}
}
});
}
async fn update_moving_avg_static(cache: &Arc<RwLock<HashMap<String, BucketReplicationStats>>>) {
// This is a simplified implementation
// In actual implementation, exponential moving averages need to be updated
let now = SystemTime::now();
let cache_read = cache.read().await;
for stats in cache_read.values() {
for stat in stats.stats.values() {
// Now we can update the moving averages using interior mutability
stat.xfer_rate_lrg.measure.update_exponential_moving_average(now);
stat.xfer_rate_sml.measure.update_exponential_moving_average(now);
}
}
}
/// Check if bucket replication statistics have usage
pub fn has_replication_usage(&self, bucket: &str) -> bool {
if let Ok(cache) = self.cache.try_read()
&& let Some(stats) = cache.get(bucket)
{
return stats.has_replication_usage();
}
false
}
/// Get active worker statistics
pub fn active_workers(&self) -> ActiveWorkerStat {
// This should be called from an async context
// For now, use try_lock to avoid blocking
self.workers.try_lock().map(|w| w.get()).unwrap_or_default()
}
/// Delete bucket's memory replication statistics
pub async fn delete(&self, bucket: &str) {
let mut cache = self.cache.write().await;
cache.remove(bucket);
}
/// Update replica statistics
pub async fn update_replica_stat(&self, bucket: &str, size: i64) {
let mut cache = self.cache.write().await;
let stats = cache.entry(bucket.to_string()).or_insert_with(BucketReplicationStats::new);
stats.replica_size += size;
stats.replica_count += 1;
// Update site replication statistics
self.sr_stats.replica_size.fetch_add(size, Ordering::Relaxed);
self.sr_stats.replica_count.fetch_add(1, Ordering::Relaxed);
}
pub async fn record_resync_status(&self, bucket: &str, status: ResyncStatusType, duration: Option<Duration>) {
let mut cache = self.cache.write().await;
let stats = cache.entry(bucket.to_string()).or_insert_with(BucketReplicationStats::new);
stats.record_resync_status(status, duration);
}
/// Site replication update replica statistics
fn sr_update_replica_stat(&self, size: i64) {
self.sr_stats.replica_size.fetch_add(size, Ordering::Relaxed);
self.sr_stats.replica_count.fetch_add(1, Ordering::Relaxed);
}
/// Site replication update
fn sr_update(&self, rs: &ReplStat) {
// In actual implementation, deployment ID would be obtained here
let depl_id = "default"; // simplified implementation
self.sr_stats.update(rs, depl_id);
}
/// Update replication statistics
pub async fn update(
&self,
bucket: &str,
ri: &ReplicatedTargetInfo,
status: ReplicationStatusType,
prev_status: ReplicationStatusType,
) {
let mut rs = ReplStat::new();
match status {
ReplicationStatusType::Pending if ri.op_type.is_data_replication() && prev_status != status => {
rs.set(
ri.arn.clone(),
ri.size,
Duration::default(),
status,
ri.op_type,
ri.endpoint.clone(),
ri.secure,
ri.error.as_ref().map(|e| Error::other(e.clone())),
);
}
ReplicationStatusType::Completed if ri.op_type.is_data_replication() => {
rs.set(
ri.arn.clone(),
ri.size,
ri.duration,
status,
ri.op_type,
ri.endpoint.clone(),
ri.secure,
ri.error.as_ref().map(|e| Error::other(e.clone())),
);
}
ReplicationStatusType::Failed
if ri.op_type.is_data_replication() && prev_status == ReplicationStatusType::Pending =>
{
rs.set(
ri.arn.clone(),
ri.size,
ri.duration,
status,
ri.op_type,
ri.endpoint.clone(),
ri.secure,
ri.error.as_ref().map(|e| Error::other(e.clone())),
);
}
ReplicationStatusType::Replica if ri.op_type == ReplicationType::Object => {
rs.set(
ri.arn.clone(),
ri.size,
Duration::default(),
status,
ri.op_type,
String::new(),
false,
ri.error.as_ref().map(|e| Error::other(e.clone())),
);
}
_ => {}
}
// Update site replication memory statistics
if rs.completed || rs.failed {
self.sr_update(&rs);
}
// Update bucket replication memory statistics
let mut cache = self.cache.write().await;
let bucket_stats = cache.entry(bucket.to_string()).or_insert_with(BucketReplicationStats::new);
let stat = bucket_stats
.stats
.entry(ri.arn.clone())
.or_insert_with(|| BucketReplicationStat {
xfer_rate_lrg: XferStats::new(),
xfer_rate_sml: XferStats::new(),
..Default::default()
});
match (rs.completed, rs.failed, rs.pending) {
(true, false, false) => {
stat.replicated_size += rs.transfer_size;
stat.replicated_count += 1;
if rs.transfer_duration > Duration::default() {
stat.latency.update(rs.transfer_size, rs.transfer_duration);
stat.update_xfer_rate(rs.transfer_size, rs.transfer_duration);
stat.latency_scope = ReplicationMetricScope::NodeLocal;
}
}
(false, true, false) => {
stat.fail_stats.add_size(rs.transfer_size, rs.err.as_ref());
stat.failed = stat.fail_stats.to_metric();
}
(false, false, true) => {
// Pending status, no processing for now
}
_ => {}
}
}
/// Get replication metrics for all buckets
pub async fn get_all(&self) -> HashMap<String, BucketReplicationStats> {
let cache = self.cache.read().await;
let mut result = HashMap::with_capacity(cache.len());
for (bucket, stats) in cache.iter() {
let mut snapshot = stats.clone_stats();
snapshot.mark_node_local_provider_available();
snapshot.queue_scope = ReplicationMetricScope::NodeLocal;
result.insert(bucket.clone(), snapshot);
}
drop(cache);
{
if let Ok(q_cache) = self.q_cache.lock() {
for (bucket, queue_stats) in &q_cache.bucket_stats {
let bucket_stats = result.entry(bucket.clone()).or_insert_with(BucketReplicationStats::new);
bucket_stats.q_stat = queue_stats.snapshot();
bucket_stats.mark_node_local_provider_available();
bucket_stats.queue_scope = ReplicationMetricScope::NodeLocal;
}
}
}
{
let p_cache = self.p_cache.lock().await;
for bucket in p_cache.bucket_names() {
result.entry(bucket.to_string()).or_insert_with(BucketReplicationStats::new);
}
}
result
}
/// Get replication metrics for a single bucket
pub async fn get(&self, bucket: &str) -> BucketReplicationStats {
let cache = self.cache.read().await;
if let Some(stats) = cache.get(bucket) {
let mut snapshot = stats.clone_stats();
snapshot.mark_node_local_provider_available();
snapshot
} else {
let mut snapshot = BucketReplicationStats::new();
snapshot.mark_node_local_provider_available();
snapshot
}
}
/// Get metrics summary for site replication node
pub async fn get_sr_metrics_for_node(&self) -> SRMetricsSummary {
let boot_time = SystemTime::UNIX_EPOCH; // simplified implementation
let uptime = SystemTime::now().duration_since(boot_time).unwrap_or_default().as_secs() as i64;
let queued = self
.q_cache
.lock()
.map(|q_cache| q_cache.get_site_stats())
.unwrap_or_default();
let p_cache = self.p_cache.lock().await;
let proxied = p_cache.get_site_stats();
SRMetricsSummary {
uptime,
queued,
active_workers: self.active_workers(),
metrics: self.sr_stats.get(),
proxied,
replica_size: self.sr_stats.replica_size.load(Ordering::Relaxed),
replica_count: self.sr_stats.replica_count.load(Ordering::Relaxed),
}
}
/// Calculate bucket replication statistics
pub async fn calculate_bucket_replication_stats(&self, bucket: &str, bucket_stats: Vec<BucketStats>) -> BucketStats {
if bucket_stats.is_empty() {
return BucketStats {
uptime: 0,
replication_stats: BucketReplicationStats::new(),
queue_stats: Default::default(),
proxy_stats: ProxyMetric::default(),
};
}
// Accumulate cluster bucket statistics
let mut stats = HashMap::new();
let mut tot_replica_size = 0i64;
let mut tot_replica_count = 0i64;
let mut tot_replicated_size = 0i64;
let mut tot_replicated_count = 0i64;
let mut tq = InQueueMetric::default();
for bucket_stat in &bucket_stats {
tot_replica_size = tot_replica_size.saturating_add(bucket_stat.replication_stats.replica_size);
tot_replica_count = tot_replica_count.saturating_add(bucket_stat.replication_stats.replica_count);
if bucket_stat.replication_stats.queue_scope != ReplicationMetricScope::Unavailable {
tq = tq.merge(&bucket_stat.replication_stats.q_stat);
} else {
for q in &bucket_stat.queue_stats.nodes {
tq = tq.merge(&q.q_stats);
}
}
for (arn, stat) in &bucket_stat.replication_stats.stats {
let old_stat = stats.entry(arn.clone()).or_insert_with(|| BucketReplicationStat {
xfer_rate_lrg: XferStats::new(),
xfer_rate_sml: XferStats::new(),
..Default::default()
});
let f_stats = stat.fail_stats.merge(&old_stat.fail_stats);
let lrg = old_stat.xfer_rate_lrg.merge(&stat.xfer_rate_lrg);
let sml = old_stat.xfer_rate_sml.merge(&stat.xfer_rate_sml);
let latency_available = stat.latency_scope != ReplicationMetricScope::Unavailable
|| old_stat.latency_scope != ReplicationMetricScope::Unavailable;
let bandwidth_available = stat.bandwidth_scope != ReplicationMetricScope::Unavailable
|| old_stat.bandwidth_scope != ReplicationMetricScope::Unavailable;
*old_stat = BucketReplicationStat {
failed: f_stats.to_metric(),
fail_stats: f_stats,
replicated_size: stat.replicated_size.saturating_add(old_stat.replicated_size),
replicated_count: stat.replicated_count.saturating_add(old_stat.replicated_count),
latency: stat.latency.merge(&old_stat.latency),
xfer_rate_lrg: lrg,
xfer_rate_sml: sml,
bandwidth_limit_bytes_per_sec: stat
.bandwidth_limit_bytes_per_sec
.saturating_add(old_stat.bandwidth_limit_bytes_per_sec),
current_bandwidth_bytes_per_sec: stat.current_bandwidth_bytes_per_sec
+ old_stat.current_bandwidth_bytes_per_sec,
latency_scope: if latency_available {
ReplicationMetricScope::ClusterAggregated
} else {
ReplicationMetricScope::Unavailable
},
bandwidth_scope: if bandwidth_available {
ReplicationMetricScope::ClusterAggregated
} else {
ReplicationMetricScope::Unavailable
},
};
tot_replicated_size = tot_replicated_size.saturating_add(stat.replicated_size);
tot_replicated_count = tot_replicated_count.saturating_add(stat.replicated_count);
}
}
let s = BucketReplicationStats {
stats,
q_stat: tq,
replica_size: tot_replica_size,
replica_count: tot_replica_count,
replicated_size: tot_replicated_size,
replicated_count: tot_replicated_count,
resync_started_count: bucket_stats
.iter()
.map(|stats| stats.replication_stats.resync_started_count)
.fold(0i64, i64::saturating_add),
resync_completed_count: bucket_stats
.iter()
.map(|stats| stats.replication_stats.resync_completed_count)
.fold(0i64, i64::saturating_add),
resync_failed_count: bucket_stats
.iter()
.map(|stats| stats.replication_stats.resync_failed_count)
.fold(0i64, i64::saturating_add),
resync_canceled_count: bucket_stats
.iter()
.map(|stats| stats.replication_stats.resync_canceled_count)
.fold(0i64, i64::saturating_add),
resync_duration_ms: bucket_stats
.iter()
.map(|stats| stats.replication_stats.resync_duration_ms)
.fold(0i64, i64::saturating_add),
provider_available: true,
cluster_complete: true,
observed_node_count: u32::try_from(bucket_stats.len()).unwrap_or(u32::MAX),
expected_node_count: u32::try_from(bucket_stats.len()).unwrap_or(u32::MAX),
queue_scope: ReplicationMetricScope::ClusterAggregated,
};
let qs = Default::default();
let mut ps = ProxyMetric::default();
for bs in &bucket_stats {
// qs.nodes.extend(bs.queue_stats.nodes.clone()); // simplified implementation
ps.add(&bs.proxy_stats);
}
let uptime = SystemTime::now()
.duration_since(SystemTime::UNIX_EPOCH)
.unwrap_or_default()
.as_secs() as i64;
let bs = BucketStats {
uptime,
replication_stats: s,
queue_stats: qs,
proxy_stats: ps,
};
// Update recent statistics
let mut recent_stats = self.most_recent_stats.lock().await;
if !bs.replication_stats.stats.is_empty() {
recent_stats.insert(bucket.to_string(), bs.clone());
}
bs
}
pub async fn aggregate_bucket_replication_stats(
&self,
bucket: &str,
bucket_stats: Vec<BucketStats>,
expected_node_count: u32,
) -> BucketStats {
let mut aggregated = self.calculate_bucket_replication_stats(bucket, bucket_stats).await;
let observed_node_count = aggregated.replication_stats.observed_node_count;
let complete = observed_node_count == expected_node_count;
aggregated.replication_stats.expected_node_count = expected_node_count;
aggregated.replication_stats.cluster_complete = complete;
aggregated.replication_stats.queue_scope = if complete {
ReplicationMetricScope::ClusterAggregated
} else {
ReplicationMetricScope::PartialCluster
};
for stat in aggregated.replication_stats.stats.values_mut() {
if stat.latency_scope != ReplicationMetricScope::Unavailable {
stat.latency_scope = aggregated.replication_stats.queue_scope;
}
if stat.bandwidth_scope != ReplicationMetricScope::Unavailable {
stat.bandwidth_scope = aggregated.replication_stats.queue_scope;
}
}
aggregated
}
/// Get latest replication statistics
pub async fn get_latest_replication_stats(&self, bucket: &str) -> BucketStats {
// In actual implementation, statistics would be obtained from cluster
// This is simplified to get from local cache
let cache = self.cache.read().await;
let mut replication_stats = if let Some(stats) = cache.get(bucket) {
stats.clone_stats()
} else {
BucketReplicationStats::new()
};
let uptime = if cache.contains_key(bucket) {
SystemTime::now()
.duration_since(SystemTime::UNIX_EPOCH)
.unwrap_or_default()
.as_secs() as i64
} else {
0
};
drop(cache);
{
if let Ok(q_cache) = self.q_cache.lock()
&& let Some(queue_stats) = q_cache.bucket_stats.get(bucket)
{
replication_stats.q_stat = queue_stats.snapshot();
}
}
replication_stats.mark_node_local_provider_available();
replication_stats.queue_scope = ReplicationMetricScope::NodeLocal;
if let Some(monitor) = runtime_sources::bucket_monitor() {
let bw_report = monitor.get_report(|name| name == bucket);
for (opts, bw) in bw_report.bucket_stats {
let stat = replication_stats
.stats
.entry(opts.replication_arn)
.or_insert_with(|| BucketReplicationStat {
xfer_rate_lrg: XferStats::new(),
xfer_rate_sml: XferStats::new(),
..Default::default()
});
stat.set_node_local_bandwidth(bw.limit_bytes_per_sec, bw.current_bandwidth_bytes_per_sec);
}
}
BucketStats {
uptime,
replication_stats,
queue_stats: Default::default(),
proxy_stats: ProxyMetric::default(),
}
}
/// Increase queue statistics
pub fn inc_q(&self, bucket: &str, size: i64, _is_delete_repl: bool, _op_type: ReplicationType) {
if let Ok(mut q_cache) = self.q_cache.lock() {
q_cache.inc(bucket, size);
}
}
/// Decrease queue statistics
pub fn dec_q(&self, bucket: &str, size: i64, _is_del_marker: bool, _op_type: ReplicationType) {
if let Ok(mut q_cache) = self.q_cache.lock() {
q_cache.dec(bucket, size);
}
}
pub(crate) fn inc_target_q(&self, bucket: &str, target_arns: &[String], size: i64) {
let target_arns = normalized_target_arns(target_arns);
if target_arns.is_empty() {
return;
}
with_target_queue_caches(|caches| {
prune_stale_target_queue_caches(caches);
let slot_index = match caches.iter().position(|slot| slot.belongs_to(&self.q_cache)) {
Some(index) => index,
None => {
caches.push(TargetQueueCacheSlot::new(&self.q_cache));
caches.len() - 1
}
};
let slot = &mut caches[slot_index];
let bucket = bucket.to_string();
for target_arn in target_arns {
let metric = match slot.metrics.entry((bucket.clone(), target_arn.to_string())) {
Entry::Occupied(entry) => entry.into_mut(),
Entry::Vacant(entry) => entry.insert(InQueueMetric::default()),
};
metric.curr.add_current(size, 1);
}
});
}
pub(crate) fn dec_target_q(&self, bucket: &str, target_arns: &[String], size: i64) {
let target_arns = normalized_target_arns(target_arns);
if target_arns.is_empty() {
return;
}
with_target_queue_caches(|caches| {
prune_stale_target_queue_caches(caches);
if let Some(slot) = caches.iter_mut().find(|slot| slot.belongs_to(&self.q_cache)) {
let bucket = bucket.to_string();
for target_arn in target_arns {
if let Some(metric) = slot.metrics.get_mut(&(bucket.clone(), target_arn.to_string())) {
metric.curr.subtract_current(size, 1);
}
}
slot.metrics
.retain(|_, metric| metric.curr.get_current_count() > 0 || metric.curr.get_current_bytes() > 0);
}
});
}
pub fn runtime_target_backlog_snapshot(&self) -> Vec<RuntimeReplicationTargetBacklog> {
let mut snapshot = with_target_queue_caches(|caches| {
caches
.iter()
.find(|slot| slot.belongs_to(&self.q_cache))
.map(|slot| target_queue_cache_snapshot(&slot.metrics))
.unwrap_or_default()
});
snapshot.sort_by(|left, right| {
left.bucket
.cmp(&right.bucket)
.then_with(|| left.target_arn.cmp(&right.target_arn))
});
snapshot
}
/// Increase proxy metrics
pub async fn inc_proxy(&self, bucket: &str, api: &str, is_err: bool) {
let mut p_cache = self.p_cache.lock().await;
p_cache.inc(bucket, api, is_err);
}
/// Get proxy statistics
pub async fn get_proxy_stats(&self, bucket: &str) -> ProxyMetric {
let p_cache = self.p_cache.lock().await;
p_cache.get_bucket_stats(bucket)
}
}
impl Default for ReplicationStats {
fn default() -> Self {
Self::new()
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn runtime_target_backlog_snapshot_tracks_targets() {
let stats = ReplicationStats::new();
stats.inc_target_q(
"photos",
&[
"arn:rustfs:replication:target-b".to_string(),
"arn:rustfs:replication:target-a".to_string(),
"arn:rustfs:replication:target-a".to_string(),
],
1024,
);
let snapshot = stats.runtime_target_backlog_snapshot();
assert_eq!(
snapshot,
vec![
RuntimeReplicationTargetBacklog {
bucket: "photos".to_string(),
target_arn: "arn:rustfs:replication:target-a".to_string(),
count: 1,
bytes: 1024,
},
RuntimeReplicationTargetBacklog {
bucket: "photos".to_string(),
target_arn: "arn:rustfs:replication:target-b".to_string(),
count: 1,
bytes: 1024,
},
]
);
}
#[test]
fn runtime_target_backlog_ignores_empty_targets() {
let stats = ReplicationStats::new();
stats.inc_target_q("photos", &["".to_string()], 1024);
assert!(stats.runtime_target_backlog_snapshot().is_empty());
}
#[test]
fn runtime_target_backlog_is_scoped_to_stats_instance() {
let first = ReplicationStats::new();
let second = ReplicationStats::new();
first.inc_target_q("photos", &["arn:rustfs:replication:target-a".to_string()], 1024);
assert!(second.runtime_target_backlog_snapshot().is_empty());
assert_eq!(first.runtime_target_backlog_snapshot()[0].count, 1);
}
#[test]
fn runtime_target_backlog_decrements_with_saturation() {
let stats = ReplicationStats::new();
let target_arns = ["arn:rustfs:replication:target-a".to_string()];
stats.inc_target_q("photos", &target_arns, 1024);
stats.dec_target_q("photos", &target_arns, 2048);
assert!(stats.runtime_target_backlog_snapshot().is_empty());
}
#[test]
fn runtime_target_backlog_prunes_stale_sidecar_on_next_access() {
{
let stats = ReplicationStats::new();
stats.inc_target_q("photos", &["arn:rustfs:replication:target-a".to_string()], 1024);
assert!(
TARGET_QUEUE_CACHES
.lock()
.expect("target queue cache mutex")
.iter()
.any(|slot| slot.owner.strong_count() > 0)
);
}
let stats = ReplicationStats::new();
stats.inc_target_q("photos", &["arn:rustfs:replication:target-b".to_string()], 1024);
assert!(
TARGET_QUEUE_CACHES
.lock()
.expect("target queue cache mutex")
.iter()
.all(|slot| slot.owner.strong_count() > 0)
);
}
#[tokio::test]
async fn test_replication_stats_new() {
let stats = ReplicationStats::new();
let workers = stats.active_workers();
assert_eq!(workers.curr, 0);
}
#[tokio::test]
async fn test_delete_bucket_stats() {
let stats = ReplicationStats::new();
stats.delete("test-bucket").await;
let bucket_stats = stats.get("test-bucket").await;
assert!(bucket_stats.is_empty());
}
#[tokio::test]
async fn test_update_replica_stat() {
let stats = ReplicationStats::new();
stats.update_replica_stat("test-bucket", 1024).await;
let bucket_stats = stats.get("test-bucket").await;
assert_eq!(bucket_stats.replica_size, 1024);
assert_eq!(bucket_stats.replica_count, 1);
}
#[tokio::test]
async fn test_record_resync_status_updates_bucket_stats() {
let stats = ReplicationStats::new();
stats
.record_resync_status("test-bucket", ResyncStatusType::ResyncStarted, None)
.await;
stats
.record_resync_status("test-bucket", ResyncStatusType::ResyncCompleted, Some(Duration::from_millis(1500)))
.await;
stats
.record_resync_status("test-bucket", ResyncStatusType::ResyncPending, Some(Duration::from_millis(500)))
.await;
let bucket_stats = stats.get("test-bucket").await;
assert_eq!(bucket_stats.resync_started_count, 1);
assert_eq!(bucket_stats.resync_completed_count, 1);
assert_eq!(bucket_stats.resync_failed_count, 0);
assert_eq!(bucket_stats.resync_canceled_count, 0);
assert_eq!(bucket_stats.resync_duration_ms, 1500);
assert!(bucket_stats.has_replication_usage());
}
#[tokio::test]
async fn test_replication_stats_update() {
let stats = ReplicationStats::new();
let target_info = ReplicatedTargetInfo {
arn: "test-arn".to_string(),
size: 1024,
duration: Duration::from_secs(1),
op_type: ReplicationType::Object,
endpoint: "test.example.com".to_string(),
secure: true,
error: None,
..Default::default()
};
stats
.update(
"test-bucket",
&target_info,
ReplicationStatusType::Completed,
ReplicationStatusType::Pending,
)
.await;
let bucket_stats = stats.get("test-bucket").await;
assert!(!bucket_stats.is_empty());
assert!(bucket_stats.stats.contains_key("test-arn"));
let stat = &bucket_stats.stats["test-arn"];
assert_eq!(stat.replicated_size, 1024);
assert_eq!(stat.replicated_count, 1);
}
#[tokio::test]
async fn latest_stats_include_queue_until_drained() {
let stats = ReplicationStats::new();
stats.inc_q("queued-bucket", 4096, false, ReplicationType::Object);
let queued = stats.get_latest_replication_stats("queued-bucket").await;
assert!(queued.replication_stats.provider_available);
assert_eq!(queued.replication_stats.q_stat.curr.count, 1);
assert_eq!(queued.replication_stats.q_stat.curr.bytes, 4096);
assert_eq!(queued.replication_stats.queue_scope, ReplicationMetricScope::NodeLocal);
stats.dec_q("queued-bucket", 4096, false, ReplicationType::Object);
let drained = stats.get_latest_replication_stats("queued-bucket").await;
assert_eq!(drained.replication_stats.q_stat.curr.count, 0);
assert_eq!(drained.replication_stats.q_stat.curr.bytes, 0);
}
#[tokio::test]
async fn failed_metric_matches_authoritative_fail_stats() {
let stats = ReplicationStats::new();
let target_info = ReplicatedTargetInfo {
arn: "failed-arn".to_string(),
size: 2048,
duration: Duration::from_millis(25),
op_type: ReplicationType::Object,
error: Some("target unavailable".to_string()),
..Default::default()
};
stats
.update(
"failed-bucket",
&target_info,
ReplicationStatusType::Failed,
ReplicationStatusType::Pending,
)
.await;
let snapshot = stats.get_latest_replication_stats("failed-bucket").await;
let target = &snapshot.replication_stats.stats["failed-arn"];
assert_eq!(target.failed.count, target.fail_stats.count);
assert_eq!(target.failed.size, target.fail_stats.size);
assert_eq!(target.failed.count, 1);
assert_eq!(target.failed.size, 2048);
}
#[tokio::test]
async fn valid_empty_provider_is_not_reported_as_unavailable() {
let stats = ReplicationStats::new();
let snapshot = stats.get_latest_replication_stats("empty-bucket").await;
assert!(snapshot.replication_stats.provider_available);
assert!(snapshot.replication_stats.cluster_complete);
assert_eq!(snapshot.replication_stats.observed_node_count, 1);
assert_eq!(snapshot.replication_stats.expected_node_count, 1);
assert!(snapshot.replication_stats.stats.is_empty());
}
#[tokio::test]
async fn cluster_aggregation_counts_each_node_once_and_marks_partial() {
let stats = ReplicationStats::new();
let node = |failed_count, failed_size, queued_count, queued_size| {
let mut fail_stats = FailStats::new();
fail_stats.count = failed_count;
fail_stats.size = failed_size;
let mut targets = HashMap::new();
targets.insert(
"arn".to_string(),
BucketReplicationStat {
fail_stats,
latency_scope: ReplicationMetricScope::NodeLocal,
..Default::default()
},
);
let q_stat = InQueueMetric::default();
q_stat.curr.now_count.store(queued_count, Ordering::Relaxed);
q_stat.curr.now_bytes.store(queued_size, Ordering::Relaxed);
let q_stat = q_stat.snapshot();
BucketStats {
replication_stats: BucketReplicationStats {
stats: targets,
q_stat,
provider_available: true,
queue_scope: ReplicationMetricScope::NodeLocal,
..Default::default()
},
..Default::default()
}
};
let aggregated = stats
.aggregate_bucket_replication_stats("bucket", vec![node(1, 10, 2, 20), node(3, 30, 4, 40)], 3)
.await;
let target = &aggregated.replication_stats.stats["arn"];
assert_eq!(target.failed.count, 4);
assert_eq!(target.failed.size, 40);
assert_eq!(aggregated.replication_stats.q_stat.curr.count, 6);
assert_eq!(aggregated.replication_stats.q_stat.curr.bytes, 60);
assert_eq!(aggregated.replication_stats.observed_node_count, 2);
assert_eq!(aggregated.replication_stats.expected_node_count, 3);
assert!(!aggregated.replication_stats.cluster_complete);
assert_eq!(aggregated.replication_stats.queue_scope, ReplicationMetricScope::PartialCluster);
assert_eq!(target.latency_scope, ReplicationMetricScope::PartialCluster);
}
#[tokio::test]
async fn concurrent_queue_updates_are_visible_without_lost_counts() {
let stats = Arc::new(ReplicationStats::new());
let mut tasks = Vec::with_capacity(32);
for _ in 0..32 {
let stats = Arc::clone(&stats);
tasks.push(tokio::spawn(async move {
stats.inc_q("concurrent-bucket", 7, false, ReplicationType::Object);
}));
}
for task in tasks {
task.await.expect("queue update task should complete");
}
let snapshot = stats.get_latest_replication_stats("concurrent-bucket").await;
assert_eq!(snapshot.replication_stats.q_stat.curr.count, 32);
assert_eq!(snapshot.replication_stats.q_stat.curr.bytes, 224);
}
#[tokio::test]
async fn test_get_all_includes_proxy_only_bucket() {
let stats = ReplicationStats::new();
stats.inc_proxy("proxy-only-bucket", "HeadObject", false).await;
let all = stats.get_all().await;
assert!(all.contains_key("proxy-only-bucket"));
}
#[tokio::test]
async fn test_calculate_bucket_replication_stats_merges_resync_metrics() {
let stats = ReplicationStats::new();
let got = stats
.calculate_bucket_replication_stats(
"test-bucket",
vec![
BucketStats {
replication_stats: BucketReplicationStats {
resync_started_count: 1,
resync_completed_count: 1,
resync_duration_ms: 1000,
..Default::default()
},
..Default::default()
},
BucketStats {
replication_stats: BucketReplicationStats {
resync_started_count: 2,
resync_failed_count: 1,
resync_canceled_count: 1,
resync_duration_ms: 2500,
..Default::default()
},
..Default::default()
},
],
)
.await;
assert_eq!(got.replication_stats.resync_started_count, 3);
assert_eq!(got.replication_stats.resync_completed_count, 1);
assert_eq!(got.replication_stats.resync_failed_count, 1);
assert_eq!(got.replication_stats.resync_canceled_count, 1);
assert_eq!(got.replication_stats.resync_duration_ms, 3500);
}
#[test]
fn test_sr_stats() {
let sr_stats = SRStats::new();
let initial_size = sr_stats.replica_size.load(Ordering::Relaxed);
let initial_count = sr_stats.replica_count.load(Ordering::Relaxed);
assert_eq!(initial_size, 0);
assert_eq!(initial_count, 0);
let stats_map = sr_stats.get();
assert_eq!(stats_map["replica_size"], 0);
assert_eq!(stats_map["replica_count"], 0);
}
}