feat(compression): show cluster-level compression stat in grafana (#4112)

crates/obs/src/metrics/schema/compression.rs

@@ -0,0 +1,61 @@
+// 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 crate::{MetricDescriptor, MetricName, new_counter_md, new_gauge_md, subsystems};
+use std::sync::LazyLock;
+
+pub static COMPRESSION_BYTES_ORIGINAL_TOTAL: LazyLock<MetricDescriptor> = LazyLock::new(|| {
+    new_counter_md(
+        MetricName::OriginedBytesTotal,
+        "Total bytes before compression (original)",
+        &["compression"],
+        subsystems::COMPRESSION,
+    )
+});
+
+pub static COMPRESSION_BYTES_COMPRESSED_TOTAL: LazyLock<MetricDescriptor> = LazyLock::new(|| {
+    new_counter_md(
+        MetricName::CompressedBytesTotal,
+        "Total bytes after compression",
+        &["compression"],
+        subsystems::COMPRESSION,
+    )
+});
+
+pub static COMPRESSION_BYTES_SAVED_TOTAL: LazyLock<MetricDescriptor> = LazyLock::new(|| {
+    new_counter_md(
+        MetricName::SavedBytesTotal,
+        "Total bytes saved by compression",
+        &["compression"],
+        subsystems::COMPRESSION,
+    )
+});
+
+pub static COMPRESSION_RATIO: LazyLock<MetricDescriptor> = LazyLock::new(|| {
+    new_gauge_md(
+        MetricName::CompressionRatio,
+        "Compression ratio (0.0 - 1.0)",
+        &["compression"],
+        subsystems::COMPRESSION,
+    )
+});
+
+pub static COMPRESSION_OPERATIONS_TOTAL: LazyLock<MetricDescriptor> = LazyLock::new(|| {
+    new_counter_md(
+        MetricName::CompressionOperationsTotal,
+        "Total number of compression operations performed",
+        &["compression"],
+        subsystems::COMPRESSION,
+    )
+});

crates/obs/src/metrics/schema/entry/metric_name.rs

@@ -338,6 +338,13 @@ pub enum MetricName {
     ScannerPartialCycles,
     ScannerPartialCyclesByReason,
 
+    // Compression-related metrics
+    CompressedBytesTotal,
+    OriginedBytesTotal,
+    SavedBytesTotal,
+    CompressionRatio,
+    CompressionOperationsTotal,
+
     // CPU system-related metrics
     SysCPUAvgIdle,
     SysCPUAvgIOWait,
@@ -737,6 +744,13 @@ impl MetricName {
             Self::ScannerPartialCycles => "partial_cycles".to_string(),
             Self::ScannerPartialCyclesByReason => "partial_cycles_by_reason".to_string(),
 
+            // Compression-related metrics
+            Self::CompressedBytesTotal => "compressed_bytes".to_string(),
+            Self::OriginedBytesTotal => "original_bytes".to_string(),
+            Self::SavedBytesTotal => "saved_bytes".to_string(),
+            Self::CompressionRatio => "compression_ratio".to_string(),
+            Self::CompressionOperationsTotal => "compression_operation_total".to_string(),
+
             // CPU system-related metrics
             Self::SysCPUAvgIdle => "avg_idle".to_string(),
             Self::SysCPUAvgIOWait => "avg_iowait".to_string(),

crates/obs/src/metrics/schema/entry/subsystem.rs

@@ -51,6 +51,7 @@ pub enum MetricSubsystem {
     Replication,
     Notification,
     Scanner,
+    Compression,
 
     // Custom paths
     Custom(String),
@@ -93,6 +94,7 @@ impl MetricSubsystem {
             Self::Replication => "/replication",
             Self::Notification => "/notification",
             Self::Scanner => "/scanner",
+            Self::Compression => "/compression",
 
             // Custom paths
             Self::Custom(path) => path,
@@ -141,6 +143,7 @@ impl MetricSubsystem {
             "/replication" => Self::Replication,
             "/notification" => Self::Notification,
             "/scanner" => Self::Scanner,
+            "/compression" => Self::Compression,
 
             // Treat other paths as custom subsystems
             _ => Self::Custom(path.to_string()),
@@ -203,6 +206,7 @@ pub mod subsystems {
     pub const REPLICATION: MetricSubsystem = MetricSubsystem::Replication;
     pub const NOTIFICATION: MetricSubsystem = MetricSubsystem::Notification;
     pub const SCANNER: MetricSubsystem = MetricSubsystem::Scanner;
+    pub const COMPRESSION: MetricSubsystem = MetricSubsystem::Compression;
 }
 
 #[cfg(test)]

crates/obs/src/metrics/schema/mod.rs

@@ -22,6 +22,7 @@ pub mod cluster_health;
 pub mod cluster_iam;
 pub mod cluster_notification;
 pub mod cluster_usage;
+pub mod compression;
 pub mod entry;
 pub mod ilm;
 pub mod node_bucket;