Add metrics for having prefill and decode in different ranks (#15752)

This commit is contained in:
fzyzcjy
2025-12-24 21:35:35 +08:00
committed by GitHub
parent b3b818fd86
commit fd4a558e71
9 changed files with 238 additions and 64 deletions
+122 -40
View File
@@ -1,27 +1,79 @@
import unittest
from typing import Dict, List
import requests
from prometheus_client.parser import text_string_to_metric_families
from prometheus_client.samples import Sample
from sglang.srt.environ import envs
from sglang.srt.utils import kill_process_tree
from sglang.test.test_utils import (
DEFAULT_SMALL_MODEL_NAME_FOR_TEST,
DEFAULT_TIMEOUT_FOR_SERVER_LAUNCH,
DEFAULT_URL_FOR_TEST,
CustomTestCase,
is_in_ci,
popen_launch_server,
)
_MODEL_NAME = "Qwen/Qwen3-0.6B"
class TestEnableMetrics(CustomTestCase):
def test_metrics_enabled(self):
def test_metrics_1gpu(self):
"""Test that metrics endpoint returns data when enabled"""
process = popen_launch_server(
DEFAULT_SMALL_MODEL_NAME_FOR_TEST,
DEFAULT_URL_FOR_TEST,
timeout=DEFAULT_TIMEOUT_FOR_SERVER_LAUNCH,
other_args=["--enable-metrics", "--cuda-graph-max-bs", 2],
self._execute_core(
other_args=[],
verify_metrics_extra=None,
)
def test_metrics_2gpu(self):
# TODO enable when we have 2-gpu runner in nightly CI
if is_in_ci():
print("Skip test_metrics_2gpu since in 1-gpu CI")
return
def _verify_metrics_extra(metrics):
metrics_to_check = [
(
"sglang:dp_cooperation_realtime_tokens_total",
{"mode": "prefill_compute"},
),
("sglang:dp_cooperation_realtime_tokens_total", {"mode": "decode"}),
(
"sglang:dp_cooperation_gpu_execution_seconds_total",
{"category": "forward_prefill"},
),
(
"sglang:dp_cooperation_gpu_execution_seconds_total",
{"category": "forward_decode"},
),
]
_check_metrics_positive(self, metrics, metrics_to_check)
num_prefill_ranks_values = {
s.labels["num_prefill_ranks"]
for s in metrics["sglang:dp_cooperation_realtime_tokens_total"]
}
self.assertIn("0", num_prefill_ranks_values)
self.assertIn("1", num_prefill_ranks_values)
self._execute_core(
other_args=["--tp", "2", "--dp", "2", "--enable-dp-attention"],
verify_metrics_extra=_verify_metrics_extra,
)
def _execute_core(self, other_args, verify_metrics_extra):
with (
envs.SGLANG_ENABLE_METRICS_DP_ATTENTION.override(True),
envs.SGLANG_ENABLE_METRICS_DEVICE_TIMER.override(True),
):
process = popen_launch_server(
_MODEL_NAME,
DEFAULT_URL_FOR_TEST,
timeout=DEFAULT_TIMEOUT_FOR_SERVER_LAUNCH,
other_args=["--enable-metrics", "--cuda-graph-max-bs", 2, *other_args],
)
try:
# Make some requests to generate some metrics
response = requests.get(f"{DEFAULT_URL_FOR_TEST}/health_generate")
@@ -45,44 +97,74 @@ class TestEnableMetrics(CustomTestCase):
# Get metrics
metrics_response = requests.get(f"{DEFAULT_URL_FOR_TEST}/metrics")
self.assertEqual(metrics_response.status_code, 200)
metrics_content = metrics_response.text
metrics_text = metrics_response.text
print(f"metrics_content=\n{metrics_content}")
# Verify essential metrics are present
essential_metrics = [
"sglang:num_running_reqs",
"sglang:num_used_tokens",
"sglang:token_usage",
"sglang:gen_throughput",
"sglang:num_queue_reqs",
"sglang:num_grammar_queue_reqs",
"sglang:cache_hit_rate",
"sglang:spec_accept_length",
"sglang:prompt_tokens_total",
"sglang:generation_tokens_total",
"sglang:cached_tokens_total",
"sglang:num_requests_total",
"sglang:time_to_first_token_seconds",
"sglang:inter_token_latency_seconds",
"sglang:e2e_request_latency_seconds",
]
for metric in essential_metrics:
self.assertIn(metric, metrics_content, f"Missing metric: {metric}")
# Verify model name label is present and correct
expected_model_name = DEFAULT_SMALL_MODEL_NAME_FOR_TEST
self.assertIn(f'model_name="{expected_model_name}"', metrics_content)
# Verify metrics have values (not empty)
self.assertIn("_sum{", metrics_content)
self.assertIn("_count{", metrics_content)
self.assertIn("_bucket{", metrics_content)
print(f"metrics_text=\n{metrics_text}")
metrics = _parse_prometheus_metrics(metrics_text)
self._verify_metrics_common(metrics_text, metrics)
if verify_metrics_extra is not None:
verify_metrics_extra(metrics)
finally:
kill_process_tree(process.pid)
def _verify_metrics_common(self, metrics_text, metrics):
essential_metrics = [
"sglang:num_running_reqs",
"sglang:num_used_tokens",
"sglang:token_usage",
"sglang:gen_throughput",
"sglang:num_queue_reqs",
"sglang:num_grammar_queue_reqs",
"sglang:cache_hit_rate",
"sglang:spec_accept_length",
"sglang:prompt_tokens_total",
"sglang:generation_tokens_total",
"sglang:cached_tokens_total",
"sglang:num_requests_total",
"sglang:time_to_first_token_seconds",
"sglang:inter_token_latency_seconds",
"sglang:e2e_request_latency_seconds",
]
for metric in essential_metrics:
self.assertIn(metric, metrics_text, f"Missing metric: {metric}")
self.assertIn(f'model_name="{_MODEL_NAME}"', metrics_text)
self.assertIn("_sum{", metrics_text)
self.assertIn("_count{", metrics_text)
self.assertIn("_bucket{", metrics_text)
metrics_to_check = [
("sglang:realtime_tokens_total", {"mode": "prefill_compute"}),
("sglang:realtime_tokens_total", {"mode": "decode"}),
("sglang:gpu_execution_seconds_total", {"category": "forward_extend"}),
("sglang:gpu_execution_seconds_total", {"category": "forward_decode"}),
]
_check_metrics_positive(self, metrics, metrics_to_check)
def _parse_prometheus_metrics(metrics_text: str) -> Dict[str, List[Sample]]:
result = {}
for family in text_string_to_metric_families(metrics_text):
for sample in family.samples:
if sample.name not in result:
result[sample.name] = []
result[sample.name].append(sample)
return result
def _get_sample_value_by_labels(samples: List[Sample], labels: Dict[str, str]) -> float:
for sample in samples:
if all(sample.labels.get(k) == v for k, v in labels.items()):
return sample.value
raise KeyError(f"No sample found with labels {labels}")
def _check_metrics_positive(test_case, metrics, metrics_to_check):
for metric_name, labels in metrics_to_check:
value = _get_sample_value_by_labels(metrics[metric_name], labels)
test_case.assertGreater(value, 0, f"{metric_name} {labels}")
if __name__ == "__main__":
unittest.main()