mirror of
https://github.com/BerriAI/litellm.git
synced 2026-10-13 03:59:12 +00:00
- scripts/run_benchmark_rps_suite.py: run benchmark at 1k, 2k, ..., 10k RPS sequentially - Each run writes to benchmark_results_<rps>rps.txt (e.g. benchmark_results_1000rps.txt) - First run waits for proxy; runs 2–10 use --no-wait. --output-dir, --requests supported - proxy_cli: LITELLM_AUTO_BENCHMARK_RPS_SUITE=1 runs suite when proxy is up - Optional: LITELLM_AUTO_BENCHMARK_OUTPUT_DIR, LITELLM_AUTO_BENCHMARK_REQUESTS
1017 lines
36 KiB
Python
1017 lines
36 KiB
Python
# ruff: noqa: T201
|
||
import importlib
|
||
import json
|
||
import os
|
||
import random
|
||
import subprocess
|
||
import sys
|
||
import threading
|
||
import urllib.parse as urlparse
|
||
from typing import TYPE_CHECKING, Any, Optional, Union
|
||
|
||
import click
|
||
import httpx
|
||
from dotenv import load_dotenv
|
||
|
||
from litellm.constants import DEFAULT_NUM_WORKERS_LITELLM_PROXY
|
||
from litellm.secret_managers.main import get_secret_bool
|
||
|
||
if TYPE_CHECKING:
|
||
from fastapi import FastAPI
|
||
else:
|
||
FastAPI = Any
|
||
|
||
sys.path.append(os.getcwd())
|
||
|
||
config_filename = "litellm.secrets"
|
||
|
||
litellm_mode = os.getenv("LITELLM_MODE", "DEV") # "PRODUCTION", "DEV"
|
||
if litellm_mode == "DEV":
|
||
load_dotenv()
|
||
from enum import Enum
|
||
|
||
telemetry = None
|
||
|
||
|
||
class LiteLLMDatabaseConnectionPool(Enum):
|
||
database_connection_pool_limit = 10
|
||
database_connection_pool_timeout = 60
|
||
|
||
|
||
def append_query_params(url, params) -> str:
|
||
from litellm._logging import verbose_proxy_logger
|
||
|
||
verbose_proxy_logger.debug(f"url: {url}")
|
||
verbose_proxy_logger.debug(f"params: {params}")
|
||
parsed_url = urlparse.urlparse(url)
|
||
parsed_query = urlparse.parse_qs(parsed_url.query)
|
||
parsed_query.update(params)
|
||
encoded_query = urlparse.urlencode(parsed_query, doseq=True)
|
||
modified_url = urlparse.urlunparse(parsed_url._replace(query=encoded_query))
|
||
return modified_url # type: ignore
|
||
|
||
|
||
class ProxyInitializationHelpers:
|
||
@staticmethod
|
||
def _echo_litellm_version():
|
||
pkg_version = importlib.metadata.version("litellm") # type: ignore
|
||
click.echo(f"\nLiteLLM: Current Version = {pkg_version}\n")
|
||
|
||
@staticmethod
|
||
def _run_health_check(host, port):
|
||
print("\nLiteLLM: Health Testing models in config") # noqa
|
||
response = httpx.get(url=f"http://{host}:{port}/health")
|
||
print(json.dumps(response.json(), indent=4)) # noqa
|
||
|
||
@staticmethod
|
||
def _run_test_chat_completion(
|
||
host: str,
|
||
port: int,
|
||
model: str,
|
||
test: Union[bool, str],
|
||
):
|
||
request_model = model or "gpt-3.5-turbo"
|
||
click.echo(
|
||
f"\nLiteLLM: Making a test ChatCompletions request to your proxy. Model={request_model}"
|
||
)
|
||
import openai
|
||
|
||
api_base = f"http://{host}:{port}"
|
||
if isinstance(test, str):
|
||
api_base = test
|
||
else:
|
||
raise ValueError("Invalid test value")
|
||
client = openai.OpenAI(api_key="My API Key", base_url=api_base)
|
||
|
||
response = client.chat.completions.create(
|
||
model=request_model,
|
||
messages=[
|
||
{
|
||
"role": "user",
|
||
"content": "this is a test request, write a short poem",
|
||
}
|
||
],
|
||
max_tokens=256,
|
||
)
|
||
click.echo(f"\nLiteLLM: response from proxy {response}")
|
||
|
||
print( # noqa
|
||
f"\n LiteLLM: Making a test ChatCompletions + streaming r equest to proxy. Model={request_model}"
|
||
)
|
||
|
||
stream_response = client.chat.completions.create(
|
||
model=request_model,
|
||
messages=[
|
||
{
|
||
"role": "user",
|
||
"content": "this is a test request, write a short poem",
|
||
}
|
||
],
|
||
stream=True,
|
||
)
|
||
for chunk in stream_response:
|
||
click.echo(f"LiteLLM: streaming response from proxy {chunk}")
|
||
print("\n making completion request to proxy") # noqa
|
||
completion_response = client.completions.create(
|
||
model=request_model, prompt="this is a test request, write a short poem"
|
||
)
|
||
print(completion_response) # noqa
|
||
|
||
@staticmethod
|
||
def _get_mock_chat_endpoint() -> tuple:
|
||
"""Return (base_url, port) for mock chat API from LITELLM_MOCK_CHAT_ENDPOINT (default http://localhost:8090)."""
|
||
endpoint = os.getenv("LITELLM_MOCK_CHAT_ENDPOINT", "http://localhost:8090").strip().rstrip("/")
|
||
if endpoint.isdigit():
|
||
port = int(endpoint)
|
||
return f"http://localhost:{port}", port
|
||
parsed = urlparse.urlparse(endpoint)
|
||
port = parsed.port if parsed.port is not None else 8090
|
||
base = endpoint if parsed.scheme else f"http://localhost:{port}"
|
||
return base, port
|
||
|
||
@staticmethod
|
||
def _start_mock_chat_api_once() -> None:
|
||
"""Start the mock chat completions API once in the main process (for testing). Set LITELLM_MOCK_CHAT_API=1 to enable (or use LITELLM_AUTO_BENCHMARK=1, which starts the mock too)."""
|
||
enabled = os.getenv("LITELLM_MOCK_CHAT_API", "").strip().lower() in ("1", "true", "yes")
|
||
auto_benchmark = os.getenv("LITELLM_AUTO_BENCHMARK", "").strip().lower() in ("1", "true", "yes")
|
||
if not enabled and not auto_benchmark:
|
||
return
|
||
_proxy_cli_dir = os.path.dirname(os.path.abspath(__file__))
|
||
_litellm_root = os.path.dirname(_proxy_cli_dir)
|
||
_repo_root = os.path.dirname(_litellm_root)
|
||
if _repo_root not in sys.path:
|
||
sys.path.insert(0, _repo_root)
|
||
try:
|
||
from chat_completions_api import app as mock_chat_app
|
||
except ImportError:
|
||
return
|
||
|
||
_, mock_port = ProxyInitializationHelpers._get_mock_chat_endpoint()
|
||
|
||
def _run_mock():
|
||
import uvicorn
|
||
|
||
uvicorn.run(
|
||
mock_chat_app,
|
||
host="0.0.0.0",
|
||
port=mock_port,
|
||
log_level="error",
|
||
)
|
||
|
||
t = threading.Thread(target=_run_mock, daemon=True)
|
||
t.start()
|
||
print( # noqa: T201
|
||
f"\033[1;32mLiteLLM: Mock chat completions API started on http://0.0.0.0:{mock_port} (for testing)\033[0m\n"
|
||
)
|
||
|
||
@staticmethod
|
||
def _start_auto_benchmark_when_proxy_up(host: str, port: int) -> None:
|
||
"""When LITELLM_AUTO_BENCHMARK=1, wait for proxy health then run benchmark and save output to a .txt file."""
|
||
if not os.getenv("LITELLM_AUTO_BENCHMARK", "").strip().lower() in ("1", "true", "yes"):
|
||
return
|
||
|
||
_proxy_cli_dir = os.path.dirname(os.path.abspath(__file__))
|
||
_litellm_root = os.path.dirname(_proxy_cli_dir)
|
||
_repo_root = os.path.dirname(_litellm_root)
|
||
rps_suite = os.getenv("LITELLM_AUTO_BENCHMARK_RPS_SUITE", "").strip().lower() in ("1", "true", "yes")
|
||
if rps_suite:
|
||
script_path = os.path.join(_repo_root, "scripts", "run_benchmark_rps_suite.py")
|
||
else:
|
||
script_path = os.path.join(_repo_root, "scripts", "run_benchmark_after_proxy.py")
|
||
if not os.path.isfile(script_path):
|
||
return
|
||
|
||
output = os.getenv("LITELLM_AUTO_BENCHMARK_OUTPUT", "").strip()
|
||
output_dir = os.getenv("LITELLM_AUTO_BENCHMARK_OUTPUT_DIR", "").strip()
|
||
extra_args_str = os.getenv("LITELLM_AUTO_BENCHMARK_ARGS", "--rps-control 10000 --requests 500000").strip()
|
||
extra_args = extra_args_str.split() if extra_args_str else ["--rps-control", "10000", "--requests", "500000"]
|
||
|
||
def _run():
|
||
import time
|
||
|
||
try:
|
||
import httpx
|
||
except ImportError:
|
||
print("LiteLLM: Auto-benchmark skipped (httpx not installed)", file=sys.stderr)
|
||
return
|
||
# Use 127.0.0.1 for health check so it works on Windows when proxy binds to 0.0.0.0
|
||
health_host = "127.0.0.1" if host == "0.0.0.0" else host
|
||
health_url = f"http://{health_host}:{port}/health"
|
||
proxy_base_url = f"http://{health_host}:{port}"
|
||
# Give proxy a moment to bind after uvicorn.run() starts
|
||
time.sleep(3.0)
|
||
deadline = time.monotonic() + 300
|
||
while time.monotonic() < deadline:
|
||
try:
|
||
r = httpx.get(health_url, timeout=5.0)
|
||
if r.status_code == 200:
|
||
break
|
||
except Exception:
|
||
pass
|
||
time.sleep(2.0)
|
||
else:
|
||
print("LiteLLM: Auto-benchmark timed out waiting for proxy health", file=sys.stderr)
|
||
return
|
||
# Proxy is up: run benchmark (single run or RPS suite)
|
||
from datetime import datetime
|
||
|
||
mock_base, _ = ProxyInitializationHelpers._get_mock_chat_endpoint()
|
||
provider_url_default = f"{mock_base.rstrip('/')}/chat/completions"
|
||
env = os.environ.copy()
|
||
env["LITELLM_PROXY_URL"] = f"{proxy_base_url}/chat/completions"
|
||
env.setdefault("PROVIDER_URL", provider_url_default)
|
||
|
||
if rps_suite:
|
||
cmd = [sys.executable, script_path, "--no-wait", "--proxy-url", env["LITELLM_PROXY_URL"], "--provider-url", env["PROVIDER_URL"]]
|
||
if output_dir:
|
||
cmd.extend(["--output-dir", output_dir if os.path.isabs(output_dir) else os.path.join(_repo_root, output_dir)])
|
||
requests_env = os.getenv("LITELLM_AUTO_BENCHMARK_REQUESTS", "").strip()
|
||
if requests_env.isdigit():
|
||
cmd.extend(["--requests", requests_env])
|
||
try:
|
||
print("LiteLLM: Auto-benchmark RPS suite starting (1k–10k RPS, 10 runs)", flush=True)
|
||
subprocess.run(cmd, env=env, cwd=_repo_root)
|
||
except Exception as e:
|
||
print(f"LiteLLM: Auto-benchmark RPS suite failed: {e}", file=sys.stderr)
|
||
else:
|
||
if not output:
|
||
out_path = os.path.join(_repo_root, f"benchmark_results_{datetime.now().strftime('%Y%m%d_%H%M%S')}.txt")
|
||
else:
|
||
out_path = output if os.path.isabs(output) else os.path.join(_repo_root, output)
|
||
cmd = [sys.executable, script_path, "--no-wait", "--output", out_path, "--proxy-url", env["LITELLM_PROXY_URL"], "--provider-url", env["PROVIDER_URL"]] + extra_args
|
||
try:
|
||
print(f"LiteLLM: Auto-benchmark starting, output -> {out_path}", flush=True)
|
||
subprocess.run(cmd, env=env, cwd=_repo_root)
|
||
except Exception as e:
|
||
print(f"LiteLLM: Auto-benchmark failed: {e}", file=sys.stderr)
|
||
|
||
t = threading.Thread(target=_run, daemon=True)
|
||
t.start()
|
||
print( # noqa: T201
|
||
"\033[1;32mLiteLLM: Auto-benchmark enabled; will run when proxy is up and save output to .txt\033[0m\n"
|
||
)
|
||
|
||
@staticmethod
|
||
def _get_default_unvicorn_init_args(
|
||
host: str,
|
||
port: int,
|
||
log_config: Optional[str] = None,
|
||
keepalive_timeout: Optional[int] = None,
|
||
) -> dict:
|
||
"""
|
||
Get the arguments for `uvicorn` worker
|
||
"""
|
||
import litellm
|
||
from litellm._logging import _get_uvicorn_json_log_config
|
||
|
||
uvicorn_args = {
|
||
"app": "litellm.proxy.proxy_server:app",
|
||
"host": host,
|
||
"port": port,
|
||
}
|
||
if log_config is not None:
|
||
print(f"Using log_config: {log_config}") # noqa
|
||
uvicorn_args["log_config"] = log_config
|
||
elif litellm.json_logs:
|
||
# Use JSON log config for uvicorn to ensure all logs (including exceptions) are JSON
|
||
uvicorn_args["log_config"] = _get_uvicorn_json_log_config()
|
||
if keepalive_timeout is not None:
|
||
uvicorn_args["timeout_keep_alive"] = keepalive_timeout
|
||
return uvicorn_args
|
||
|
||
@staticmethod
|
||
def _init_hypercorn_server(
|
||
app: FastAPI,
|
||
host: str,
|
||
port: int,
|
||
ssl_certfile_path: str,
|
||
ssl_keyfile_path: str,
|
||
ciphers: Optional[str] = None,
|
||
):
|
||
"""
|
||
Initialize litellm with `hypercorn`
|
||
"""
|
||
import asyncio
|
||
|
||
from hypercorn.asyncio import serve
|
||
from hypercorn.config import Config
|
||
|
||
print( # noqa
|
||
f"\033[1;32mLiteLLM Proxy: Starting server on {host}:{port} using Hypercorn\033[0m\n" # noqa
|
||
) # noqa
|
||
config = Config()
|
||
config.bind = [f"{host}:{port}"]
|
||
|
||
if ssl_certfile_path is not None and ssl_keyfile_path is not None:
|
||
print( # noqa
|
||
f"\033[1;32mLiteLLM Proxy: Using SSL with certfile: {ssl_certfile_path} and keyfile: {ssl_keyfile_path}\033[0m\n" # noqa
|
||
)
|
||
config.certfile = ssl_certfile_path
|
||
config.keyfile = ssl_keyfile_path
|
||
if ciphers is not None:
|
||
config.ciphers = ciphers
|
||
|
||
# hypercorn serve raises a type warning when passing a fast api app - even though fast API is a valid type
|
||
asyncio.run(serve(app, config)) # type: ignore
|
||
|
||
@staticmethod
|
||
def _run_gunicorn_server(
|
||
host: str,
|
||
port: int,
|
||
app: FastAPI,
|
||
num_workers: int,
|
||
ssl_certfile_path: str,
|
||
ssl_keyfile_path: str,
|
||
max_requests_before_restart: Optional[int] = None,
|
||
):
|
||
"""
|
||
Run litellm with `gunicorn`
|
||
"""
|
||
if os.name == "nt":
|
||
pass
|
||
else:
|
||
import gunicorn.app.base
|
||
|
||
# Gunicorn Application Class
|
||
class StandaloneApplication(gunicorn.app.base.BaseApplication):
|
||
def __init__(self, app, options=None):
|
||
self.options = options or {} # gunicorn options
|
||
self.application = app # FastAPI app
|
||
super().__init__()
|
||
|
||
_endpoint_str = (
|
||
f"curl --location 'http://0.0.0.0:{port}/chat/completions' \\"
|
||
)
|
||
curl_command = (
|
||
_endpoint_str
|
||
+ """
|
||
--header 'Content-Type: application/json' \\
|
||
--data ' {
|
||
"model": "gpt-3.5-turbo",
|
||
"messages": [
|
||
{
|
||
"role": "user",
|
||
"content": "what llm are you"
|
||
}
|
||
]
|
||
}'
|
||
\n
|
||
"""
|
||
)
|
||
print() # noqa
|
||
print( # noqa
|
||
'\033[1;34mLiteLLM: Test your local proxy with: "litellm --test" This runs an openai.ChatCompletion request to your proxy [In a new terminal tab]\033[0m\n'
|
||
)
|
||
print( # noqa
|
||
f"\033[1;34mLiteLLM: Curl Command Test for your local proxy\n {curl_command} \033[0m\n"
|
||
)
|
||
print( # noqa
|
||
"\033[1;34mDocs: https://docs.litellm.ai/docs/simple_proxy\033[0m\n"
|
||
) # noqa
|
||
print( # noqa
|
||
f"\033[1;34mSee all Router/Swagger docs on http://0.0.0.0:{port} \033[0m\n"
|
||
) # noqa
|
||
|
||
def load_config(self):
|
||
# note: This Loads the gunicorn config - has nothing to do with LiteLLM Proxy config
|
||
if self.cfg is not None:
|
||
config = {
|
||
key: value
|
||
for key, value in self.options.items()
|
||
if key in self.cfg.settings and value is not None
|
||
}
|
||
else:
|
||
config = {}
|
||
for key, value in config.items():
|
||
if self.cfg is not None:
|
||
self.cfg.set(key.lower(), value)
|
||
|
||
def load(self):
|
||
# gunicorn app function
|
||
return self.application
|
||
|
||
print( # noqa
|
||
f"\033[1;32mLiteLLM Proxy: Starting server on {host}:{port} with {num_workers} workers\033[0m\n" # noqa
|
||
)
|
||
gunicorn_options = {
|
||
"bind": f"{host}:{port}",
|
||
"workers": num_workers, # default is 1
|
||
"worker_class": "uvicorn.workers.UvicornWorker",
|
||
"preload": True, # Add the preload flag,
|
||
"accesslog": "-", # Log to stdout
|
||
"timeout": 600, # default to very high number, bedrock/anthropic.claude-v2:1 can take 30+ seconds for the 1st chunk to come in
|
||
"access_log_format": '%(h)s %(l)s %(u)s %(t)s "%(r)s" %(s)s %(b)s',
|
||
}
|
||
|
||
# Optional: recycle workers after N requests to mitigate memory growth
|
||
if max_requests_before_restart is not None:
|
||
gunicorn_options["max_requests"] = max_requests_before_restart
|
||
|
||
if ssl_certfile_path is not None and ssl_keyfile_path is not None:
|
||
print( # noqa
|
||
f"\033[1;32mLiteLLM Proxy: Using SSL with certfile: {ssl_certfile_path} and keyfile: {ssl_keyfile_path}\033[0m\n" # noqa
|
||
)
|
||
gunicorn_options["certfile"] = ssl_certfile_path
|
||
gunicorn_options["keyfile"] = ssl_keyfile_path
|
||
|
||
StandaloneApplication(app=app, options=gunicorn_options).run() # Run gunicorn
|
||
|
||
@staticmethod
|
||
def _run_ollama_serve():
|
||
try:
|
||
command = ["ollama", "serve"]
|
||
|
||
with open(os.devnull, "w") as devnull:
|
||
subprocess.Popen(command, stdout=devnull, stderr=devnull)
|
||
except Exception as e:
|
||
print( # noqa
|
||
f"""
|
||
LiteLLM Warning: proxy started with `ollama` model\n`ollama serve` failed with Exception{e}. \nEnsure you run `ollama serve`
|
||
"""
|
||
) # noqa
|
||
|
||
@staticmethod
|
||
def _is_port_in_use(port):
|
||
import socket
|
||
|
||
with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as s:
|
||
return s.connect_ex(("localhost", port)) == 0
|
||
|
||
@staticmethod
|
||
def _get_loop_type():
|
||
"""Helper function to determine the event loop type based on platform"""
|
||
if sys.platform in ("win32", "cygwin", "cli"):
|
||
return None # Let uvicorn choose the default loop on Windows
|
||
return "uvloop"
|
||
|
||
|
||
@click.command()
|
||
@click.option(
|
||
"--host", default="0.0.0.0", help="Host for the server to listen on.", envvar="HOST"
|
||
)
|
||
@click.option("--port", default=4000, help="Port to bind the server to.", envvar="PORT")
|
||
@click.option(
|
||
"--num_workers",
|
||
default=DEFAULT_NUM_WORKERS_LITELLM_PROXY,
|
||
help="Number of uvicorn / gunicorn workers to spin up. By default, it equals the number of logical CPUs in the system, or 4 workers if that cannot be determined.",
|
||
envvar="NUM_WORKERS",
|
||
)
|
||
@click.option("--api_base", default=None, help="API base URL.")
|
||
@click.option(
|
||
"--api_version",
|
||
default="2024-07-01-preview",
|
||
help="For azure - pass in the api version.",
|
||
)
|
||
@click.option(
|
||
"--model", "-m", default=None, help="The model name to pass to litellm expects"
|
||
)
|
||
@click.option(
|
||
"--alias",
|
||
default=None,
|
||
help='The alias for the model - use this to give a litellm model name (e.g. "huggingface/codellama/CodeLlama-7b-Instruct-hf") a more user-friendly name ("codellama")',
|
||
)
|
||
@click.option(
|
||
"--add_key", default=None, help="The model name to pass to litellm expects"
|
||
)
|
||
@click.option("--headers", default=None, help="headers for the API call")
|
||
@click.option("--save", is_flag=True, type=bool, help="Save the model-specific config")
|
||
@click.option(
|
||
"--debug",
|
||
default=False,
|
||
is_flag=True,
|
||
type=bool,
|
||
help="To debug the input",
|
||
envvar="DEBUG",
|
||
)
|
||
@click.option(
|
||
"--detailed_debug",
|
||
default=False,
|
||
is_flag=True,
|
||
type=bool,
|
||
help="To view detailed debug logs",
|
||
envvar="DETAILED_DEBUG",
|
||
)
|
||
@click.option(
|
||
"--use_queue",
|
||
default=False,
|
||
is_flag=True,
|
||
type=bool,
|
||
help="To use celery workers for async endpoints",
|
||
)
|
||
@click.option(
|
||
"--temperature", default=None, type=float, help="Set temperature for the model"
|
||
)
|
||
@click.option(
|
||
"--max_tokens", default=None, type=int, help="Set max tokens for the model"
|
||
)
|
||
@click.option(
|
||
"--request_timeout",
|
||
default=None,
|
||
type=int,
|
||
help="Set timeout in seconds for completion calls",
|
||
)
|
||
@click.option("--drop_params", is_flag=True, help="Drop any unmapped params")
|
||
@click.option(
|
||
"--add_function_to_prompt",
|
||
is_flag=True,
|
||
help="If function passed but unsupported, pass it as prompt",
|
||
)
|
||
@click.option(
|
||
"--config",
|
||
"-c",
|
||
default=None,
|
||
help="Path to the proxy configuration file (e.g. config.yaml). Usage `litellm --config config.yaml`",
|
||
)
|
||
@click.option(
|
||
"--max_budget",
|
||
default=None,
|
||
type=float,
|
||
help="Set max budget for API calls - works for hosted models like OpenAI, TogetherAI, Anthropic, etc.`",
|
||
)
|
||
@click.option(
|
||
"--telemetry",
|
||
default=True,
|
||
type=bool,
|
||
help="Helps us know if people are using this feature. Turn this off by doing `--telemetry False`",
|
||
)
|
||
@click.option(
|
||
"--log_config",
|
||
default=None,
|
||
type=str,
|
||
help="Path to the logging configuration file",
|
||
)
|
||
@click.option(
|
||
"--version",
|
||
"-v",
|
||
default=False,
|
||
is_flag=True,
|
||
type=bool,
|
||
help="Print LiteLLM version",
|
||
)
|
||
@click.option(
|
||
"--health",
|
||
flag_value=True,
|
||
help="Make a chat/completions request to all llms in config.yaml",
|
||
)
|
||
@click.option(
|
||
"--test",
|
||
flag_value=True,
|
||
help="proxy chat completions url to make a test request to",
|
||
)
|
||
@click.option(
|
||
"--test_async",
|
||
default=False,
|
||
is_flag=True,
|
||
help="Calls async endpoints /queue/requests and /queue/response",
|
||
)
|
||
@click.option(
|
||
"--iam_token_db_auth",
|
||
default=False,
|
||
is_flag=True,
|
||
help="Connects to RDS DB with IAM token",
|
||
)
|
||
@click.option(
|
||
"--num_requests",
|
||
default=10,
|
||
type=int,
|
||
help="Number of requests to hit async endpoint with",
|
||
)
|
||
@click.option(
|
||
"--run_gunicorn",
|
||
default=False,
|
||
is_flag=True,
|
||
help="Starts proxy via gunicorn, instead of uvicorn (better for managing multiple workers)",
|
||
)
|
||
@click.option(
|
||
"--run_hypercorn",
|
||
default=False,
|
||
is_flag=True,
|
||
help="Starts proxy via hypercorn, instead of uvicorn (supports HTTP/2)",
|
||
)
|
||
@click.option(
|
||
"--ssl_keyfile_path",
|
||
default=None,
|
||
type=str,
|
||
help="Path to the SSL keyfile. Use this when you want to provide SSL certificate when starting proxy",
|
||
envvar="SSL_KEYFILE_PATH",
|
||
)
|
||
@click.option(
|
||
"--ssl_certfile_path",
|
||
default=None,
|
||
type=str,
|
||
help="Path to the SSL certfile. Use this when you want to provide SSL certificate when starting proxy",
|
||
envvar="SSL_CERTFILE_PATH",
|
||
)
|
||
@click.option(
|
||
"--ciphers",
|
||
default=None,
|
||
type=str,
|
||
help="Ciphers to use for the SSL setup.",
|
||
)
|
||
@click.option(
|
||
"--use_prisma_db_push",
|
||
is_flag=True,
|
||
default=False,
|
||
help="Use prisma db push instead of prisma migrate for database schema updates",
|
||
)
|
||
@click.option("--local", is_flag=True, default=False, help="for local debugging")
|
||
@click.option(
|
||
"--skip_server_startup",
|
||
is_flag=True,
|
||
default=False,
|
||
help="Skip starting the server after setup (useful for migrations only)",
|
||
)
|
||
@click.option(
|
||
"--keepalive_timeout",
|
||
default=None,
|
||
type=int,
|
||
help="Set the uvicorn keepalive timeout in seconds (uvicorn timeout_keep_alive parameter)",
|
||
envvar="KEEPALIVE_TIMEOUT",
|
||
)
|
||
@click.option(
|
||
"--max_requests_before_restart",
|
||
default=None,
|
||
type=int,
|
||
help="Restart worker after this many requests (uvicorn: limit_max_requests, gunicorn: max_requests)",
|
||
envvar="MAX_REQUESTS_BEFORE_RESTART",
|
||
)
|
||
def run_server( # noqa: PLR0915
|
||
host,
|
||
port,
|
||
api_base,
|
||
api_version,
|
||
model,
|
||
alias,
|
||
add_key,
|
||
headers,
|
||
save,
|
||
debug,
|
||
detailed_debug,
|
||
temperature,
|
||
max_tokens,
|
||
request_timeout,
|
||
drop_params,
|
||
add_function_to_prompt,
|
||
config,
|
||
max_budget,
|
||
telemetry,
|
||
test,
|
||
local,
|
||
num_workers,
|
||
test_async,
|
||
iam_token_db_auth,
|
||
num_requests,
|
||
use_queue,
|
||
health,
|
||
version,
|
||
run_gunicorn,
|
||
run_hypercorn,
|
||
ssl_keyfile_path,
|
||
ssl_certfile_path,
|
||
ciphers,
|
||
log_config,
|
||
use_prisma_db_push: bool,
|
||
skip_server_startup,
|
||
keepalive_timeout,
|
||
max_requests_before_restart,
|
||
):
|
||
args = locals()
|
||
if local:
|
||
from proxy_server import (
|
||
KeyManagementSettings,
|
||
ProxyConfig,
|
||
app,
|
||
save_worker_config,
|
||
)
|
||
else:
|
||
try:
|
||
from .proxy_server import (
|
||
KeyManagementSettings,
|
||
ProxyConfig,
|
||
app,
|
||
save_worker_config,
|
||
)
|
||
except ModuleNotFoundError as e:
|
||
raise ModuleNotFoundError(
|
||
f"Missing dependency {e}. Run `pip install 'litellm[proxy]'`"
|
||
)
|
||
except ImportError as e:
|
||
if "litellm[proxy]" in str(e):
|
||
# user is missing a proxy dependency, ask them to pip install litellm[proxy]
|
||
raise e
|
||
else:
|
||
# this is just a local/relative import error, user git cloned litellm
|
||
from proxy_server import (
|
||
KeyManagementSettings,
|
||
ProxyConfig,
|
||
app,
|
||
save_worker_config,
|
||
)
|
||
if version is True:
|
||
ProxyInitializationHelpers._echo_litellm_version()
|
||
return
|
||
if model and "ollama" in model and api_base is None:
|
||
ProxyInitializationHelpers._run_ollama_serve()
|
||
if health is True:
|
||
ProxyInitializationHelpers._run_health_check(host, port)
|
||
return
|
||
if test is True:
|
||
ProxyInitializationHelpers._run_test_chat_completion(host, port, model, test)
|
||
return
|
||
else:
|
||
if headers:
|
||
headers = json.loads(headers)
|
||
save_worker_config(
|
||
model=model,
|
||
alias=alias,
|
||
api_base=api_base,
|
||
api_version=api_version,
|
||
debug=debug,
|
||
detailed_debug=detailed_debug,
|
||
temperature=temperature,
|
||
max_tokens=max_tokens,
|
||
request_timeout=request_timeout,
|
||
max_budget=max_budget,
|
||
telemetry=telemetry,
|
||
drop_params=drop_params,
|
||
add_function_to_prompt=add_function_to_prompt,
|
||
headers=headers,
|
||
save=save,
|
||
config=config,
|
||
use_queue=use_queue,
|
||
)
|
||
try:
|
||
import uvicorn
|
||
except Exception:
|
||
raise ImportError(
|
||
"uvicorn, gunicorn needs to be imported. Run - `pip install 'litellm[proxy]'`"
|
||
)
|
||
|
||
db_connection_pool_limit = 100
|
||
db_connection_timeout = 60
|
||
general_settings = {}
|
||
### GET DB TOKEN FOR IAM AUTH ###
|
||
|
||
if iam_token_db_auth or get_secret_bool("IAM_TOKEN_DB_AUTH"):
|
||
from litellm.proxy.auth.rds_iam_token import generate_iam_auth_token
|
||
|
||
db_host = os.getenv("DATABASE_HOST")
|
||
db_port = os.getenv("DATABASE_PORT")
|
||
db_user = os.getenv("DATABASE_USER")
|
||
db_name = os.getenv("DATABASE_NAME")
|
||
db_schema = os.getenv("DATABASE_SCHEMA")
|
||
|
||
token = generate_iam_auth_token(
|
||
db_host=db_host, db_port=db_port, db_user=db_user
|
||
)
|
||
|
||
# print(f"token: {token}")
|
||
_db_url = f"postgresql://{db_user}:{token}@{db_host}:{db_port}/{db_name}"
|
||
if db_schema:
|
||
_db_url += f"?schema={db_schema}"
|
||
|
||
os.environ["DATABASE_URL"] = _db_url
|
||
os.environ["IAM_TOKEN_DB_AUTH"] = "True"
|
||
|
||
### DECRYPT ENV VAR ###
|
||
|
||
from litellm.secret_managers.aws_secret_manager import decrypt_env_var
|
||
|
||
if (
|
||
os.getenv("USE_AWS_KMS", None) is not None
|
||
and os.getenv("USE_AWS_KMS") == "True"
|
||
):
|
||
## V2 IMPLEMENTATION OF AWS KMS - USER WANTS TO DECRYPT MULTIPLE KEYS IN THEIR ENV
|
||
new_env_var = decrypt_env_var()
|
||
|
||
for k, v in new_env_var.items():
|
||
os.environ[k] = v
|
||
|
||
if config is not None:
|
||
"""
|
||
Allow user to pass in db url via config
|
||
|
||
read from there and save it to os.env['DATABASE_URL']
|
||
"""
|
||
try:
|
||
import asyncio
|
||
|
||
except Exception:
|
||
raise ImportError(
|
||
"yaml needs to be imported. Run - `pip install 'litellm[proxy]'`"
|
||
)
|
||
|
||
proxy_config = ProxyConfig()
|
||
_config = asyncio.run(proxy_config.get_config(config_file_path=config))
|
||
|
||
### LITELLM SETTINGS ###
|
||
litellm_settings = _config.get("litellm_settings", None)
|
||
if (
|
||
litellm_settings is not None
|
||
and "json_logs" in litellm_settings
|
||
and litellm_settings["json_logs"] is True
|
||
):
|
||
import litellm
|
||
|
||
litellm.json_logs = True
|
||
|
||
litellm._turn_on_json()
|
||
### GENERAL SETTINGS ###
|
||
general_settings = _config.get("general_settings", {})
|
||
if general_settings is None:
|
||
general_settings = {}
|
||
### LOAD KEY MANAGEMENT SETTINGS FIRST (needed for custom secret manager) ###
|
||
key_management_settings = general_settings.get(
|
||
"key_management_settings", None
|
||
)
|
||
if key_management_settings is not None:
|
||
import litellm
|
||
|
||
litellm._key_management_settings = KeyManagementSettings(
|
||
**key_management_settings
|
||
)
|
||
|
||
if general_settings:
|
||
### LOAD SECRET MANAGER ###
|
||
key_management_system = general_settings.get(
|
||
"key_management_system", None
|
||
)
|
||
proxy_config.initialize_secret_manager(
|
||
key_management_system=key_management_system, config_file_path=config
|
||
)
|
||
database_url = general_settings.get("database_url", None)
|
||
if database_url is None and os.getenv("DATABASE_URL") is None:
|
||
# Use helper function to construct DATABASE_URL from individual variables
|
||
from litellm.proxy.utils import construct_database_url_from_env_vars
|
||
|
||
database_url = construct_database_url_from_env_vars()
|
||
if database_url:
|
||
os.environ["DATABASE_URL"] = database_url
|
||
db_connection_pool_limit = general_settings.get(
|
||
"database_connection_pool_limit",
|
||
LiteLLMDatabaseConnectionPool.database_connection_pool_limit.value,
|
||
)
|
||
db_connection_timeout = general_settings.get(
|
||
"database_connection_pool_timeout",
|
||
LiteLLMDatabaseConnectionPool.database_connection_pool_timeout.value,
|
||
)
|
||
if database_url and database_url.startswith("os.environ/"):
|
||
original_dir = os.getcwd()
|
||
# set the working directory to where this script is
|
||
sys.path.insert(
|
||
0, os.path.abspath("../..")
|
||
) # Adds the parent directory to the system path - for litellm local dev
|
||
import litellm
|
||
from litellm import get_secret_str
|
||
|
||
database_url = get_secret_str(database_url, default_value=None)
|
||
os.chdir(original_dir)
|
||
if database_url is not None and isinstance(database_url, str):
|
||
os.environ["DATABASE_URL"] = database_url
|
||
|
||
# Handle database URL construction when no config file is used
|
||
if config is None and os.getenv("DATABASE_URL") is None:
|
||
# Use helper function to construct DATABASE_URL from individual variables
|
||
from litellm.proxy.utils import construct_database_url_from_env_vars
|
||
|
||
database_url = construct_database_url_from_env_vars()
|
||
if database_url:
|
||
os.environ["DATABASE_URL"] = database_url
|
||
|
||
# Set default values for connection pool settings when no config is used
|
||
if config is None:
|
||
db_connection_pool_limit = (
|
||
LiteLLMDatabaseConnectionPool.database_connection_pool_limit.value
|
||
)
|
||
db_connection_timeout = (
|
||
LiteLLMDatabaseConnectionPool.database_connection_pool_timeout.value
|
||
)
|
||
|
||
if (
|
||
os.getenv("DATABASE_URL", None) is not None
|
||
or os.getenv("DIRECT_URL", None) is not None
|
||
):
|
||
try:
|
||
from litellm.secret_managers.main import get_secret
|
||
|
||
if os.getenv("DATABASE_URL", None) is not None:
|
||
### add connection pool + pool timeout args
|
||
params = {
|
||
"connection_limit": db_connection_pool_limit,
|
||
"pool_timeout": db_connection_timeout,
|
||
}
|
||
database_url = get_secret("DATABASE_URL", default_value=None)
|
||
modified_url = append_query_params(database_url, params)
|
||
os.environ["DATABASE_URL"] = modified_url
|
||
if os.getenv("DIRECT_URL", None) is not None:
|
||
### add connection pool + pool timeout args
|
||
params = {
|
||
"connection_limit": db_connection_pool_limit,
|
||
"pool_timeout": db_connection_timeout,
|
||
}
|
||
database_url = os.getenv("DIRECT_URL")
|
||
modified_url = append_query_params(database_url, params)
|
||
os.environ["DIRECT_URL"] = modified_url
|
||
###
|
||
subprocess.run(["prisma"], capture_output=True)
|
||
is_prisma_runnable = True
|
||
except FileNotFoundError:
|
||
is_prisma_runnable = False
|
||
|
||
if is_prisma_runnable:
|
||
from litellm.proxy.db.check_migration import check_prisma_schema_diff
|
||
from litellm.proxy.db.prisma_client import (
|
||
PrismaManager,
|
||
should_update_prisma_schema,
|
||
)
|
||
|
||
if (
|
||
should_update_prisma_schema(
|
||
general_settings.get("disable_prisma_schema_update")
|
||
)
|
||
is False
|
||
):
|
||
check_prisma_schema_diff(db_url=None)
|
||
else:
|
||
PrismaManager.setup_database(use_migrate=not use_prisma_db_push)
|
||
else:
|
||
print( # noqa
|
||
f"Unable to connect to DB. DATABASE_URL found in environment, but prisma package not found." # noqa
|
||
)
|
||
if port == 4000 and ProxyInitializationHelpers._is_port_in_use(port):
|
||
port = random.randint(1024, 49152)
|
||
|
||
import litellm
|
||
|
||
if detailed_debug is True:
|
||
litellm._turn_on_debug()
|
||
|
||
# DO NOT DELETE - enables global variables to work across files
|
||
from litellm.proxy.proxy_server import app # noqa
|
||
|
||
# --- SEPARATE HEALTH APP LOGIC ---
|
||
# To run the health app separately, use:
|
||
# uvicorn litellm.proxy.health_app_factory:build_health_app --factory --host 0.0.0.0 --port=4001
|
||
# This is compatible with the SEPARATE_HEALTH_APP Docker/supervisord pattern.
|
||
# --- END SEPARATE HEALTH APP LOGIC ---
|
||
# Skip server startup if requested (after all setup is done)
|
||
if skip_server_startup:
|
||
print( # noqa
|
||
"LiteLLM: Setup complete. Skipping server startup as requested."
|
||
)
|
||
return
|
||
|
||
# Start mock chat API once in main process (port 8090) before forking workers
|
||
ProxyInitializationHelpers._start_mock_chat_api_once()
|
||
|
||
# When LITELLM_AUTO_BENCHMARK=1, run benchmark when proxy is up and save output to .txt
|
||
ProxyInitializationHelpers._start_auto_benchmark_when_proxy_up(host=host, port=port)
|
||
|
||
uvicorn_args = ProxyInitializationHelpers._get_default_unvicorn_init_args(
|
||
host=host,
|
||
port=port,
|
||
log_config=log_config,
|
||
keepalive_timeout=keepalive_timeout,
|
||
)
|
||
# Optional: recycle uvicorn workers after N requests
|
||
if max_requests_before_restart is not None:
|
||
uvicorn_args["limit_max_requests"] = max_requests_before_restart
|
||
if run_gunicorn is False and run_hypercorn is False:
|
||
if ssl_certfile_path is not None and ssl_keyfile_path is not None:
|
||
print( # noqa
|
||
f"\033[1;32mLiteLLM Proxy: Using SSL with certfile: {ssl_certfile_path} and keyfile: {ssl_keyfile_path}\033[0m\n" # noqa
|
||
)
|
||
uvicorn_args["ssl_keyfile"] = ssl_keyfile_path
|
||
uvicorn_args["ssl_certfile"] = ssl_certfile_path
|
||
|
||
loop_type = ProxyInitializationHelpers._get_loop_type()
|
||
if loop_type:
|
||
uvicorn_args["loop"] = loop_type
|
||
|
||
uvicorn.run(
|
||
**uvicorn_args,
|
||
workers=num_workers,
|
||
)
|
||
elif run_gunicorn is True:
|
||
ProxyInitializationHelpers._run_gunicorn_server(
|
||
host=host,
|
||
port=port,
|
||
app=app,
|
||
num_workers=num_workers,
|
||
ssl_certfile_path=ssl_certfile_path,
|
||
ssl_keyfile_path=ssl_keyfile_path,
|
||
max_requests_before_restart=max_requests_before_restart,
|
||
)
|
||
elif run_hypercorn is True:
|
||
ProxyInitializationHelpers._init_hypercorn_server(
|
||
app=app,
|
||
host=host,
|
||
port=port,
|
||
ssl_certfile_path=ssl_certfile_path,
|
||
ssl_keyfile_path=ssl_keyfile_path,
|
||
ciphers=ciphers,
|
||
)
|
||
|
||
|
||
if __name__ == "__main__":
|
||
run_server()
|