Skip to content

Commit 499264a

Browse files
keivenchangroot
authored andcommitted
Update README.md to not mention about removal of deprecated components
1 parent 2f388e2 commit 499264a

File tree

2 files changed

+15
-35
lines changed

2 files changed

+15
-35
lines changed

components/metrics/README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,21 @@
22

33
⚠️ **DEPRECATION NOTICE** ⚠️
44

5-
**This `metrics` component is being deprecated and will be removed in a future release.**
5+
**This `metrics` component is unmaintained and being deprecated.**
66

77
The deprecated `metrics` component is being replaced by the **`MetricsRegistry`** built-in functionality that is now available directly in the `DistributedRuntime` framework. The `MetricsRegistry` provides:
88

99
**For new projects and existing deployments, please migrate to using `MetricsRegistry` instead of this component.**
1010

11-
See the [Dynamo MetricsRegistry Guide](../../docs/guides/metrics.md) for detailed information on using the new metrics system.
11+
This component may be migrated to the MetricsRegistry in the future.
12+
13+
**📖 See the [Dynamo MetricsRegistry Guide](../../docs/guides/metrics.md) for detailed information on using the new metrics system.**
1214

1315
---
1416

15-
The deprecated `metrics` component is a utility for collecting, aggregating, and publishing metrics from a Dynamo deployment, but it is being deprecated and replaced by `MetricsRegistry`.
17+
The deprecated `metrics` component is a utility for collecting, aggregating, and publishing metrics from a Dynamo deployment, but it is unmaintained and being deprecated in favor of `MetricsRegistry`.
1618

17-
**Note**: This is a demo implementation. The deprecated `metrics` component is currently under active development and this documentation will change as the implementation evolves.
19+
**Note**: This is a demo implementation. The deprecated `metrics` component is no longer under active development.
1820
- In this demo the metrics names use the prefix "llm", but in production they will be prefixed with "dynamo" (e.g., the HTTP `/metrics` endpoint will serve metrics with "dynamo" prefixes)
1921
- This demo will only work when using examples/llm/configs/agg.yml-- other configurations will not work
2022

deploy/metrics/README.md

Lines changed: 9 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,5 @@
11
# Metrics Visualization with Prometheus and Grafana
22

3-
⚠️ **DEPRECATION NOTICE** ⚠️
4-
5-
**The `metrics-aggregation-service` (port 9091) is being deprecated and will be removed in a future release.**
6-
7-
The metrics aggregation service is being replaced by the **`MetricsRegistry`** built-in functionality that is now available directly in the `DistributedRuntime` framework. The new system provides:
8-
9-
- **Built-in Prometheus HTTP endpoint** accessible via `DYN_SYSTEM_ENABLED=true` and `DYN_SYSTEM_PORT=<port>` (default: 8081)
10-
- **Automatic metric registration** when creating metrics via endpoint factory methods
11-
- **Automatic labeling** with namespace, component, and endpoint information
12-
- **Simplified deployment** - no separate metrics component required
13-
14-
**For new projects and existing deployments, please migrate to using `MetricsRegistry` instead of the metrics aggregation service.**
15-
16-
The Prometheus configuration in this directory has been updated to scrape from the new `dynamo-backend` job (port 8081) instead of the deprecated `metrics-aggregation-service` (port 9091).
17-
18-
19-
20-
---
21-
223
This directory contains configuration for visualizing metrics from the metrics aggregation service using Prometheus and Grafana.
234

245
## Components
@@ -79,7 +60,7 @@ As of Q2 2025, Dynamo HTTP Frontend metrics are exposed when you build container
7960

8061
- Start the [components/metrics](../../components/metrics/README.md) application to begin monitoring for metric events from dynamo workers and aggregating them on a Prometheus metrics endpoint: `http://localhost:9091/metrics`.
8162
- Uncomment the appropriate lines in prometheus.yml to poll port 9091.
82-
- Start worker(s) that publishes KV Cache metrics: [examples/rust/service_metrics/bin/server](../../lib/runtime/examples/service_metrics/README.md)` can populate dummy KV Cache metrics.
63+
- Start worker(s) that publishes KV Cache metrics: [lib/runtime/examples/service_metrics/README.md](../../lib/runtime/examples/service_metrics/README.md) can populate dummy KV Cache metrics.
8364

8465

8566
## Configuration
@@ -114,25 +95,22 @@ The following configuration files should be present in this directory:
11495
- [grafana_dashboards/grafana-dcgm-metrics.json](./grafana_dashboards/grafana-dcgm-metrics.json): Contains Grafana dashboard configuration for DCGM GPU metrics
11596
- [grafana_dashboards/grafana-llm-metrics.json](./grafana_dashboards/grafana-llm-metrics.json): This file, which is being phased out, contains the Grafana dashboard configuration for LLM-specific metrics. It requires an additional `metrics` component to operate concurrently. A new version is under development.
11697

117-
## Running the example `metrics` component
98+
## Running the deprecated `metrics` component
11899

119-
IMPORTANT: This section is being phased out, and some metrics may not function as expected. A new solution is under development.
100+
⚠️ **DEPRECATION NOTICE** ⚠️
120101

121-
⚠️ **DEPRECATED METRICS NOTICE** ⚠️
102+
When you run the example [components/metrics](../../components/metrics/README.md) component, it exposes a Prometheus /metrics endpoint with the following metrics (defined in [components/metrics/src/lib.rs](../../components/metrics/src/lib.rs)):
122103

123-
**The following `llm_kv_*` metrics are deprecated and will be removed in a future release:**
104+
**⚠️ The following `llm_kv_*` metrics are deprecated:**
124105

125-
When you run the example [components/metrics](../../components/metrics/README.md) component, it exposes a Prometheus /metrics endpoint with the followings (defined in [../../components/metrics/src/lib.rs](../../components/metrics/src/lib.rs)):
126-
- `llm_requests_active_slots`: Number of currently active request slots per worker
106+
- `llm_requests_active_slots`: Active request slots per worker
127107
- `llm_requests_total_slots`: Total available request slots per worker
128-
- `llm_kv_blocks_active`: Number of active KV blocks per worker ⚠️ **DEPRECATED**
129-
- `llm_kv_blocks_total`: Total KV blocks available per worker ⚠️ **DEPRECATED**
130-
- `llm_kv_hit_rate_percent`: Cumulative KV Cache hit percent per worker ⚠️ **DEPRECATED**
108+
- `llm_kv_blocks_active`: Active KV blocks per worker
109+
- `llm_kv_blocks_total`: Total KV blocks available per worker
110+
- `llm_kv_hit_rate_percent`: KV Cache hit percent per worker
131111
- `llm_load_avg`: Average load across workers
132112
- `llm_load_std`: Load standard deviation across workers
133113

134-
**These `llm_kv_*` metrics are being replaced by the new `dynamo_*` metrics from the MetricsRegistry system. Please migrate to the new system.**
135-
136114
## Troubleshooting
137115

138116
1. Verify services are running:

0 commit comments

Comments
 (0)