[Doc] Optimize vLLM-Omni metrics documentation (#1311)

Signed-off-by: Junhong Liu <98734602+LJH-LBJ@users.noreply.github.com>
Signed-off-by: Junhong Liu <ljh_lbj@163.com>
Co-authored-by: Hongsheng Liu <liuhongsheng4@huawei.com>
This commit is contained in:
Junhong LiuandHongsheng Liu authored and GitHub committed 2026-02-24 20:27:29 +08:00
1 parent 36b8f80266
commit a8cec43ce6
1 file changed
+26 -18
+26 -18
View File
@@ -1,25 +1,27 @@
# Metrics vLLM-Omni: # Metrics
You can use these metrics in production to monitor the health and performance of the vLLM-omni system. Typical scenarios include: You can use these metrics in production to monitor the health and performance of the vLLM-omni system. Typical scenarios include:
- **Performance Monitoring**: Track throughput (e.g., `e2e_avg_tokens_per_s`), latency (e.g., `e2e_total_ms`), and resource utilization to verify that the system meets expected standards. - **Performance Monitoring**: Track throughput (e.g., `e2e_avg_tokens_per_s`), latency (e.g., `e2e_total_ms`), and resource utilization to verify that the system meets expected standards.
- **Debugging and Troubleshooting**: Use detailed per-request metrics to diagnose issues, such as high transfer times or unexpected token counts. - **Debugging and Troubleshooting**: Use detailed per-request metrics to diagnose issues, such as high transfer times or unexpected token counts.
## How to Enable and View Metrics ## How to Enable and View Metrics
### 1. Start the Service with Metrics Logging ### Start the Service with Metrics Logging
```bash ```bash
vllm serve /workspace/models/Qwen3-Omni-30B-A3B-Instruct --omni --port 8014 --log-stats vllm serve /workspace/models/Qwen3-Omni-30B-A3B-Instruct --omni --port 8014 --log-stats
``` ```
### 2. Send a Request ### Send a Request
```bash ```bash
python openai_chat_completion_client_for_multimodal_generation.py --query-type use_image python openai_chat_completion_client_for_multimodal_generation.py --query-type use_image
``` ```
### 3. What You Will See ### What You Will See
With `--log-stats` enabled, the server will output detailed metrics logs after each request. Example output: With `--log-stats` enabled, the server will output detailed metrics logs after each request. Example output:
@@ -69,9 +71,13 @@ With `--log-stats` enabled, the server will output detailed metrics logs after e
These logs include: These logs include:
- **Overall summary**: total requests, wall time, average tokens/sec, etc. - **Overall summary**: total requests, wall time, average tokens/sec, etc.
- **E2E table**: per-request latency and token counts. - **E2E table**: per-request latency and token counts.
- **Stage table**: per-stage batch and timing details. - **Stage table**: per-stage batch and timing details.
- **Transfer table**: data transfer and timing for each edge. - **Transfer table**: data transfer and timing for each edge.
You can use these logs to monitor system health, debug performance, and analyze request-level metrics as described above. You can use these logs to monitor system health, debug performance, and analyze request-level metrics as described above.
@@ -87,6 +93,8 @@ For **online inference** (serving mode), the summary is always per-request. `e2e
## Parameter Details ## Parameter Details
### Summary Metrics
| Field | Meaning | | Field | Meaning |
|---------------------------|----------------------------------------------------------------------------------------------| |---------------------------|----------------------------------------------------------------------------------------------|
| `e2e_requests` | Number of completed requests. | | `e2e_requests` | Number of completed requests. |
@@ -98,7 +106,7 @@ For **online inference** (serving mode), the summary is always per-request. `e2e
--- ---
## E2E Table (per request) ### E2E Table (per request)
| Field | Meaning | | Field | Meaning |
|---------------------------|-----------------------------------------------------------------------| |---------------------------|-----------------------------------------------------------------------|
@@ -110,7 +118,7 @@ For **online inference** (serving mode), the summary is always per-request. `e2e
--- ---
## Stage Table (per stage event / request) ### Stage Table (per stage event / request)
| Field | Meaning | | Field | Meaning |
|---------------------------|-------------------------------------------------------------------------------------------------| |---------------------------|-------------------------------------------------------------------------------------------------|
@@ -125,7 +133,7 @@ For **online inference** (serving mode), the summary is always per-request. `e2e
--- ---
## Transfer Table (per edge / request) ### Transfer Table (per edge / request)
| Field | Meaning | | Field | Meaning |
|----------------------|---------------------------------------------------------------------------| |----------------------|---------------------------------------------------------------------------|
@@ -135,31 +143,31 @@ For **online inference** (serving mode), the summary is always per-request. `e2e
| `in_flight_time_ms` | In-flight time in ms. | | `in_flight_time_ms` | In-flight time in ms. |
## Expectation of the Numbers (Verification) ### Expectation of the Numbers (Verification)
**Formulas:** **Formulas:**
- `e2e_total_tokens = Stage0's num_tokens_in + sum(all stages' num_tokens_out)` - `e2e_total_tokens = Stage0's num_tokens_in + sum(all stages' num_tokens_out)`
- `transfers_total_time_ms = sum(tx_time_ms + rx_decode_time_ms + in_flight_time_ms)` for every edge - `transfers_total_time_ms = sum(tx_time_ms + rx_decode_time_ms + in_flight_time_ms)` for every edge
**Using the example above:** **Using the example above:**
### e2e_total_tokens **e2e_total_tokens**
- Stage0's `num_tokens_in`: **4,860** - Stage0's `num_tokens_in`: **4,860**
- Stage0's `num_tokens_out`: **67** - Stage0's `num_tokens_out`: **67**
- Stage1's `num_tokens_out`: **275** - Stage1's `num_tokens_out`: **275**
- Stage2's `num_tokens_out`: **0** - Stage2's `num_tokens_out`: **0**
So, so `e2e_total_tokens = 4,860 + 67 + 275 + 0 = 5,202`, which matches the table value `e2e_total_tokens`.
```
e2e_total_tokens = 4,860 + 67 + 275 + 0 = 5,202 **transfers_total_time_ms**
```
This matches the table value: `e2e_total_tokens = 5,202`.
### transfers_total_time_ms
For each edge: For each edge:
- 0->1: tx_time_ms (**78.701**) + rx_decode_time_ms (**111.865**) + in_flight_time_ms (**2.015**) = **192.581** - 0->1: tx_time_ms (**78.701**) + rx_decode_time_ms (**111.865**) + in_flight_time_ms (**2.015**) = **192.581**
- 1->2: tx_time_ms (**18.790**) + rx_decode_time_ms (**31.706**) + in_flight_time_ms (**2.819**) = **53.315** - 1->2: tx_time_ms (**18.790**) + rx_decode_time_ms (**31.706**) + in_flight_time_ms (**2.819**) = **53.315**
Sum: 192.581 + 53.315 = **245.896** 192.581 + 53.315 = **245.896** = transfers_total_time_ms, which matches the calculation (difference is due to rounding)
The table shows `transfers_total_time_ms = 245.895`, which matches the calculation (difference is due to rounding).