mirror of
https://github.com/rustfs/rustfs.git
synced 2026-07-27 08:38:58 +00:00
Zhengchao An
f63af3df63
The ecstore/global-state migrations are done (backlog#815, #939, #1052 all closed). Review of every migration-era test/gate measure found three things actually retirable or broken — everything else is a live anti-regression guard and stays. Remove: - scripts/check_metrics_migration_refs.sh — guards a migration that finished: rustfs_metrics:: has zero hits, the metrics crate no longer exists, and the script was never wired into CI or make (only reference was one line in config-model-boundary-adr.md, also removed). - crates/obs init_metrics_collectors — the "backward-compatible alias kept during migration" the removed script was guarding. Zero callers; pure delegate to init_metrics_runtime. Archive (docs/superpowers/plans/, continuing the 2026-07 convention, with the standard archived banner): - startup-timeline.md, scheduler-baseline.md, profiling-numa-capability-inventory.md, kms-development-defaults-inventory.md — one-shot snapshots whose only consumer is the already-archived migration-progress ledger (their same-dir links there start resolving again after the move); zero script pins; fed the closed backlog#660/#665 architecture-review ledger. Fixed the one outbound link (startup-timeline -> readiness-matrix) that the move would have broken — check_doc_paths.sh deliberately does not scan plans/, so nothing else would have caught it. Wire (found orphaned by the same review): - scripts/check_extension_schema_boundaries.sh guards a live contract crate but was never invoked anywhere. Add lint-fmt.mak target, include in pre-commit/pre-pr/dev-check, add ci.yml Quick Checks step (job already installs ripgrep), sync the CONTRIBUTING.md enumerated list, and harden the script against a silently-passing rg probe when src/ is missing. Keep (verified live, documented so the next cleanup pass does not repeat this analysis): - scripts/check_architecture_migration_rules.sh — added a header stating it is a permanent boundary guard, not retirable migration scaffolding; 'migration' in the name is historical. - check_migration_gate_count.sh + floor, delete-marker e2e proof, all pinned docs, compat-cleanup-register sync, remaining inventories (referenced by live docs). Verification: all 7 guard scripts pass, actionlint clean, cargo check --workspace (excl e2e) clean, cargo fmt --check clean. Adversarially reviewed by two independent skeptic passes; their 7 findings (alias left behind, broken outbound link, missing banners, wrong backlog attribution, CONTRIBUTING drift, rg exit-2 hole, missing header rationale) are all folded in.
86 lines
2.6 KiB
Rust
86 lines
2.6 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.
|
|
|
|
//! # RustFS Observability
|
|
//!
|
|
//! provides tools for system and service monitoring
|
|
//!
|
|
//! ## Features
|
|
//!
|
|
//! This crate provides observability tools for RustFS:
|
|
//! - Logging with tracing
|
|
//! - Metrics collection
|
|
//! - Distributed tracing
|
|
//! - Tokio runtime telemetry (via dial9)
|
|
//!
|
|
//! ## Usage
|
|
//!
|
|
//! ```no_run
|
|
//! use rustfs_obs::init_obs;
|
|
//!
|
|
//! # #[tokio::main]
|
|
//! # async fn main() {
|
|
//! # let _guard = match init_obs(None).await {
|
|
//! # Ok(g) => g,
|
|
//! # Err(e) => {
|
|
//! # panic!("Failed to initialize observability: {:?}", e);
|
|
//! # }
|
|
//! # };
|
|
//! # // Application logic here
|
|
//! # {
|
|
//! # // Simulate some work
|
|
//! # tokio::time::sleep(std::time::Duration::from_secs(2)).await;
|
|
//! # println!("Application is running...");
|
|
//! # }
|
|
//! # // Guard will be dropped here, flushing telemetry data
|
|
//! # }
|
|
//! ```
|
|
//!
|
|
//! ## Metrics Runtime
|
|
//!
|
|
//! Start metrics scheduling with `rustfs_obs::init_metrics_runtime()`.
|
|
//!
|
|
//! ```ignore
|
|
//! use tokio_util::sync::CancellationToken;
|
|
//! use rustfs_obs::init_metrics_runtime;
|
|
//!
|
|
//! let token = CancellationToken::new();
|
|
//! init_metrics_runtime(token.clone());
|
|
//! ```
|
|
mod cleaner;
|
|
mod config;
|
|
mod error;
|
|
mod global;
|
|
mod logging;
|
|
pub mod metrics;
|
|
mod telemetry;
|
|
|
|
pub use cleaner::*;
|
|
pub use config::*;
|
|
pub use error::*;
|
|
pub use global::*;
|
|
pub use logging::*;
|
|
pub use metrics::schema::*;
|
|
pub use metrics::{
|
|
MetricsRuntimeCancellationSource, MetricsRuntimeController, MetricsRuntimeControllerSnapshot, MetricsRuntimeDesiredSnapshot,
|
|
MetricsRuntimeDesiredState, MetricsRuntimeIntervalsSnapshot, MetricsRuntimeReconcilePlan, MetricsRuntimeServiceState,
|
|
MetricsRuntimeShutdownHandle, MetricsRuntimeStatusSnapshot, MetricsRuntimeWorkerMutation, init_metrics_runtime,
|
|
metrics_runtime_controller_snapshot, metrics_runtime_status_snapshot,
|
|
};
|
|
pub use telemetry::{OtelGuard, Recorder};
|
|
|
|
// Dial9 Tokio runtime telemetry
|
|
// Re-export dial9 types at crate root level for easier access
|
|
pub use telemetry::dial9;
|