Skip to content

Commit e0e1557

Browse files
authored
feat(core): Allow model name and provider tracing metadata override based on gateway response (#40406)
With custom configs, the actual model name and provider the gateway actually runs are different from what are requested. This reconciles clientside tracing.
1 parent 67ee6cb commit e0e1557

2 files changed

Lines changed: 96 additions & 1 deletion

File tree

‎libs/core/langchain_core/tracers/core.py‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -356,6 +356,11 @@ def _attach_gateway_metadata(self, run: Run, response: LLMResult) -> None:
356356
return
357357
metadata = run.extra.setdefault("metadata", {})
358358
metadata[_GATEWAY_RUN_METADATA_KEY] = gateway_metadata
359+
# The resolved gateway identity takes precedence over request-time metadata.
360+
for source, target in (("model", "ls_model_name"), ("provider", "ls_provider")):
361+
value = gateway_metadata.get(source)
362+
if isinstance(value, str) and (value := value.strip()):
363+
metadata[target] = value
359364

360365
def _errored_llm_run(
361366
self, error: BaseException, run_id: UUID, response: LLMResult | None = None

‎libs/core/tests/unit_tests/tracers/test_automatic_metadata.py‎

Lines changed: 91 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44

55
from unittest.mock import MagicMock
66

7+
import pytest
8+
79
from langchain_core.messages import AIMessage
810
from langchain_core.messages.tool import ToolCall
911
from langchain_core.outputs import ChatGeneration, LLMResult
@@ -189,7 +191,11 @@ def test_complete_llm_run_attaches_gateway_metadata() -> None:
189191

190192
completed_run = tracer._complete_llm_run(response=response, run_id=run.id)
191193

192-
assert completed_run.extra["metadata"]["ls_gateway_info"] == gateway_info
194+
assert completed_run.extra["metadata"] == {
195+
"ls_gateway_info": gateway_info,
196+
"ls_model_name": gateway_info["model"],
197+
"ls_provider": gateway_info["provider"],
198+
}
193199

194200

195201
def test_complete_llm_run_no_gateway_metadata() -> None:
@@ -230,3 +236,87 @@ def test_errored_llm_run_attaches_gateway_metadata() -> None:
230236
)
231237

232238
assert errored_run.extra["metadata"]["ls_gateway_info"] == gateway_info
239+
240+
241+
@pytest.mark.parametrize("errored", [False, True])
242+
@pytest.mark.parametrize(
243+
("gateway_info", "expected_identity"),
244+
[
245+
pytest.param(
246+
{"model": "resolved-model", "provider": "amazon_bedrock"},
247+
{"ls_model_name": "resolved-model", "ls_provider": "amazon_bedrock"},
248+
id="resolved-identity",
249+
),
250+
pytest.param(
251+
{"model": "resolved-model", "selected_model": "configured-model"},
252+
{"ls_model_name": "resolved-model"},
253+
id="model-only",
254+
),
255+
pytest.param(
256+
{"provider": "amazon_bedrock"},
257+
{"ls_provider": "amazon_bedrock"},
258+
id="provider-only",
259+
),
260+
pytest.param({}, {}, id="empty"),
261+
pytest.param({"error": "rate_limit_exceeded"}, {}, id="error-only"),
262+
pytest.param({"selected_model": "configured-model"}, {}, id="selected-only"),
263+
pytest.param({"model": None, "provider": None}, {}, id="null"),
264+
pytest.param({"model": "", "provider": ""}, {}, id="empty-strings"),
265+
pytest.param({"model": " \t\n", "provider": "\n "}, {}, id="whitespace-only"),
266+
pytest.param(
267+
{"model": " resolved-model\n", "provider": "\tamazon_bedrock "},
268+
{"ls_model_name": "resolved-model", "ls_provider": "amazon_bedrock"},
269+
id="surrounding-whitespace",
270+
),
271+
pytest.param({"model": 42, "provider": ["openai"]}, {}, id="invalid-types"),
272+
pytest.param(
273+
{"model": False, "provider": "amazon_bedrock"},
274+
{"ls_provider": "amazon_bedrock"},
275+
id="invalid-model-valid-provider",
276+
),
277+
pytest.param(
278+
{"model": "resolved-model", "provider": {}},
279+
{"ls_model_name": "resolved-model"},
280+
id="valid-model-invalid-provider",
281+
),
282+
],
283+
)
284+
def test_gateway_metadata_overrides_request_identity(
285+
gateway_info: dict[str, object],
286+
expected_identity: dict[str, str],
287+
*,
288+
errored: bool,
289+
) -> None:
290+
"""Only valid returned identity fields override request-time tracing metadata."""
291+
tracer = MockTracerCore()
292+
run = _make_run("test-gateway-identity-run-id")
293+
original_metadata = {
294+
"ls_model_name": "requested-model",
295+
"ls_provider": "openai",
296+
"custom": "preserved",
297+
}
298+
run.extra = {"metadata": original_metadata.copy()}
299+
tracer.run_map[str(run.id)] = run
300+
response = LLMResult(
301+
generations=[
302+
[
303+
ChatGeneration(
304+
message=AIMessage(content="Test"),
305+
generation_info={GATEWAY_METADATA_RESPONSE_KEY: gateway_info},
306+
)
307+
]
308+
]
309+
)
310+
311+
if errored:
312+
completed_run = tracer._errored_llm_run(
313+
error=ValueError("boom"), run_id=run.id, response=response
314+
)
315+
else:
316+
completed_run = tracer._complete_llm_run(response=response, run_id=run.id)
317+
318+
assert completed_run.extra["metadata"] == {
319+
**original_metadata,
320+
**expected_identity,
321+
"ls_gateway_info": gateway_info,
322+
}

0 commit comments

Comments
 (0)