Skip to content

🙌 OpenHands: AI-Driven Development

fix(app-server): preserve observability context metadata (#15215)

苏紫辰ef1a3c71a005
diff --git a/openhands/app_server/app_conversation/live_status_app_conversation_service.py b/openhands/app_server/app_conversation/live_status_app_conversation_service.py
index 6d04114ad4..747ccce183 100644
--- a/openhands/app_server/app_conversation/live_status_app_conversation_service.py
+++ b/openhands/app_server/app_conversation/live_status_app_conversation_service.py
@@ -1379,6 +1379,26 @@ class LiveStatusAppConversationService(AppConversationServiceBase):
return metadata, tags
+ @staticmethod
+ def _extend_observability_metadata(
+ target: dict[str, Any], metadata: Mapping[str, Any]
+ ) -> None:
+ for key, value in metadata.items():
+ if value is None:
+ continue
+ if isinstance(value, str) and value == '':
+ continue
+ if key in target:
+ if target[key] != value:
+ _logger.warning(
+ 'Conflicting observability metadata for %s (existing=%r, incoming=%r); keeping existing value',
+ key,
+ target[key],
+ value,
+ )
+ continue
+ target[key] = value
+
@staticmethod
def _apply_server_agent_overrides(
agent: Agent,
@@ -1887,13 +1907,16 @@ class LiveStatusAppConversationService(AppConversationServiceBase):
# injects it directly into the JSON body as a forward-compatible
# fallback.
laminar_user_id = await self.user_context.get_user_email() or user.id
- observability_metadata = await self._build_observability_metadata(
+ resolved_observability_metadata = await self._build_observability_metadata(
remote_workspace,
project_dir,
selected_repository,
selected_branch,
git_provider,
)
+ self._extend_observability_metadata(
+ observability_metadata, resolved_observability_metadata
+ )
create_kwargs: dict[str, Any] = {'agent': agent, 'user_id': laminar_user_id}
if observability_metadata:
create_kwargs['observability_metadata'] = observability_metadata
@@ -2152,13 +2175,16 @@ class LiveStatusAppConversationService(AppConversationServiceBase):
# prefer email over the internal id so Laminar traces are immediately
# attributable, falling back to ``user.id`` when no email is available.
laminar_user_id = await self.user_context.get_user_email() or user.id
- observability_metadata = await self._build_observability_metadata(
+ resolved_observability_metadata = await self._build_observability_metadata(
remote_workspace,
project_dir,
selected_repository,
selected_branch,
git_provider,
)
+ self._extend_observability_metadata(
+ observability_metadata, resolved_observability_metadata
+ )
create_kwargs: dict[str, Any] = {
'agent': acp_agent,
'user_id': laminar_user_id,
diff --git a/tests/unit/app_server/test_live_status_app_conversation_service.py b/tests/unit/app_server/test_live_status_app_conversation_service.py
index e05bdfd3d0..f53a9ffe10 100644
--- a/tests/unit/app_server/test_live_status_app_conversation_service.py
+++ b/tests/unit/app_server/test_live_status_app_conversation_service.py
@@ -1235,6 +1235,11 @@ class TestLiveStatusAppConversationService:
)
assert result.observability_metadata == {
+ 'app': 'openhands',
+ 'conversation_id': str(result.conversation_id),
+ 'agent_kind': 'openhands',
+ 'repo_name': 'test/repo',
+ 'selected_branch': 'feature-x',
'repo': 'test/repo',
'branch': 'feature-x',
'git_provider': 'github',
@@ -1276,6 +1281,11 @@ class TestLiveStatusAppConversationService:
)
assert result.observability_metadata == {
+ 'app': 'openhands',
+ 'conversation_id': str(result.conversation_id),
+ 'agent_kind': 'openhands',
+ 'repo_name': 'test/repo',
+ 'selected_branch': 'feature-x',
'repo': 'test/repo',
'branch': 'feature-x',
'git_provider': 'github',
@@ -1315,17 +1325,23 @@ class TestLiveStatusAppConversationService:
selected_repository='test/repo',
)
- assert result.observability_metadata == {'repo': 'test/repo'}
+ assert result.observability_metadata == {
+ 'app': 'openhands',
+ 'conversation_id': str(result.conversation_id),
+ 'agent_kind': 'openhands',
+ 'repo_name': 'test/repo',
+ 'repo': 'test/repo',
+ }
@patch(
'openhands.app_server.app_conversation.live_status_app_conversation_service.get_default_tools',
return_value=[],
)
@pytest.mark.asyncio
- async def test_build_request_no_repo_omits_observability_metadata(
+ async def test_build_request_no_repo_keeps_context_observability_metadata(
self, _mock_tools
):
- """A repo-less conversation adds no repo metadata to the trace."""
+ """A repo-less conversation keeps non-repo trace context metadata."""
self.mock_user_context.get_user_info.return_value = self.mock_user
self.service._setup_secrets_for_git_providers = AsyncMock(return_value={})
self.service._configure_llm_and_mcp = AsyncMock(
@@ -1343,7 +1359,11 @@ class TestLiveStatusAppConversationService:
selected_repository=None,
)
- assert result.observability_metadata == {}
+ assert result.observability_metadata == {
+ 'app': 'openhands',
+ 'conversation_id': str(result.conversation_id),
+ 'agent_kind': 'openhands',
+ }
@pytest.mark.asyncio
async def test_build_request_routes_acp_user_to_observability_metadata(self):
@@ -1382,6 +1402,11 @@ class TestLiveStatusAppConversationService:
assert result.agent.agent_kind == 'acp'
assert result.observability_metadata == {
+ 'app': 'openhands',
+ 'conversation_id': str(result.conversation_id),
+ 'agent_kind': 'acp',
+ 'repo_name': 'test/repo',
+ 'selected_branch': 'feature-x',
'repo': 'test/repo',
'branch': 'feature-x',
'git_provider': 'github',
@@ -4257,6 +4282,11 @@ class TestBuildAcpStartConversationRequestSecrets:
)
assert request.observability_metadata == {
+ 'app': 'openhands',
+ 'conversation_id': str(request.conversation_id),
+ 'agent_kind': 'acp',
+ 'repo_name': 'test/repo',
+ 'selected_branch': 'feature-x',
'repo': 'test/repo',
'branch': 'feature-x',
'git_provider': 'github',
@@ -4283,6 +4313,11 @@ class TestBuildAcpStartConversationRequestSecrets:
)
assert request.observability_metadata == {
+ 'app': 'openhands',
+ 'conversation_id': str(request.conversation_id),
+ 'agent_kind': 'acp',
+ 'repo_name': 'test/repo',
+ 'selected_branch': 'feature-x',
'repo': 'test/repo',
'branch': 'feature-x',
'git_provider': 'github',
@@ -4290,10 +4325,16 @@ class TestBuildAcpStartConversationRequestSecrets:
}
@pytest.mark.asyncio
- async def test_no_repo_omits_observability_metadata(self, service, tmp_path):
- """A repo-less ACP conversation adds no repo metadata to the trace."""
+ async def test_no_repo_keeps_context_observability_metadata(
+ self, service, tmp_path
+ ):
+ """A repo-less ACP conversation keeps non-repo trace context metadata."""
user = self._make_acp_user()
request = await self._call_build(service, user, tmp_path)
- assert request.observability_metadata == {}
+ assert request.observability_metadata == {
+ 'app': 'openhands',
+ 'conversation_id': str(request.conversation_id),
+ 'agent_kind': 'acp',
+ }