diff --git a/crates/io-metrics/README.md b/crates/io-metrics/README.md
index ddd3bdcd6..b8698904f 100644
--- a/crates/io-metrics/README.md
+++ b/crates/io-metrics/README.md
@@ -4,9 +4,6 @@
-
-
-
@@ -14,7 +11,7 @@
· Home - · Docs + · Docs · Issues · Discussions
@@ -205,10 +202,23 @@ cargo bench --package rustfs-io-metrics --bench metrics_pipeline ## Documentation -- [API Documentation](https://docs.rs/rustfs-io-metrics) -- [Adaptive TTL Design](./docs/adaptive-ttl-design.md) -- [Metrics Guide](./docs/metrics-guide.md) -- [Configuration Reference](./docs/config-reference.md) +This crate records metrics through the Rust `metrics` crate and leaves +exporting to `rustfs-obs` or the application-level observability pipeline. It +does not expose Prometheus-compatible HTTP endpoints such as +`/rustfs/v2/metrics/cluster` or `/rustfs/v2/metrics/node`. + +API documentation can be generated locally: + +```bash +cargo doc --package rustfs-io-metrics --no-deps --open +``` + +Useful source references: + +- [Crate API overview](./src/lib.rs) +- [Metrics example](./examples/metrics_example.rs) +- [Configuration module](./src/config.rs) +- [Adaptive TTL module](./src/adaptive_ttl.rs) ## Related Modules diff --git a/crates/io-metrics/README_zh.md b/crates/io-metrics/README_zh.md index 249f94fde..62d758820 100644 --- a/crates/io-metrics/README_zh.md +++ b/crates/io-metrics/README_zh.md @@ -4,9 +4,6 @@