mirror of
https://github.com/BerriAI/litellm.git
synced 2026-11-16 09:22:22 +00:00
Merge 3b69236b27 into 6c4bad4604
This commit is contained in:
commit
48fe5897d1
8 changed files with 186 additions and 9 deletions
|
|
@ -39,6 +39,9 @@ LANGFUSE_TRACE_NAME: Final = "langfuse.trace.name"
|
|||
LANGFUSE_TRACE_USER_ID: Final = "user.id"
|
||||
LANGFUSE_TRACE_SESSION_ID: Final = "session.id"
|
||||
LANGFUSE_TRACE_TAGS: Final = "langfuse.trace.tags"
|
||||
LANGFUSE_ENVIRONMENT: Final = "langfuse.environment"
|
||||
LANGFUSE_RELEASE: Final = "langfuse.release"
|
||||
LANGFUSE_VERSION: Final = "langfuse.version"
|
||||
LANGFUSE_OBSERVATION_METADATA: Final = "langfuse.observation.metadata"
|
||||
LANGFUSE_TRACE_METADATA_PREFIX: Final = "langfuse.trace.metadata."
|
||||
LANGFUSE_REQUEST_METADATA_ATTRIBUTES: Final[frozenset[str]] = frozenset(
|
||||
|
|
@ -112,6 +115,9 @@ class LangfuseMapper:
|
|||
LANGFUSE_TRACE_USER_ID,
|
||||
LANGFUSE_TRACE_SESSION_ID,
|
||||
LANGFUSE_TRACE_TAGS,
|
||||
LANGFUSE_ENVIRONMENT,
|
||||
LANGFUSE_RELEASE,
|
||||
LANGFUSE_VERSION,
|
||||
}
|
||||
)
|
||||
|
||||
|
|
@ -130,6 +136,9 @@ class LangfuseMapper:
|
|||
(LANGFUSE_TRACE_USER_ID, trace.user_id or None),
|
||||
(LANGFUSE_TRACE_SESSION_ID, trace.session_id or None),
|
||||
(LANGFUSE_TRACE_TAGS, trace.tags or None),
|
||||
(LANGFUSE_ENVIRONMENT, trace.environment or None),
|
||||
(LANGFUSE_RELEASE, trace.release or None),
|
||||
(LANGFUSE_VERSION, trace.version or None),
|
||||
)
|
||||
)
|
||||
|
||||
|
|
|
|||
|
|
@ -2,6 +2,7 @@
|
|||
|
||||
from __future__ import annotations
|
||||
|
||||
import os
|
||||
from collections.abc import Mapping
|
||||
from dataclasses import dataclass
|
||||
from typing import Final
|
||||
|
|
@ -25,12 +26,15 @@ class TraceControls:
|
|||
user_id: str | None = None
|
||||
session_id: str | None = None
|
||||
tags: tuple[str, ...] = ()
|
||||
environment: str | None = None
|
||||
release: str | None = None
|
||||
version: str | None = None
|
||||
|
||||
|
||||
def caller_trace_controls(kwargs: Mapping[str, object]) -> TraceControls:
|
||||
request: Final = as_str_mapping(kwargs.get("litellm_params"))
|
||||
if request is None:
|
||||
return TraceControls()
|
||||
return TraceControls(environment=os.environ.get("LANGFUSE_TRACING_ENVIRONMENT") or None)
|
||||
proxy_request: Final = as_str_mapping(request.get("proxy_server_request"))
|
||||
headers: Final = as_str_mapping(proxy_request.get("headers")) if proxy_request is not None else None
|
||||
bodies: Final = tuple(
|
||||
|
|
@ -39,17 +43,22 @@ def caller_trace_controls(kwargs: Mapping[str, object]) -> TraceControls:
|
|||
if (metadata := as_str_mapping(request.get(key))) is not None
|
||||
)
|
||||
|
||||
def scalar(control: str) -> str | None:
|
||||
def scalar(control: str, *, body_control: str | None = None) -> str | None:
|
||||
from_header: Final = as_str(headers.get(f"{LANGFUSE_HEADER_PREFIX}{control}")) if headers is not None else None
|
||||
if from_header:
|
||||
return from_header
|
||||
return next((value for body in bodies if (value := as_str(body.get(control)))), None)
|
||||
return next((value for body in bodies if (value := as_str(body.get(body_control or control)))), None)
|
||||
|
||||
return TraceControls(
|
||||
name=scalar("trace_name"),
|
||||
user_id=scalar("trace_user_id"),
|
||||
session_id=scalar("session_id"),
|
||||
tags=next((tags for body in bodies if (tags := _str_items(body.get("tags")))), ()),
|
||||
environment=scalar("environment", body_control="langfuse_environment")
|
||||
or os.environ.get("LANGFUSE_TRACING_ENVIRONMENT")
|
||||
or None,
|
||||
release=scalar("release", body_control="trace_release"),
|
||||
version=scalar("version", body_control="trace_version"),
|
||||
)
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -90,7 +90,12 @@ from litellm.types.proxy.control_plane_endpoints import WorkerRegistryEntry
|
|||
from litellm.types.proxy.request_tag_mappings import RequestTagMapping
|
||||
from litellm.types.proxy.skill_scanning import SkillScannerConfig
|
||||
from litellm.types.proxy.spend_capture_rate import SpendCaptureRateCheckSettings
|
||||
from litellm.types.router import AllowedModelRegion, RouterErrors, UpdateRouterConfig
|
||||
from litellm.types.router import (
|
||||
AllowedModelRegion,
|
||||
ConfigurableClientsideParamsCustomAuth,
|
||||
RouterErrors,
|
||||
UpdateRouterConfig,
|
||||
)
|
||||
from litellm.types.router_weights import validate_router_settings_dict
|
||||
from litellm.types.secret_managers.main import KeyManagementSystem
|
||||
from litellm.types.utils import (
|
||||
|
|
@ -2544,6 +2549,10 @@ class ConfigGeneralSettings(LiteLLMPydanticObjectBase):
|
|||
use_google_kms: bool | None = Field(None, description="decrypt keys with google kms")
|
||||
use_azure_key_vault: bool | None = Field(None, description="load keys from azure key vault")
|
||||
master_key: str | None = Field(None, description="require a key for all calls to proxy")
|
||||
configurable_clientside_auth_params: Sequence[str | ConfigurableClientsideParamsCustomAuth] | None = Field(
|
||||
None,
|
||||
description="Allow only these client-supplied credential or callback parameters for every model. Names allow any value. api_base mappings restrict values using the same matching rules as per-deployment configuration.",
|
||||
)
|
||||
dangerously_permit_weak_or_unset_master_key: bool | None = Field(
|
||||
None,
|
||||
description="local development only: start even when master_key is unset, empty, or a publicly known default",
|
||||
|
|
|
|||
|
|
@ -256,6 +256,9 @@ def _allow_model_level_clientside_configurable_parameters(
|
|||
reject_server_owned_wif_params = _reject_server_owned_wif_params
|
||||
|
||||
_CREDENTIAL_VALUES: Final = TypeAdapter(dict[str, object])
|
||||
_CLIENTSIDE_AUTH_PARAMS: Final[TypeAdapter[CONFIGURABLE_CLIENTSIDE_AUTH_PARAMS]] = TypeAdapter(
|
||||
CONFIGURABLE_CLIENTSIDE_AUTH_PARAMS
|
||||
)
|
||||
_DECODED_JSON: Final = TypeAdapter(object)
|
||||
_LIST_ENTRIES: Final = TypeAdapter(tuple[object, ...])
|
||||
|
||||
|
|
@ -508,6 +511,14 @@ def _check_banned_params(
|
|||
# Proxy-wide opt-in: every banned param is permitted, exit
|
||||
# entirely so the rest of the loop doesn't waste work.
|
||||
return
|
||||
if _is_param_allowed(
|
||||
param=param,
|
||||
request_body_value=body[param],
|
||||
configurable_clientside_auth_params=_CLIENTSIDE_AUTH_PARAMS.validate_python(
|
||||
_CREDENTIAL_VALUES.validate_python(general_settings).get("configurable_clientside_auth_params")
|
||||
),
|
||||
):
|
||||
continue
|
||||
if (
|
||||
_allow_model_level_clientside_configurable_parameters(
|
||||
model=model,
|
||||
|
|
|
|||
|
|
@ -1305,6 +1305,80 @@ def test_caller_trace_name_prefers_the_langfuse_header_over_body_metadata(reques
|
|||
assert LLMCallEvent.from_dict({"litellm_params": request_data}).trace.name == expected
|
||||
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
"request_data,environment,release,version",
|
||||
[
|
||||
(
|
||||
{"metadata": {"langfuse_environment": "body", "trace_release": "r1", "trace_version": "v1"}},
|
||||
"body",
|
||||
"r1",
|
||||
"v1",
|
||||
),
|
||||
(
|
||||
{"litellm_metadata": {"langfuse_environment": "messages", "trace_release": "r2", "trace_version": "v2"}},
|
||||
"messages",
|
||||
"r2",
|
||||
"v2",
|
||||
),
|
||||
(
|
||||
{
|
||||
"proxy_server_request": {
|
||||
"headers": {
|
||||
"langfuse_environment": "header",
|
||||
"langfuse_release": "r3",
|
||||
"langfuse_version": "v3",
|
||||
}
|
||||
},
|
||||
"metadata": {"langfuse_environment": "body", "trace_release": "ignored", "trace_version": "ignored"},
|
||||
},
|
||||
"header",
|
||||
"r3",
|
||||
"v3",
|
||||
),
|
||||
(
|
||||
{
|
||||
"proxy_server_request": {
|
||||
"headers": {
|
||||
"langfuse_environment": "",
|
||||
"langfuse_release": "",
|
||||
"langfuse_version": None,
|
||||
}
|
||||
},
|
||||
"metadata": {"langfuse_environment": "body", "trace_release": "r4", "trace_version": "v4"},
|
||||
},
|
||||
"body",
|
||||
"r4",
|
||||
"v4",
|
||||
),
|
||||
({"metadata": {"langfuse_environment": None, "trace_release": "", "trace_version": ""}}, "deployment", None, None),
|
||||
({}, "deployment", None, None),
|
||||
],
|
||||
)
|
||||
def test_langfuse_deployment_controls_preserve_header_body_and_environment_precedence(
|
||||
request_data: Mapping[str, object],
|
||||
environment: str,
|
||||
release: str | None,
|
||||
version: str | None,
|
||||
monkeypatch: pytest.MonkeyPatch,
|
||||
) -> None:
|
||||
monkeypatch.setenv("LANGFUSE_TRACING_ENVIRONMENT", "deployment")
|
||||
expected: Final = TraceControls(environment=environment, release=release, version=version)
|
||||
assert caller_trace_controls({"litellm_params": request_data}) == expected
|
||||
assert LLMCallEvent.from_dict({"litellm_params": request_data}).trace == expected
|
||||
|
||||
|
||||
@pytest.mark.parametrize("environment", [None, "", "deployment"])
|
||||
def test_langfuse_deployment_environment_applies_without_request_params(
|
||||
environment: str | None,
|
||||
monkeypatch: pytest.MonkeyPatch,
|
||||
) -> None:
|
||||
if environment is None:
|
||||
monkeypatch.delenv("LANGFUSE_TRACING_ENVIRONMENT", raising=False)
|
||||
else:
|
||||
monkeypatch.setenv("LANGFUSE_TRACING_ENVIRONMENT", environment)
|
||||
assert caller_trace_controls({}) == TraceControls(environment=environment or None)
|
||||
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
("request_data", "expected"),
|
||||
[
|
||||
|
|
|
|||
|
|
@ -632,11 +632,27 @@ def test_langfuse_mapper_omits_unset_trace_controls():
|
|||
|
||||
|
||||
def test_langfuse_trace_attributes_match_between_root_and_generation():
|
||||
controls = TraceControls(name="n", user_id="u", session_id="s", tags=("t",))
|
||||
controls: Final = TraceControls(
|
||||
name="n",
|
||||
user_id="u",
|
||||
session_id="s",
|
||||
tags=("t",),
|
||||
environment="test",
|
||||
release="r1",
|
||||
version="v1",
|
||||
)
|
||||
generation = LangfuseMapper().map(_llm_call(trace=controls))
|
||||
|
||||
root = LangfuseMapper.trace_attributes(controls)
|
||||
assert root == {"langfuse.trace.name": "n", "user.id": "u", "session.id": "s", "langfuse.trace.tags": ("t",)}
|
||||
assert root == {
|
||||
"langfuse.trace.name": "n",
|
||||
"user.id": "u",
|
||||
"session.id": "s",
|
||||
"langfuse.trace.tags": ("t",),
|
||||
"langfuse.environment": "test",
|
||||
"langfuse.release": "r1",
|
||||
"langfuse.version": "v1",
|
||||
}
|
||||
assert all(generation[key] == value for key, value in root.items())
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -368,7 +368,11 @@ _SERVICE_ACCOUNT_TOKEN_REFERENCE: Final = "oidc/file//var/run/secrets/kubernetes
|
|||
|
||||
|
||||
def _user_config_with(litellm_params: dict[str, str]) -> dict[str, object]:
|
||||
return {"model_list": [{"model_name": "devstral", "litellm_params": {"model": "mistral/devstral-latest", **litellm_params}}]}
|
||||
return {
|
||||
"model_list": [
|
||||
{"model_name": "devstral", "litellm_params": {"model": "mistral/devstral-latest", **litellm_params}}
|
||||
]
|
||||
}
|
||||
|
||||
|
||||
def _user_config_defaulting_to(litellm_params: dict[str, str]) -> dict[str, object]:
|
||||
|
|
@ -388,7 +392,11 @@ def _user_config_search_tool_with(litellm_params: dict[str, str]) -> dict[str, o
|
|||
"search_tools": [
|
||||
{
|
||||
"search_tool_name": "web",
|
||||
"litellm_params": {"search_provider": "tavily", "api_base": "https://attacker.example", **litellm_params},
|
||||
"litellm_params": {
|
||||
"search_provider": "tavily",
|
||||
"api_base": "https://attacker.example",
|
||||
**litellm_params,
|
||||
},
|
||||
}
|
||||
]
|
||||
}
|
||||
|
|
@ -509,7 +517,9 @@ def test_a_call_cannot_carry_an_oidc_api_key_in_litellm_params(route: str | None
|
|||
)
|
||||
|
||||
|
||||
@pytest.mark.parametrize("route", ["/model/new", "/model/update", "/model/deployment-1/update", "/health/test_connection"])
|
||||
@pytest.mark.parametrize(
|
||||
"route", ["/model/new", "/model/update", "/model/deployment-1/update", "/health/test_connection"]
|
||||
)
|
||||
def test_a_deployment_write_may_carry_an_oidc_api_key_in_litellm_params(route: str):
|
||||
"""A proxy admin configures an oidc/ api_key on a deployment through these routes, and the model management role
|
||||
gate refuses anyone else with a 403."""
|
||||
|
|
@ -4441,6 +4451,40 @@ class TestObservabilityCallbackBans:
|
|||
)
|
||||
|
||||
|
||||
@pytest.mark.parametrize("container", [None, "metadata", "litellm_metadata", "extra_body"])
|
||||
@pytest.mark.parametrize("model", ["group-a", "group-b"])
|
||||
def test_proxy_wide_allowlist_admits_only_the_named_observability_param(container: str | None, model: str) -> None:
|
||||
settings: Final = {"configurable_clientside_auth_params": ["langfuse_environment"]}
|
||||
controls: Final = {"langfuse_environment": "test"}
|
||||
request: Final = {"model": model, **({container: controls} if container else controls)}
|
||||
assert is_request_body_safe(request_body=request, general_settings=settings, llm_router=None, model=model) is True
|
||||
for field in ("api_base", "langfuse_host", "aws_web_identity_token"):
|
||||
forbidden: Final = {**controls, field: "https://unlisted.example"}
|
||||
mixed: Final = {"model": model, **({container: forbidden} if container else forbidden)}
|
||||
with pytest.raises(ValueError, match=field):
|
||||
is_request_body_safe(request_body=mixed, general_settings=settings, llm_router=None, model=model)
|
||||
|
||||
|
||||
def test_proxy_wide_allowlist_keeps_api_base_value_restrictions() -> None:
|
||||
settings: Final = {"configurable_clientside_auth_params": [{"api_base": r"^https://allowed\.example/v1$"}]}
|
||||
assert (
|
||||
is_request_body_safe(
|
||||
request_body={"api_base": "https://allowed.example/v1"},
|
||||
general_settings=settings,
|
||||
llm_router=None,
|
||||
model="group",
|
||||
)
|
||||
is True
|
||||
)
|
||||
with pytest.raises(ValueError, match="api_base"):
|
||||
is_request_body_safe(
|
||||
request_body={"api_base": "https://unlisted.example/v1"},
|
||||
general_settings=settings,
|
||||
llm_router=None,
|
||||
model="group",
|
||||
)
|
||||
|
||||
|
||||
def test_model_level_allow_does_not_skip_subsequent_banned_params(monkeypatch):
|
||||
"""Greptile P1: ``_check_banned_params`` previously ``return``-ed when a
|
||||
deployment's ``configurable_clientside_auth_params`` permitted one
|
||||
|
|
|
|||
5
ui/litellm-dashboard/src/lib/http/schema.d.ts
generated
vendored
5
ui/litellm-dashboard/src/lib/http/schema.d.ts
generated
vendored
|
|
@ -30844,6 +30844,11 @@ export interface components {
|
|||
* @description proxy level default model for all chat completion calls
|
||||
*/
|
||||
completion_model?: string | null;
|
||||
/**
|
||||
* Configurable Clientside Auth Params
|
||||
* @description Allow only these client-supplied credential or callback parameters for every model. Names allow any value. api_base mappings restrict values using the same matching rules as per-deployment configuration.
|
||||
*/
|
||||
configurable_clientside_auth_params?: (string | components["schemas"]["ConfigurableClientsideParamsCustomAuth-Input"])[] | null;
|
||||
/**
|
||||
* Control Plane Url
|
||||
* @description Global Control Plane: URL of the control plane whose admin UI manages this instance. Enables /v3/login and /v3/login/exchange on this instance so that UI can authenticate against it cross-origin, and restricts the SSO return_to origin to that URL. No state is shared with the control plane
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue