* feat(xai): add grok-4.20 beta 2 models with pricing (#23900)
Add three grok-4.20 beta 2 model variants from xAI:
- grok-4.20-multi-agent-beta-0309 (reasoning + multi-agent)
- grok-4.20-beta-0309-reasoning (reasoning)
- grok-4.20-beta-0309-non-reasoning
Pricing (from https://docs.x.ai/docs/models):
- Input: $2.00/1M tokens ($0.20/1M cached)
- Output: $6.00/1M tokens
- Context: 2M tokens
All variants support vision, function calling, tool choice, and web search.
Closes LIT-2171
* docs: add Quick Install section for litellm --setup wizard (#23905)
* docs: add Quick Install section for litellm --setup wizard
* docs: clarify setup wizard is for local/beginner use
* feat(setup): interactive setup wizard + install.sh (#23644)
* feat(setup): add interactive setup wizard + install.sh
Adds `litellm --setup` — a Claude Code-style TUI onboarding wizard that
guides users through provider selection, API key entry, and proxy config
generation, then optionally starts the proxy immediately.
- litellm/setup_wizard.py: wizard with ASCII art, numbered provider menu
(OpenAI, Anthropic, Azure, Gemini, Bedrock, Ollama), API key prompts,
port/master-key config, and litellm_config.yaml generation
- litellm/proxy/proxy_cli.py: adds --setup flag that invokes the wizard
- scripts/install.sh: curl-installable script (detect OS/Python, pip
install litellm[proxy], launch wizard)
Usage:
curl -fsSL https://raw.githubusercontent.com/BerriAI/litellm/main/scripts/install.sh | sh
litellm --setup
* fix(install.sh): remove orange color, add LITELLM_BRANCH env var for branch installs
* fix(install.sh): install from git branch so --setup is available for QA
* fix(install.sh): remove stale LITELLM_BRANCH reference that caused unbound variable error
* fix(install.sh): force-reinstall from git to bypass cached PyPI version
* fix(install.sh): show pip progress bar during install
* fix(install.sh): always launch wizard via $PYTHON_BIN -m litellm, not PATH binary
* fix(install.sh): use litellm.proxy.proxy_cli module (no __main__.py exists)
* fix(install.sh): suppress RuntimeWarning from module invocation
* fix(install.sh): use Python bin-dir litellm binary to avoid CWD sys.path shadowing
* fix(install.sh): use sysconfig.get_path('scripts') to find pip-installed litellm binary
* fix(install.sh): redirect stdin from /dev/tty on exec so wizard gets terminal, not exhausted pipe
* fix(install.sh): warn about git clone duration, drop --no-cache-dir so re-runs are faster
* feat(setup_wizard): arrow-key selector, updated model names
* fix(setup_wizard): use sysconfig binary to start proxy, not python -m litellm
* feat(setup_wizard): credential validation after key entry + clear next-steps after proxy start
* style(install.sh): show git clone warning in blue
* refactor(setup_wizard): class with static methods, use check_valid_key from litellm.utils
* address greptile review: fix yaml escaping, port validation, display name collisions, tests
- setup_wizard.py: add _yaml_escape() for safe YAML embedding of API keys
- setup_wizard.py: add _styled_input() with readline ANSI ignore markers
- setup_wizard.py: change DIVIDER to _divider() fn to avoid import-time color capture
- setup_wizard.py: validate port range 1-65535, initialize before loop
- setup_wizard.py: qualify azure display names (azure-gpt-4o) to avoid collision with openai
- setup_wizard.py: work on env_copy in _build_config to avoid mutating caller's dict
- setup_wizard.py: skip model_list entries for providers with no credentials
- setup_wizard.py: prompt for azure deployment name
- setup_wizard.py: wrap os.execlp in try/except with friendly fallback
- setup_wizard.py: wrap config write in try/except OSError
- setup_wizard.py: fix _validate_and_report to use two print lines (no \r overwrite)
- setup_wizard.py: add .gitignore tip next to key storage notice
- setup_wizard.py: fix run_setup_wizard() return type annotation to None
- scripts/install.sh: drop pipefail (not supported by dash on Ubuntu when invoked as sh)
- scripts/install.sh: use litellm[proxy] from PyPI (not hardcoded dev branch)
- scripts/install.sh: guard /dev/tty read with -r check for Docker/CI compat
- scripts/install.sh: remove --force-reinstall to avoid downgrading dependencies
- tests/test_litellm/test_setup_wizard.py: 13 unit tests for _build_config and _yaml_escape
* style: black format setup_wizard.py
* fix: address remaining greptile issues - Windows compat, YAML quoting, credential flow
- guard termios/tty imports with try/except ImportError for Windows compat
- quote master_key as YAML double-quoted scalar (same as env vars)
- remove unused port param from _build_config signature
- _validate_and_report now returns the final key so re-entered creds are stored
- add test for master_key YAML quoting
* fix: add --port to suggested command, guard /dev/tty exec in install.sh
* fix: quote api_base in YAML, skip azure if no deployment, only redraw on state change
* fix: address greptile review comments
- _yaml_escape: add control character escaping (\n, \r, \t)
- test: fix tautological assertion in test_build_config_azure_no_deployment_skipped
- test: add tests for control character escaping in _yaml_escape
* feat(ui): remove Chat UI page link and banner from sidebar and playground (#23908)
* feat(guardrails): MCPJWTSigner - built-in guardrail for zero trust MCP auth (#23897)
* Allow pre_mcp_call guardrail hooks to mutate outbound MCP headers
* Enhance MCPServerManager to support hook-modified arguments and extra headers. Update tests to validate argument mutation and header injection behavior, including warnings for OpenAPI-backed servers when headers are present.
* Refactor MCPServerManager to raise HTTPException for extra headers in OpenAPI-backed servers. Update tests to reflect this change, ensuring proper exception handling instead of logging warnings.
* Allow pre_mcp_call guardrail hooks to mutate outbound MCP headers
* Enhance MCPServerManager to support hook-modified arguments and extra headers. Update tests to validate argument mutation and header injection behavior, including warnings for OpenAPI-backed servers when headers are present.
* Refactor MCPServerManager to raise HTTPException for extra headers in OpenAPI-backed servers. Update tests to reflect this change, ensuring proper exception handling instead of logging warnings.
* feat(guardrails): add MCPJWTSigner built-in guardrail for zero trust MCP auth
Signs outbound MCP tool calls with a LiteLLM-issued RS256 JWT so MCP servers
can trust a single signing authority instead of every upstream IdP.
Enable in config.yaml:
guardrails:
- guardrail_name: mcp-jwt-signer
litellm_params:
guardrail: mcp_jwt_signer
mode: pre_mcp_call
default_on: true
JWT carries sub (user_id), act.sub (team_id, RFC 8693), tool-level scope, iss,
aud, iat/exp/nbf. RSA-2048 keypair auto-generated at startup unless
MCP_JWT_SIGNING_KEY env var is set.
Adds /.well-known/jwks.json endpoint and jwks_uri to /.well-known/openid-configuration
so MCP servers can verify LiteLLM-issued tokens via OIDC discovery.
* Update MCPServerManager to raise HTTPException with status code 400 for extra headers in OpenAPI-backed servers. Adjust tests to verify the correct status code and exception message.
* fix: address P1 issues in MCPJWTSigner
- OpenAPI servers: warn + skip header injection instead of 500
- JWKS Cache-Control: 5min for auto-generated keys, 1h for persistent
- sub claim: fallback to apikey:{token_hash} for anonymous callers
- ttl_seconds: validate > 0 at init time
* docs: add MCP zero trust auth guide with architecture diagram
* docs: add FastMCP JWT verification guide to zero trust doc
* fix: address remaining Greptile review issues (round 2)
- mcp_server_manager: warn when hook Authorization overwrites existing header
- __init__: remove _mcp_jwt_signer_instance from __all__ (private internal)
- discoverable_endpoints: copy dict instead of mutating in-place on OIDC augmentation
- test docstring: reflect warn-and-continue behavior for OpenAPI servers
- test: update scope assertions for least-privilege (no mcp:tools/list on tool-call JWTs)
* fix: address Greptile round 3 feedback
- initialize_guardrail: validate mode='pre_mcp_call' at init time — misconfigured
mode silently bypasses JWT injection, which is a zero-trust bypass
- _build_claims: remove duplicate inline 'import re' (module-level import already present)
- _types.py: add TODO comment explaining jwt_claims is forward-compat plumbing
for a follow-up PR that will forward upstream IdP claims into outbound MCP JWTs
* feat(mcp_jwt_signer): add verify+re-sign, claim ops, two-token model, configurable scopes
Addresses all missing pieces from the scoping doc review:
FR-5 (Verify + re-sign): MCPJWTSigner now accepts access_token_discovery_uri
and token_introspection_endpoint. When set, the incoming Bearer token is
extracted from raw_headers (threaded through pre_call_tool_check), verified
against the IdP's JWKS (JWT) or introspected (opaque), and only re-signed if
valid. Falls back to user_api_key_dict.jwt_claims for LiteLLM JWT-auth mode.
FR-12 (Configurable end-user identity mapping): end_user_claim_sources
ordered list drives sub resolution — sources: token:<claim>, litellm:user_id,
litellm:email, litellm:end_user_id, litellm:team_id.
FR-13 (Claim operations): add_claims (insert-if-absent), set_claims (always
override), remove_claims (delete) applied in that order.
FR-14 (Two-token model): channel_token_audience + channel_token_ttl issue a
second JWT injected as x-mcp-channel-token: Bearer <token>.
FR-15 (Incoming claim validation): required_claims raises HTTP 403 when any
listed claim is absent; optional_claims passes listed claims from verified
token into the outbound JWT.
FR-9 (Debug headers): debug_headers: true emits x-litellm-mcp-debug with kid,
sub, iss, exp, scope.
FR-10 (Configurable scopes): allowed_scopes replaces auto-generation. Also
fixed: tool-call JWTs no longer grant mcp:tools/list (overpermission).
P1 fixes:
- proxy/utils.py: _convert_mcp_hook_response_to_kwargs merges rather than
replaces extra_headers, preserving headers from prior guardrails.
- mcp_server_manager.py: warns when hook injects Authorization alongside a
server-configured authentication_token (previously silent).
- mcp_server_manager.py: pre_call_tool_check now accepts raw_headers and
extracts incoming_bearer_token so FR-5 verification has the raw token.
- proxy/utils.py: remove stray inline import inspect inside loop (pre-existing
lint error, now cleaned up).
Tests: 43 passing (28 new tests covering all FR flags + P1 fixes).
* feat(mcp_jwt_signer): add verify+re-sign, claim ops, two-token model, configurable scopes (core)
Remaining files from the FR implementation:
mcp_jwt_signer.py — full rewrite with all new params:
FR-5: access_token_discovery_uri, token_introspection_endpoint,
verify_issuer, verify_audience + _verify_incoming_jwt(),
_introspect_opaque_token()
FR-12: end_user_claim_sources ordered resolution chain
FR-13: add_claims, set_claims, remove_claims
FR-14: channel_token_audience, channel_token_ttl → x-mcp-channel-token
FR-15: required_claims (raises 403), optional_claims (passthrough)
FR-9: debug_headers → x-litellm-mcp-debug
FR-10: allowed_scopes; tool-call JWTs no longer over-grant tools/list
mcp_server_manager.py:
- pre_call_tool_check gains raw_headers param to extract incoming_bearer_token
- Silent Authorization override warning fixed: now fires when server has
authentication_token AND hook injects Authorization
tests/test_mcp_jwt_signer.py:
28 new tests covering all FR flags + P1 fixes (43 total, all passing)
* fix(mcp_jwt_signer): address pre-landing review issues
- Remove stale TODO comment on UserAPIKeyAuth.jwt_claims — the field is
already populated and consumed by MCPJWTSigner in the same PR
- Fix _get_oidc_discovery to only cache the OIDC discovery doc when
jwks_uri is present; a malformed/empty doc now retries on the next
request instead of being permanently cached until proxy restart
- Add FR-5 test coverage for _fetch_jwks (cache hit/miss),
_get_oidc_discovery (cache/no-cache on bad doc), _verify_incoming_jwt
(valid token, expired token), _introspect_opaque_token (active,
inactive, no endpoint), and the end-to-end 401 hook path — 53 tests
total, all passing
* docs(mcp_zero_trust): rewrite as use-case guide covering all new JWT signer features
Add scenario-driven sections for each new config area:
- Verify+re-sign with Okta/Azure AD (access_token_discovery_uri,
end_user_claim_sources, token_introspection_endpoint)
- Enforcing caller attributes with required_claims / optional_claims
- Adding metadata via add_claims / set_claims / remove_claims
- Two-token model for AWS Bedrock AgentCore Gateway
(channel_token_audience / channel_token_ttl)
- Controlling scopes with allowed_scopes
- Debugging JWT rejections with debug_headers
Update JWT claims table to reflect configurable sub (end_user_claim_sources)
* fix(mcp_jwt_signer): wire all config.yaml params through initialize_guardrail
The factory was only passing issuer/audience/ttl_seconds to MCPJWTSigner.
All FR-5/9/10/12/13/14/15 params (access_token_discovery_uri,
end_user_claim_sources, add/set/remove_claims, channel_token_audience,
required/optional_claims, debug_headers, allowed_scopes, etc.) were
silently dropped, making every advertised advanced feature non-functional
when loaded from config.yaml.
Add regression test that asserts every param is wired through correctly.
* docs(mcp_zero_trust): add hero image
* docs(mcp_zero_trust): apply Linear-style edits
- Lead with the problem (unsigned direct calls bypass access controls)
- Shorter statement section headers instead of question-form headers
- Move diagram/OIDC discovery block after the reader is bought in
- Add 'read further only if you need to' callout after basic setup
- Two-token section now opens from the user problem not product jargon
- Add concrete 403 error response example in required_claims section
- Debug section opens from the symptom (MCP server returning 401)
- Lowercase claims reference header for consistency
* fix(mcp_jwt_signer): fix algorithm confusion attack + add OIDC discovery 24h TTL
- Remove alg from unverified JWT header; use signing_jwk.algorithm_name from JWKS key instead.
Reading alg from attacker-controlled headers enables alg:none / HS256 confusion attacks.
- Add _oidc_discovery_fetched_at timestamp and _OIDC_DISCOVERY_TTL = 86400 (24h).
Without a TTL the cached discovery doc never refreshes, so IdP key rotation is invisible.
---------
Co-authored-by: Noah Nistler <60981020+noahnistler@users.noreply.github.com>
* fix(ci): stabilize CI - formatting, type errors, test polling, security CVEs, router bug, batch resolution
Fix 1: Run Black formatter on 35 files
Fix 2: Fix MyPy type errors:
- setup_wizard.py: add type annotation for 'selected' set variable
- user_api_key_auth.py: remove redundant type annotation on jwt_claims reassignment
Fix 3: Fix spend accuracy test burst 2 polling to wait for expected total
spend instead of just 'any increase' from burst 2
Fix 4: Bump Next.js 16.1.6 -> 16.1.7 to fix CVE-2026-27978, CVE-2026-27979,
CVE-2026-27980, CVE-2026-29057
Fix 5: Fix router _pre_call_checks model variable being overwritten inside
loop, causing wrong model lookups on subsequent deployments. Use local
_deployment_model variable instead.
Fix 6: Add missing resolve_output_file_ids_to_unified call in batch retrieve
non-terminal-to-terminal path (matching the terminal path behavior)
Co-authored-by: Ishaan Jaff <ishaan-jaff@users.noreply.github.com>
* chore: regenerate poetry.lock to sync with pyproject.toml
Co-authored-by: Ishaan Jaff <ishaan-jaff@users.noreply.github.com>
* fix: format merged files from main and regenerate poetry.lock
Co-authored-by: Ishaan Jaff <ishaan-jaff@users.noreply.github.com>
* fix(mypy): annotate jwt_claims as Optional[dict] to fix type incompatibility
Co-authored-by: Ishaan Jaff <ishaan-jaff@users.noreply.github.com>
* fix(ci): update router region test to use gpt-4.1-mini (fix flaky model lookup)
Replace deprecated gpt-3.5-turbo-1106 with gpt-4.1-mini + mock_response in
test_router_region_pre_call_check, following the same pattern used in commit
717d37cc5b for test_router_context_window_check_pre_call_check_out_group.
Co-authored-by: Ishaan Jaff <ishaan-jaff@users.noreply.github.com>
* ci: retry flaky logging_testing (async event loop race condition)
Co-authored-by: Ishaan Jaff <ishaan-jaff@users.noreply.github.com>
* fix(ci): aggregate all mock calls in langfuse e2e test to fix race condition
The _verify_langfuse_call helper only inspected the last mock call
(mock_post.call_args), but the Langfuse SDK may split trace-create and
generation-create events across separate HTTP flush cycles. This caused
an IndexError when the last call's batch contained only one event type.
Fix: iterate over mock_post.call_args_list to collect batch items from
ALL calls. Also add a safety assertion after filtering by trace_id and
mark all langfuse e2e tests with @pytest.mark.flaky(retries=3) as an
extra safety net for any residual timing issues.
Co-authored-by: Ishaan Jaff <ishaan-jaff@users.noreply.github.com>
* fix(ci): black formatting + update OpenAPI compliance tests for spec changes
- Apply Black 26.x formatting to litellm_logging.py (parenthesized style)
- Update test_input_types_match_spec to follow $ref to InteractionsInput schema
(Google updated their OpenAPI spec to use $ref instead of inline oneOf)
- Update test_content_schema_uses_discriminator to handle discriminator without
explicit mapping (Google removed the mapping key from Content discriminator)
Co-authored-by: Ishaan Jaff <ishaan-jaff@users.noreply.github.com>
* revert: undo incorrect Black 26.x formatting on litellm_logging.py
The file was correctly formatted for Black 23.12.1 (the version pinned
in pyproject.toml). The previous commit applied Black 26.x formatting
which was incompatible with the CI's Black version.
Co-authored-by: Ishaan Jaff <ishaan-jaff@users.noreply.github.com>
* fix(ci): deduplicate and sort langfuse batch events after aggregation
The Langfuse SDK may send the same event (e.g., trace-create) in
multiple flush cycles, causing duplicates when we aggregate from all
mock calls. After filtering by trace_id, deduplicate by keeping only
the first event of each type, then sort to ensure trace-create is at
index 0 and generation-create at index 1.
Co-authored-by: Ishaan Jaff <ishaan-jaff@users.noreply.github.com>
---------
Co-authored-by: Noah Nistler <60981020+noahnistler@users.noreply.github.com>
Co-authored-by: Cursor Agent <cursoragent@cursor.com>
Co-authored-by: Ishaan Jaff <ishaan-jaff@users.noreply.github.com>
983 lines
34 KiB
Python
983 lines
34 KiB
Python
# ruff: noqa: T201
|
|
import importlib
|
|
import json
|
|
import os
|
|
import random
|
|
import subprocess
|
|
import sys
|
|
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: Optional[str], params: dict) -> str:
|
|
from litellm._logging import verbose_proxy_logger
|
|
|
|
verbose_proxy_logger.debug(f"url: {url}")
|
|
verbose_proxy_logger.debug(f"params: {params}")
|
|
if not isinstance(url, str) or url == "":
|
|
# Preserve previous startup behavior when DATABASE_URL is absent.
|
|
# Returning an empty string avoids urlparse type errors in test/dev flows.
|
|
verbose_proxy_logger.warning(
|
|
"append_query_params received empty or non-string URL, returning empty string"
|
|
)
|
|
return ""
|
|
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_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
|
|
|
|
# Clean up prometheus .db files when a worker exits (prevents ghost gauge values)
|
|
if os.environ.get("PROMETHEUS_MULTIPROC_DIR"):
|
|
from litellm.proxy.prometheus_cleanup import mark_worker_exit
|
|
|
|
def child_exit(server, worker):
|
|
mark_worker_exit(worker.pid)
|
|
|
|
gunicorn_options["child_exit"] = child_exit
|
|
|
|
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"
|
|
|
|
@staticmethod
|
|
def _maybe_setup_prometheus_multiproc_dir(
|
|
num_workers: int,
|
|
litellm_settings: Optional[dict],
|
|
) -> None:
|
|
"""
|
|
Auto-create PROMETHEUS_MULTIPROC_DIR when running with multiple workers
|
|
and prometheus is configured as a callback.
|
|
"""
|
|
import tempfile
|
|
|
|
if num_workers <= 1 or litellm_settings is None:
|
|
return
|
|
|
|
# Check if prometheus is in any callback list
|
|
# Each setting can be a list or a single string; normalize to list
|
|
callbacks = litellm_settings.get("callbacks") or []
|
|
success_callbacks = litellm_settings.get("success_callback") or []
|
|
failure_callbacks = litellm_settings.get("failure_callback") or []
|
|
if isinstance(callbacks, str):
|
|
callbacks = [callbacks]
|
|
if isinstance(success_callbacks, str):
|
|
success_callbacks = [success_callbacks]
|
|
if isinstance(failure_callbacks, str):
|
|
failure_callbacks = [failure_callbacks]
|
|
all_callbacks = callbacks + success_callbacks + failure_callbacks
|
|
if "prometheus" not in all_callbacks:
|
|
return
|
|
|
|
from litellm.proxy.prometheus_cleanup import wipe_directory
|
|
|
|
multiproc_dir = os.environ.get("PROMETHEUS_MULTIPROC_DIR") or os.environ.get(
|
|
"prometheus_multiproc_dir"
|
|
)
|
|
|
|
auto_created = not multiproc_dir
|
|
if not multiproc_dir:
|
|
multiproc_dir = os.path.join(
|
|
tempfile.gettempdir(), "litellm_prometheus_multiproc"
|
|
)
|
|
os.environ["PROMETHEUS_MULTIPROC_DIR"] = multiproc_dir
|
|
|
|
os.makedirs(multiproc_dir, exist_ok=True)
|
|
wipe_directory(multiproc_dir)
|
|
action = "Auto-created" if auto_created else "Using existing"
|
|
print(f"LiteLLM: {action} PROMETHEUS_MULTIPROC_DIR={multiproc_dir}") # noqa
|
|
|
|
|
|
@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. Default is 1 (from DEFAULT_NUM_WORKERS_LITELLM_PROXY)",
|
|
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(
|
|
"--setup",
|
|
is_flag=True,
|
|
default=False,
|
|
help="Run the interactive setup wizard to configure providers and generate a config 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",
|
|
)
|
|
@click.option(
|
|
"--enforce_prisma_migration_check",
|
|
is_flag=True,
|
|
default=False,
|
|
help="Exit with error if database migration fails on startup.",
|
|
envvar="ENFORCE_PRISMA_MIGRATION_CHECK",
|
|
)
|
|
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,
|
|
setup,
|
|
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,
|
|
enforce_prisma_migration_check: bool,
|
|
):
|
|
if setup:
|
|
from litellm.setup_wizard import run_setup_wizard
|
|
|
|
run_setup_wizard()
|
|
return
|
|
|
|
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
|
|
|
|
litellm_settings = None
|
|
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(
|
|
str(database_url) if database_url else None, 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:
|
|
if not PrismaManager.setup_database(
|
|
use_migrate=not use_prisma_db_push
|
|
):
|
|
if enforce_prisma_migration_check:
|
|
print( # noqa
|
|
"\033[1;31mLiteLLM Proxy: Database setup failed after multiple retries. "
|
|
"The proxy cannot start safely. Please check your database connection and migration status.\033[0m"
|
|
)
|
|
sys.exit(1)
|
|
else:
|
|
print( # noqa
|
|
"\033[1;33mLiteLLM Proxy: Database migration failed but continuing startup. "
|
|
"Set --enforce_prisma_migration_check or ENFORCE_PRISMA_MIGRATION_CHECK=true to exit on failure.\033[0m"
|
|
)
|
|
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
|
|
|
|
# Auto-create PROMETHEUS_MULTIPROC_DIR for multi-worker setups
|
|
ProxyInitializationHelpers._maybe_setup_prometheus_multiproc_dir(
|
|
num_workers=num_workers,
|
|
litellm_settings=litellm_settings if config else None, # type: ignore[possibly-unbound]
|
|
)
|
|
|
|
# --- 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
|
|
|
|
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()
|