mirror of
https://github.com/rustfs/rustfs.git
synced 2026-08-17 10:17:55 +00:00
overtrue
f3c701a054
backlog#1823 step 10, batch 2. Eighteen of the nineteen suppress nothing and are deleted; one was real and keeps an allow that now says why. Rotation::Never is constructed only by the rolling-appender tests at rolling.rs:456, 477 and 498, so the lib target reports it as never constructed. Its allow is restored with that reason. Finding it corrected the method used for batch 1. Removing all nineteen and running cargo check -p rustfs-obs --tests reported zero warnings even after touching every source file, while clippy --lib --tests -D warnings caught Rotation::Never. cargo's warning output is not a reliable completeness check — it does not re-emit for cached compilations, and touching the sources did not cover the lib target here. Later batches should treat clippy -D warnings as the gate; batch 1's six crates were re-checked under clippy and are clean. Taken with #6086, which cleared this crate's 44 module-level blankets and left six real items, obs has now had 63 dead-code suppressions examined, of which seven were suppressing anything at all. The rest sat on items that are publicly reachable, where dead_code never applied — the same shape as the swift module and kms's dek.rs. Verification: clippy --lib --tests -D warnings clean in the default, gpu and pyroscope lanes; cargo nextest run -p rustfs-obs 324 passed; make pre-commit exit 0. Ref rustfs/backlog#1823 (step 10).
129 lines
4.1 KiB
Rust
129 lines
4.1 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 crate::{MetricDescriptor, MetricName, MetricNamespace, MetricSubsystem, MetricType};
|
|
|
|
pub mod descriptor;
|
|
pub mod metric_name;
|
|
pub mod metric_type;
|
|
pub mod namespace;
|
|
mod path_utils;
|
|
pub mod subsystem;
|
|
|
|
/// Create a new counter metric descriptor
|
|
pub fn new_counter_md(
|
|
name: impl Into<MetricName>,
|
|
help: impl Into<String>,
|
|
labels: &[&str],
|
|
subsystem: impl Into<MetricSubsystem>,
|
|
) -> MetricDescriptor {
|
|
MetricDescriptor::new(
|
|
name.into(),
|
|
MetricType::Counter,
|
|
help.into(),
|
|
labels.iter().map(|&s| s.to_string()).collect(),
|
|
MetricNamespace::RustFS,
|
|
subsystem,
|
|
)
|
|
}
|
|
|
|
/// create a new dashboard metric descriptor
|
|
pub fn new_gauge_md(
|
|
name: impl Into<MetricName>,
|
|
help: impl Into<String>,
|
|
labels: &[&str],
|
|
subsystem: impl Into<MetricSubsystem>,
|
|
) -> MetricDescriptor {
|
|
MetricDescriptor::new(
|
|
name.into(),
|
|
MetricType::Gauge,
|
|
help.into(),
|
|
labels.iter().map(|&s| s.to_string()).collect(),
|
|
MetricNamespace::RustFS,
|
|
subsystem,
|
|
)
|
|
}
|
|
|
|
/// create a new histogram indicator descriptor
|
|
pub fn new_histogram_md(
|
|
name: impl Into<MetricName>,
|
|
help: impl Into<String>,
|
|
labels: &[&str],
|
|
subsystem: impl Into<MetricSubsystem>,
|
|
) -> MetricDescriptor {
|
|
MetricDescriptor::new(
|
|
name.into(),
|
|
MetricType::Histogram,
|
|
help.into(),
|
|
labels.iter().map(|&s| s.to_string()).collect(),
|
|
MetricNamespace::RustFS,
|
|
subsystem,
|
|
)
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod tests {
|
|
use super::*;
|
|
use crate::{MetricName, MetricNamespace, MetricSubsystem, subsystems};
|
|
|
|
#[test]
|
|
fn test_new_histogram_md() {
|
|
// create a histogram indicator descriptor
|
|
let histogram_md = new_histogram_md(
|
|
MetricName::TtfbDistribution,
|
|
"test the response time distribution",
|
|
&["api", "method", "le"],
|
|
subsystems::API_REQUESTS,
|
|
);
|
|
|
|
// verify that the metric type is correct
|
|
assert_eq!(histogram_md.metric_type, MetricType::Histogram);
|
|
|
|
// verify that the metric name is correct
|
|
assert_eq!(histogram_md.name.as_str(), "seconds_distribution");
|
|
|
|
// verify that the help information is correct
|
|
assert_eq!(histogram_md.help, "test the response time distribution");
|
|
|
|
// Verify that the label is correct
|
|
assert_eq!(histogram_md.variable_labels.len(), 3);
|
|
assert!(histogram_md.variable_labels.contains(&"api".to_string()));
|
|
assert!(histogram_md.variable_labels.contains(&"method".to_string()));
|
|
assert!(histogram_md.variable_labels.contains(&"le".to_string()));
|
|
|
|
// Verify that the namespace is correct
|
|
assert_eq!(histogram_md.namespace, MetricNamespace::RustFS);
|
|
|
|
// Verify that the subsystem is correct
|
|
assert_eq!(histogram_md.subsystem, MetricSubsystem::ApiRequests);
|
|
|
|
// Verify that the full metric name generated is formatted correctly
|
|
assert_eq!(histogram_md.get_full_metric_name(), "rustfs_api_requests_seconds_distribution");
|
|
|
|
// Tests use custom subsystems
|
|
let custom_histogram_md = new_histogram_md(
|
|
"custom_latency_distribution",
|
|
"custom latency distribution",
|
|
&["endpoint", "le"],
|
|
MetricSubsystem::new("/custom/path-metrics"),
|
|
);
|
|
|
|
// Verify the custom name and subsystem
|
|
assert_eq!(
|
|
custom_histogram_md.get_full_metric_name(),
|
|
"rustfs_custom_path_metrics_custom_latency_distribution"
|
|
);
|
|
}
|
|
}
|