fix: Include extra field for context log (#1535)

This commit is contained in:
V 2025-12-19 09:54:03 -08:00 • committed by GitHub
commit 06748eb4c4
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 61 additions and 12 deletions

View file

@ -1260,6 +1260,7 @@ class Context(BaseModel, Generic[ServerSessionT, LifespanContextT, RequestT]):
message: str,
*,
logger_name: str | None = None,
extra: dict[str, Any] | None = None,
) -> None:
"""Send a log message to the client.
@ -1267,11 +1268,20 @@ class Context(BaseModel, Generic[ServerSessionT, LifespanContextT, RequestT]):
level: Log level (debug, info, warning, error)
message: Log message
logger_name: Optional logger name
**extra: Additional structured data to include
extra: Optional dictionary with additional structured data to include
"""
if extra:
log_data = {
"message": message,
**extra,
}
else:
log_data = message
await self.request_context.session.send_log_message(
level=level,
data=message,
data=log_data,
logger=logger_name,
related_request_id=self.request_id,
)
@ -1326,18 +1336,20 @@ class Context(BaseModel, Generic[ServerSessionT, LifespanContextT, RequestT]):
await self._request_context.close_standalone_sse_stream()
# Convenience methods for common log levels
async def debug(self, message: str, **extra: Any) -> None:
async def debug(self, message: str, *, logger_name: str | None = None, extra: dict[str, Any] | None = None) -> None:
"""Send a debug log message."""
await self.log("debug", message, **extra)
await self.log("debug", message, logger_name=logger_name, extra=extra)
async def info(self, message: str, **extra: Any) -> None:
async def info(self, message: str, *, logger_name: str | None = None, extra: dict[str, Any] | None = None) -> None:
"""Send an info log message."""
await self.log("info", message, **extra)
await self.log("info", message, logger_name=logger_name, extra=extra)
async def warning(self, message: str, **extra: Any) -> None:
async def warning(
self, message: str, *, logger_name: str | None = None, extra: dict[str, Any] | None = None
) -> None:
"""Send a warning log message."""
await self.log("warning", message, **extra)
await self.log("warning", message, logger_name=logger_name, extra=extra)
async def error(self, message: str, **extra: Any) -> None:
async def error(self, message: str, *, logger_name: str | None = None, extra: dict[str, Any] | None = None) -> None:
"""Send an error log message."""
await self.log("error", message, **extra)
await self.log("error", message, logger_name=logger_name, extra=extra)

View file

@ -1,4 +1,4 @@
from typing import Literal
from typing import Any, Literal
import pytest
@ -47,6 +47,23 @@ async def test_logging_callback():
)
return True
@server.tool("test_tool_with_log_extra")
async def test_tool_with_log_extra(
message: str,
level: Literal["debug", "info", "warning", "error"],
logger: str,
extra_string: str,
extra_dict: dict[str, Any],
) -> bool:
"""Send a log notification to the client with extra fields."""
await server.get_context().log(
level=level,
message=message,
logger_name=logger,
extra={"extra_string": extra_string, "extra_dict": extra_dict},
)
return True
# Create a message handler to catch exceptions
async def message_handler(
message: RequestResponder[types.ServerRequest, types.ClientResult] | types.ServerNotification | Exception,
@ -74,10 +91,30 @@ async def test_logging_callback():
"logger": "test_logger",
},
)
log_result_with_extra = await client_session.call_tool(
"test_tool_with_log_extra",
{
"message": "Test log message",
"level": "info",
"logger": "test_logger",
"extra_string": "example",
"extra_dict": {"a": 1, "b": 2, "c": 3},
},
)
assert log_result.isError is False
assert len(logging_collector.log_messages) == 1
assert log_result_with_extra.isError is False
assert len(logging_collector.log_messages) == 2
# Create meta object with related_request_id added dynamically
log = logging_collector.log_messages[0]
assert log.level == "info"
assert log.logger == "test_logger"
assert log.data == "Test log message"
log_with_extra = logging_collector.log_messages[1]
assert log_with_extra.level == "info"
assert log_with_extra.logger == "test_logger"
assert log_with_extra.data == {
"message": "Test log message",
"extra_string": "example",
"extra_dict": {"a": 1, "b": 2, "c": 3},
}