Skip to content

Commit aa23c73

Browse files
author
t00939662
committed
modify metrics.md
1 parent 8179a40 commit aa23c73

File tree

1 file changed

+5
-6
lines changed

1 file changed

+5
-6
lines changed

docs/source/user-guide/metrics/metrics.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Observability with Prometheus
1+
# Observability
22

33
UCM (Unified Cache Management) provides detailed metrics monitoring through Prometheus endpoints, allowing in-depth monitoring of cache performance and behavior. This document describes how to enable and configure observability from the embedded vLLM `/metrics` API endpoint.
44

@@ -17,7 +17,6 @@ export PROMETHEUS_MULTIPROC_DIR=/vllm-workspace
1717
Then, start the UCM service.
1818

1919
```bash
20-
export PYTHONHASHSEED=123456
2120
export CUDA_VISIBLE_DEVICES=0
2221
vllm serve /home/models/Qwen2.5-14B-Instruct \
2322
--max-model-len 5000 \
@@ -37,11 +36,11 @@ vllm serve /home/models/Qwen2.5-14B-Instruct \
3736
"kv_connector_module_path": "ucm.integration.vllm.ucm_connector",
3837
"kv_role": "kv_both",
3938
"kv_connector_extra_config": {
40-
"UCM_CONFIG_FILE": "/vllm-workspace/ucm_config.yaml"
39+
"UCM_CONFIG_FILE": "/vllm-workspace/unified-cache-management/examples/ucm_config.yaml"
4140
}
4241
}'
4342
```
44-
**Note**: Ensure that the `use_metrics: true` parameter exists in the `ucm_config.yaml` file.
43+
**Note**: Ensure that the `metrics_config_path` parameter exists in the `unified-cache-management/examples/ucm_config.yaml` file.
4544

4645
You can use the `vllm bench serve` command to run benchmarks:
4746

@@ -140,7 +139,7 @@ Navigate to `http://<your-host>:3000`. Log in with the default username (`admin`
140139

141140
1. Navigate to `http://<your-host>:3000/dashboard/import`.
142141

143-
2. Click **Upload JSON file**, then upload the `ucm/metrics/grafana.json` file.
142+
2. Click **Upload JSON file**, then upload the `unified-cache-management/examples/metrics/grafana.json` file.
144143

145144
3. Select the Prometheus data source configured earlier.
146145

@@ -169,7 +168,7 @@ UCM exposes various metrics to monitor its performance. The following table list
169168

170169
## Prometheus Configuration
171170

172-
Metrics configuration is defined in the `ucm/metrics/metrics_configs.yaml` file:
171+
Metrics configuration is defined in the `unified-cache-management/examples/metrics/metrics_configs.yaml` file:
173172

174173
```yaml
175174
log_interval: 5 # Interval in seconds for logging metrics

0 commit comments

Comments
 (0)