Skip to content

Commit 3b3b874

Browse files
committed
Update README.md for more clarity
1 parent c550e55 commit 3b3b874

File tree

1 file changed

+9
-5
lines changed

1 file changed

+9
-5
lines changed

deploy/metrics/README.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -36,12 +36,14 @@ As of Q2 2025, Dynamo HTTP Frontend metrics are exposed when you build container
3636
2. Start Dynamo dependencies. Assume you're at the root dynamo path:
3737

3838
```bash
39-
docker compose -f deploy/docker-compose.yml up -d # Minimum components for Dynamo: etcd/nats/dcgm-exporter
40-
# or
41-
docker compose -f deploy/docker-compose.yml --profile metrics up -d # In addition to the above, start Prometheus & Grafana
39+
# Start the basic services (etcd & natsd), along with Prometheus and Grafana
40+
docker compose -f deploy/metrics/docker-compose.yml --profile metrics up -d
41+
42+
# Minimum components for Dynamo: etcd/nats/dcgm-exporter
43+
docker compose -f deploy/metrics/docker-compose.yml up -d
4244
```
4345

44-
To target specific GPU(s), export the variable below before running Docker Compose:
46+
Optional: To target specific GPU(s), export the variable below before running Docker Compose
4547
```bash
4648
export CUDA_VISIBLE_DEVICES=0,2
4749
```
@@ -90,11 +92,13 @@ The following configuration files should be present in this directory:
9092
- [grafana-datasources.yml](./grafana-datasources.yml): Contains Grafana datasource configuration
9193
- [grafana_dashboards/grafana-dashboard-providers.yml](./grafana_dashboards/grafana-dashboard-providers.yml): Contains Grafana dashboard provider configuration
9294
- [grafana_dashboards/grafana-dynamo-dashboard.json](./grafana_dashboards/grafana-dynamo-dashboard.json): A general Dynamo Dashboard for both SW and HW metrics.
93-
- [grafana_dashboards/grafana-llm-metrics.json](./grafana_dashboards/grafana-llm-metrics.json): Contains Grafana dashboard configuration for LLM specific metrics.
9495
- [grafana_dashboards/grafana-dcgm-metrics.json](./grafana_dashboards/grafana-dcgm-metrics.json): Contains Grafana dashboard configuration for DCGM GPU metrics
96+
- [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.
9597

9698
## Running the example `metrics` component
9799

100+
IMPORTANT: This section is being phased out, and some metrics may not function as expected. A new solution is under development.
101+
98102
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)):
99103
- `llm_requests_active_slots`: Number of currently active request slots per worker
100104
- `llm_requests_total_slots`: Total available request slots per worker

0 commit comments

Comments
 (0)