import argparse import dataclasses import itertools import json import multiprocessing import os import random import re import time from typing import Callable, List, Optional, Tuple import numpy as np import requests from pydantic import BaseModel from tabulate import tabulate from transformers import AutoProcessor, PreTrainedTokenizer from sglang.bench_serving import ( get_processor, get_tokenizer, sample_mmmu_requests, sample_random_requests, ) from sglang.profiler import run_profile from sglang.srt.entrypoints.http_server import launch_server from sglang.srt.server_args import ServerArgs from sglang.srt.utils import is_blackwell, kill_process_tree from sglang.test.test_utils import is_in_ci, write_github_step_summary DEFAULT_TIMEOUT = 600 def get_cache_tokens_from_metrics(url: str) -> Optional[tuple]: """ Get cached_tokens_total and prompt_tokens_total from Prometheus /metrics endpoint. Returns (cached_tokens_total, prompt_tokens_total) or None if metrics are not available. """ try: response = requests.get(url + "/metrics", timeout=5) response.raise_for_status() # Parse Prometheus text format # Looking for: sglang:cached_tokens_total{...} # sglang:prompt_tokens_total{...} cached_tokens_total = 0.0 prompt_tokens_total = 0.0 for line in response.text.split("\n"): if line.startswith("sglang:cached_tokens_total{"): match = re.search( r"sglang:cached_tokens_total\{[^}]*\}\s+([\d.eE+-]+)", line ) if match: cached_tokens_total += float(match.group(1)) elif line.startswith("sglang:prompt_tokens_total{"): match = re.search( r"sglang:prompt_tokens_total\{[^}]*\}\s+([\d.eE+-]+)", line ) if match: prompt_tokens_total += float(match.group(1)) return (cached_tokens_total, prompt_tokens_total) except Exception as e: print(f"Warning: Failed to get cache tokens from metrics: {e}") return None def calculate_cache_hit_rate( before: Optional[tuple], after: Optional[tuple] ) -> Optional[float]: """ Calculate cache hit rate from before/after metrics snapshots. Returns cached_tokens_delta / prompt_tokens_delta for the benchmark run. """ if before is None or after is None: return None cached_delta = after[0] - before[0] prompt_delta = after[1] - before[1] if prompt_delta > 0: return cached_delta / prompt_delta return None @dataclasses.dataclass class BenchArgs: run_name: str = "default" batch_size: Tuple[int] = (1,) input_len: Tuple[int] = (1024,) output_len: Tuple[int] = (16,) temperature: float = 0.0 return_logprob: bool = False client_stream_interval: int = 1 input_len_step_percentage: float = 0.0 base_url: str = "" skip_warmup: bool = False show_report: bool = False profile: bool = False profile_steps: int = 5 profile_by_stage: bool = False profile_prefix: Optional[str] = None profile_output_dir: Optional[str] = None dataset_path: str = "" dataset_name: str = "random" parallel_batch: bool = False result_filename: str = "result.jsonl" pydantic_result_filename: Optional[str] = None append_to_github_summary: bool = True seed: int = 42 cache_hit_rate: float = 0.0 @staticmethod def add_cli_args(parser: argparse.ArgumentParser): parser.add_argument("--run-name", type=str, default=BenchArgs.run_name) parser.add_argument( "--batch-size", type=int, nargs="+", default=BenchArgs.batch_size ) parser.add_argument( "--input-len", type=int, nargs="+", default=BenchArgs.input_len ) parser.add_argument( "--output-len", type=int, nargs="+", default=BenchArgs.output_len ) parser.add_argument("--temperature", type=float, default=BenchArgs.temperature) parser.add_argument("--return-logprob", action="store_true") parser.add_argument( "--client-stream-interval", type=int, default=BenchArgs.client_stream_interval, ) parser.add_argument( "--input-len-step-percentage", type=float, default=BenchArgs.input_len_step_percentage, ) parser.add_argument("--base-url", type=str, default=BenchArgs.base_url) parser.add_argument("--skip-warmup", action="store_true") parser.add_argument("--show-report", action="store_true") parser.add_argument("--profile", action="store_true") parser.add_argument( "--profile-steps", type=int, default=BenchArgs.profile_steps ) parser.add_argument("--profile-by-stage", action="store_true") parser.add_argument( "--profile-prefix", type=str, default=BenchArgs.profile_prefix, ) parser.add_argument( "--profile-output-dir", type=str, default=BenchArgs.profile_output_dir, ) parser.add_argument( "--dataset-path", type=str, default=BenchArgs.dataset_path, help="Path to the dataset.", ) parser.add_argument( "--dataset-name", type=str, default=BenchArgs.dataset_name, choices=["mmmu", "random"], help="Name of the dataset to benchmark on.", ) parser.add_argument("--parallel-batch", action="store_true") parser.add_argument( "--result-filename", type=str, default=BenchArgs.result_filename, help="Store the results line by line in the JSON Line format to this file.", ) parser.add_argument( "--pydantic-result-filename", type=str, default=BenchArgs.pydantic_result_filename, help="Store the results as pydantic models in the JSON format to this file.", ) parser.add_argument( "--no-append-to-github-summary", action="store_false", dest="append_to_github_summary", help="Disable appending the output of this run to github ci summary", ) parser.add_argument("--seed", type=int, default=BenchArgs.seed) parser.add_argument( "--cache-hit-rate", type=float, default=BenchArgs.cache_hit_rate, help="Cache hit rate for benchmarking (0.0-1.0). " "0.0 means no cache hits (flush all), 0.4 means 40%% of input tokens are cached.", ) @classmethod def from_cli_args(cls, args: argparse.Namespace): attrs = [attr.name for attr in dataclasses.fields(cls)] return cls(**{attr: getattr(args, attr) for attr in attrs}) class BenchOneCaseResult(BaseModel): run_name: str batch_size: int input_len: int output_len: int latency: float input_throughput: float output_throughput: float overall_throughput: float last_ttft: float last_gen_throughput: float acc_length: float cache_hit_rate: Optional[float] = None profile_link: Optional[str] = None def dump_to_jsonl(self, result_filename: str): with open(result_filename, "a") as fout: res = { "run_name": self.run_name, "batch_size": self.batch_size, "input_len": self.input_len, "output_len": self.output_len, "latency": round(self.latency, 4), "input_throughput": round(self.input_throughput, 2), "output_throughput": round(self.output_throughput, 2), "overall_throughput": round(self.overall_throughput, 2), "last_ttft": round(self.last_ttft, 4), "last_gen_throughput": round(self.last_gen_throughput, 2), "acc_length": round(self.acc_length, 2), "cache_hit_rate": ( round(self.cache_hit_rate, 4) if self.cache_hit_rate is not None else None ), } fout.write(json.dumps(res) + "\n") def launch_server_internal(launch_server_func: Callable, server_args: ServerArgs): try: launch_server_func(server_args) except Exception as e: raise e finally: kill_process_tree(os.getpid(), include_parent=False) def launch_server_process(launch_server_func: Callable, server_args: ServerArgs): proc = multiprocessing.Process( target=launch_server_internal, args=( launch_server_func, server_args, ), ) proc.start() base_url = f"http://{server_args.host}:{server_args.port}" start_time = time.time() while time.time() - start_time < DEFAULT_TIMEOUT: try: headers = { "Content-Type": "application/json; charset=utf-8", } response = requests.get( f"{base_url}/v1/models", headers=headers, timeout=DEFAULT_TIMEOUT ) if response.status_code == 200: return proc, base_url except requests.RequestException: pass time.sleep(10) raise TimeoutError("Server failed to start within the timeout period.") def _warmup_cache( url: str, input_ids: List[List[int]], input_len: int, cache_hit_rate: float, dataset_name: str = "random", image_data: Optional[List] = None, ): """Warm up the cache by sending prefix tokens to populate the radix cache. Args: url: Server URL input_ids: List of input token id lists input_len: Length of input tokens cache_hit_rate: Fraction of input tokens to cache (0.0-1.0) dataset_name: Name of the dataset (used to determine if image data should be included) image_data: Optional image data for VLM models """ cached_token_len = int(input_len * cache_hit_rate) if cached_token_len <= 0: return print( f"Warming up cache with {cache_hit_rate*100:.1f}% hit rate " f"({cached_token_len} tokens per request)" ) # Create prefix input_ids for cache warming cache_warmup_input_ids = [ids[:cached_token_len] for ids in input_ids] cache_warmup_payload = { "input_ids": cache_warmup_input_ids, "sampling_params": { "temperature": 0.0, "max_new_tokens": 1, # Minimal output, just to populate cache "ignore_eos": True, }, "stream": False, } if dataset_name == "mmmu" and image_data is not None: # include image data in cache warmup cache_warmup_payload["image_data"] = image_data warmup_response = requests.post( url + "/generate", json=cache_warmup_payload, timeout=DEFAULT_TIMEOUT, ) warmup_response.raise_for_status() print("Cache warmup completed") def run_one_case( url: str, batch_size: int, input_len: int, output_len: int, temperature: float, return_logprob: bool, stream_interval: int, input_len_step_percentage: float, run_name: str, result_filename: str, tokenizer: PreTrainedTokenizer | AutoProcessor, profile: bool = False, profile_steps: int = BenchArgs.profile_steps, profile_by_stage: bool = False, profile_prefix: Optional[str] = BenchArgs.profile_prefix, profile_output_dir: Optional[str] = BenchArgs.profile_output_dir, dataset_name: str = BenchArgs.dataset_name, dataset_path: str = BenchArgs.dataset_path, parallel_batch: bool = False, cache_hit_rate: float = BenchArgs.cache_hit_rate, ): response = requests.post(url + "/flush_cache", timeout=DEFAULT_TIMEOUT) response.raise_for_status() # Load input token ids # TODO: reuse bench_serving.get_dataset ? if dataset_name == "mmmu": input_requests = sample_mmmu_requests( num_requests=batch_size, processor=tokenizer, fixed_output_len=output_len, random_sample=False, ) elif dataset_name == "random": input_requests = sample_random_requests( input_len=input_len, output_len=output_len, num_prompts=batch_size, range_ratio=1.0, tokenizer=tokenizer, dataset_path=dataset_path, random_sample=True, return_text=False, ) # Load sampling parameters use_structured_outputs = False if use_structured_outputs: texts = [] for _ in range(batch_size): texts.append( "Human: What is the capital city of france? can you give as many trivial information as possible about that city? answer in json.\n" * 50 + "Assistant:" ) json_schema = "$$ANY$$" else: json_schema = None payload = { "sampling_params": { "temperature": temperature, "max_new_tokens": output_len, "ignore_eos": True, "json_schema": json_schema, "stream_interval": stream_interval, }, "return_logprob": return_logprob, "stream": True, **({"parallel_batch": parallel_batch} if parallel_batch else {}), } if dataset_name == "mmmu": # vlm input_ids = [] # for vlms, tokenizer is an instance of AutoProcessor tokenizer = tokenizer.tokenizer for input_req in input_requests: input_ids += [tokenizer.encode(input_req.prompt)] payload["image_data"] = [req.image_data for req in input_requests] else: input_ids = [req.prompt for req in input_requests] payload["input_ids"] = input_ids # Warm up cache if cache_hit_rate > 0.0 if cache_hit_rate > 0.0: _warmup_cache( url=url, input_ids=input_ids, input_len=input_len, cache_hit_rate=cache_hit_rate, dataset_name=dataset_name, image_data=payload.get("image_data"), ) # Turn on profiler profile_link = None if profile: profile_link: str = run_profile( url=url, num_steps=profile_steps, activities=["CPU", "GPU"], output_dir=profile_output_dir, profile_by_stage=profile_by_stage, profile_prefix=profile_prefix, ) # Get metrics before the request (for cache hit rate calculation) metrics_before = get_cache_tokens_from_metrics(url) # Run the request tic = time.perf_counter() response = requests.post( url + "/generate", json=payload, stream=True, timeout=DEFAULT_TIMEOUT, ) response.raise_for_status() # Get the TTFT of the last request in the batch last_ttft = 0.0 for chunk in response.iter_lines(decode_unicode=False): chunk = chunk.decode("utf-8") if chunk and chunk.startswith("data:"): if chunk == "data: [DONE]": break data = json.loads(chunk[5:].strip("\n")) if "error" in data: raise RuntimeError(f"Request has failed. {data}.") assert ( data["meta_info"]["finish_reason"] is None or data["meta_info"]["finish_reason"]["type"] == "length" ) if data["meta_info"]["completion_tokens"] == 1: last_ttft = time.perf_counter() - tic # Compute metrics latency = time.perf_counter() - tic input_throughput = batch_size * input_len / last_ttft output_throughput = batch_size * output_len / (latency - last_ttft) overall_throughput = batch_size * (input_len + output_len) / latency response = requests.get(url + "/get_server_info", timeout=DEFAULT_TIMEOUT) response.raise_for_status() server_info = response.json() internal_state = server_info.get("internal_states", [{}]) last_gen_throughput = internal_state[0].get("last_gen_throughput", None) or -1 acc_length = internal_state[0].get("avg_spec_accept_length", None) or -1 # Calculate cache hit rate from before/after metrics delta metrics_after = get_cache_tokens_from_metrics(url) metrics_cache_hit_rate = calculate_cache_hit_rate(metrics_before, metrics_after) # Print results print(f"batch size: {batch_size}") print(f"input_len: {input_len}") print(f"output_len: {output_len}") print(f"latency: {latency:.2f} s") print(f"input throughput: {input_throughput:.2f} tok/s") if output_len != 1: print(f"output throughput: {output_throughput:.2f} tok/s") print(f"last_ttft: {last_ttft:.2f} s") print(f"last generation throughput: {last_gen_throughput:.2f} tok/s") if acc_length > 0: print(f"acc_length: {acc_length:.2f} ") if metrics_cache_hit_rate is not None: print(f"cache hit rate: {metrics_cache_hit_rate:.4f}") # Dump results result = BenchOneCaseResult( run_name=run_name, batch_size=batch_size, input_len=input_len, output_len=output_len, latency=latency, input_throughput=input_throughput, output_throughput=output_throughput, overall_throughput=overall_throughput, last_ttft=last_ttft, last_gen_throughput=last_gen_throughput, acc_length=acc_length, cache_hit_rate=metrics_cache_hit_rate, profile_link=profile_link, ) # Save and return the results if result_filename: result.dump_to_jsonl(result_filename) return result def should_skip_due_to_token_capacity( batch_size, input_len, output_len, skip_token_capacity_threshold ): if batch_size * (input_len + output_len) > skip_token_capacity_threshold: print( "=" * 8 + f"Skip benchmark {batch_size=} * ({input_len=} + {output_len=}) = {batch_size * (input_len + output_len)} > {skip_token_capacity_threshold=} due to kv cache limit." + "=" * 8 ) return True return False def should_skip_due_to_max_running_requests( batch_size, skip_max_running_requests_threshold ): if batch_size > skip_max_running_requests_threshold: print( "=" * 8 + f"Skip benchmark {batch_size=} > {skip_max_running_requests_threshold=} due to max running requests limit." + "=" * 8 ) return True return False def get_report_summary( results: List[BenchOneCaseResult], bench_args: BenchArgs, server_args: ServerArgs ): summary = ( f"\nInput lens: {bench_args.input_len}. Output lens: {bench_args.output_len}." ) if bench_args.cache_hit_rate > 0.0: summary += f" Cache hit rate: {bench_args.cache_hit_rate*100:.1f}%." summary += "\n" if is_blackwell(): hourly_cost_per_gpu = 4 # $4/hour for one B200 else: hourly_cost_per_gpu = 2 # $2/hour for one H100 input_util = 0.7 # sort result by input_len results.sort(key=lambda x: x.input_len) rows = [] headers = [ "batch size", "input len", "latency (s)", "input throughput (tok/s)", "output throughput (tok/s)", "acc length", "ITL (ms)", "input cost ($/1M)", "output cost ($/1M)", "cache hit rate", ] if bench_args.profile: headers.append("profile") for res in results: hourly_cost = hourly_cost_per_gpu * server_args.tp_size accept_length = f"{res.acc_length:.2f}" if res.acc_length > 0 else "n/a" itl_ms = 1000 * res.batch_size / res.output_throughput input_cost = 1e6 / (res.input_throughput * input_util) / 3600 * hourly_cost output_cost = 1e6 / res.output_throughput / 3600 * hourly_cost cache_hit_rate = ( f"{res.cache_hit_rate:.4f}" if res.cache_hit_rate is not None else "n/a" ) row = [ res.batch_size, res.input_len, f"{res.latency:.2f}", f"{res.input_throughput:.2f}", f"{res.output_throughput:.2f}", accept_length, f"{itl_ms:.2f}", f"{input_cost:.2f}", f"{output_cost:.2f}", cache_hit_rate, ] if bench_args.profile: if res.profile_link: row.append(f"[Profile]({res.profile_link})") else: row.append("n/a") rows.append(row) summary += tabulate(rows, headers=headers, tablefmt="github") summary += "\n" return summary def run_benchmark_internal( server_args: ServerArgs, bench_args: BenchArgs, launch_server_func: Callable = launch_server, ): # set random seed random.seed(bench_args.seed) np.random.seed(bench_args.seed) # launch a server or use the provided base_url if bench_args.base_url: proc, base_url = None, bench_args.base_url else: proc, base_url = launch_server_process(launch_server_func, server_args) # Get tokenizer response = requests.get(base_url + "/get_server_info", timeout=DEFAULT_TIMEOUT) response.raise_for_status() server_info = response.json() if "tokenizer_path" in server_info: tokenizer_path = server_info["tokenizer_path"] elif "prefill" in server_info: tokenizer_path = server_info["prefill"][0]["tokenizer_path"] if bench_args.dataset_name == "mmmu": # mmmu implies this is a MLLM tokenizer = get_processor(tokenizer_path) else: tokenizer = get_tokenizer(tokenizer_path) # Get token capacity internal_state = server_info.get("internal_states", [{}]) skip_token_capacity_threshold = ( internal_state[0].get("memory_usage", {}).get("token_capacity", 1000000000) ) # Get effective max running requests max_running_requests_per_dp = internal_state[0].get( "effective_max_running_requests_per_dp", -1 ) dp_size = server_info.get("dp_size", None) or 1 assert ( max_running_requests_per_dp > 0 ), f"effective_max_running_requests_per_dp is not set, {max_running_requests_per_dp=}" skip_max_running_requests_threshold = max_running_requests_per_dp * dp_size # Warmup if not bench_args.skip_warmup: print("=" * 8 + " Warmup Begin " + "=" * 8) print(f"Warmup with batch_size={bench_args.batch_size}") for bs in bench_args.batch_size: run_one_case( base_url, batch_size=bs, input_len=1024, output_len=16, temperature=bench_args.temperature, return_logprob=bench_args.return_logprob, stream_interval=bench_args.client_stream_interval, input_len_step_percentage=bench_args.input_len_step_percentage, run_name="", result_filename="", tokenizer=tokenizer, dataset_name=bench_args.dataset_name, dataset_path=bench_args.dataset_path, parallel_batch=bench_args.parallel_batch, ) print("=" * 8 + " Warmup End " + "=" * 8 + "\n") results = [] profile_results = [] try: # Benchmark all cases for bs, il, ol in itertools.product( bench_args.batch_size, bench_args.input_len, bench_args.output_len ): if should_skip_due_to_max_running_requests( bs, skip_max_running_requests_threshold ) or should_skip_due_to_token_capacity( bs, il, ol, skip_token_capacity_threshold ): continue results.append( run_one_case( base_url, bs, il, ol, temperature=bench_args.temperature, return_logprob=bench_args.return_logprob, stream_interval=bench_args.client_stream_interval, input_len_step_percentage=bench_args.input_len_step_percentage, run_name=bench_args.run_name, result_filename=bench_args.result_filename, tokenizer=tokenizer, dataset_name=bench_args.dataset_name, dataset_path=bench_args.dataset_path, parallel_batch=bench_args.parallel_batch, cache_hit_rate=bench_args.cache_hit_rate, ) ) # Profile all cases if bench_args.profile: try: for bs, il, ol in itertools.product( bench_args.batch_size, bench_args.input_len, bench_args.output_len ): if should_skip_due_to_max_running_requests( bs, skip_max_running_requests_threshold ) or should_skip_due_to_token_capacity( bs, il, ol, skip_token_capacity_threshold ): continue profile_prefix = ( bench_args.profile_prefix or "" ) + f"bs-{bs}-il-{il}" profile_results.append( run_one_case( base_url, bs, il, ol, temperature=bench_args.temperature, return_logprob=bench_args.return_logprob, stream_interval=bench_args.client_stream_interval, input_len_step_percentage=bench_args.input_len_step_percentage, run_name=bench_args.run_name, result_filename=bench_args.result_filename, tokenizer=tokenizer, dataset_name=bench_args.dataset_name, dataset_path=bench_args.dataset_path, parallel_batch=bench_args.parallel_batch, cache_hit_rate=bench_args.cache_hit_rate, profile=bench_args.profile, profile_steps=bench_args.profile_steps, profile_by_stage=bench_args.profile_by_stage, profile_prefix=profile_prefix, profile_output_dir=bench_args.profile_output_dir, ) ) except Exception as e: print(f"Error profiling, some profile traces may not be dumped: {e}") # Replace the profile link for any successful profile results for res, profile_res in zip(results, profile_results, strict=False): res.profile_link = profile_res.profile_link finally: if proc: kill_process_tree(proc.pid) print(f"\nResults are saved to {bench_args.result_filename}") if not bench_args.show_report: return results, server_info # Print summary summary = get_report_summary(results, bench_args, server_args) print(summary) if is_in_ci() and bench_args.append_to_github_summary: write_github_step_summary(summary) return results, server_info