Skip to content

πŸ™Œ OpenHands: AI-Driven Development

PLTF-330: add timestamp to enterprise JSON logger formatter (#13555)

aivong-openhands9f47727da560
diff --git a/enterprise/poetry.lock b/enterprise/poetry.lock
index 6ee7ca914c..fd6e96536d 100644
--- a/enterprise/poetry.lock
+++ b/enterprise/poetry.lock
@@ -2598,6 +2598,21 @@ files = [
{file = "fqdn-1.5.1.tar.gz", hash = "sha256:105ed3677e767fb5ca086a0c1f4bb66ebc3c100be518f0e0d755d9eae164d89f"},
]
+[[package]]
+name = "freezegun"
+version = "1.5.5"
+description = "Let your Python tests travel through time"
+optional = false
+python-versions = ">=3.8"
+groups = ["test"]
+files = [
+ {file = "freezegun-1.5.5-py3-none-any.whl", hash = "sha256:cd557f4a75cf074e84bc374249b9dd491eaeacd61376b9eb3c423282211619d2"},
+ {file = "freezegun-1.5.5.tar.gz", hash = "sha256:ac7742a6cc6c25a2c35e9292dfd554b897b517d2dec26891a2e8debf205cb94a"},
+]
+
+[package.dependencies]
+python-dateutil = ">=2.7"
+
[[package]]
name = "frozenlist"
version = "1.8.0"
@@ -14997,4 +15012,4 @@ cffi = ["cffi (>=1.17,<2.0) ; platform_python_implementation != \"PyPy\" and pyt
[metadata]
lock-version = "2.1"
python-versions = "^3.12,<3.14"
-content-hash = "ef037f6d6085d26166d35c56ce266439f8f1a4fea90bc43ccf15cfeaf116cae5"
+content-hash = "c468b13e2d26e31e0e8f84518bcb8379234d431ca3819625f49b91aa3589359c"
diff --git a/enterprise/pyproject.toml b/enterprise/pyproject.toml
index ef1840a8e4..b029d2178f 100644
--- a/enterprise/pyproject.toml
+++ b/enterprise/pyproject.toml
@@ -64,6 +64,7 @@ pytest-asyncio = "*"
pytest-forked = "*"
pytest-xdist = "*"
flake8 = "*"
+freezegun = "^1.5.1"
openai = "*"
opencv-python = "*"
pandas = "*"
diff --git a/enterprise/server/logger.py b/enterprise/server/logger.py
index 5e5cf30977..50a5022406 100644
--- a/enterprise/server/logger.py
+++ b/enterprise/server/logger.py
@@ -84,6 +84,8 @@ def setup_json_logger(
style='{',
rename_fields={'levelname': 'severity'},
json_serializer=custom_json_serializer,
+ # Use 'ts' for consistency with LOG_JSON_FOR_CONSOLE mode (skip when console mode to avoid duplicates)
+ timestamp='ts' if not LOG_JSON_FOR_CONSOLE else False,
)
handler.setFormatter(formatter)
diff --git a/enterprise/tests/unit/test_logger.py b/enterprise/tests/unit/test_logger.py
index ce2001046f..61d70ef9e4 100644
--- a/enterprise/tests/unit/test_logger.py
+++ b/enterprise/tests/unit/test_logger.py
@@ -5,10 +5,15 @@ from io import StringIO
from unittest.mock import patch
import pytest
+from freezegun import freeze_time
from server.logger import format_stack, setup_json_logger
from openhands.core.logger import openhands_logger
+FROZEN_TIMESTAMP = '2024-01-15T10:30:00+00:00'
+# datetime.now().isoformat() doesn't include timezone info
+FROZEN_TIMESTAMP_NO_TZ = '2024-01-15T10:30:00'
+
@pytest.fixture
def log_output():
@@ -21,20 +26,31 @@ def log_output():
class TestLogOutput:
+ @freeze_time(FROZEN_TIMESTAMP)
def test_info(self, log_output):
logger, string_io = log_output
logger.info('Test message')
output = json.loads(string_io.getvalue())
- assert output == {'message': 'Test message', 'severity': 'INFO'}
+ assert output == {
+ 'message': 'Test message',
+ 'severity': 'INFO',
+ 'ts': FROZEN_TIMESTAMP,
+ }
+ @freeze_time(FROZEN_TIMESTAMP)
def test_error(self, log_output):
logger, string_io = log_output
logger.error('Test message')
output = json.loads(string_io.getvalue())
- assert output == {'message': 'Test message', 'severity': 'ERROR'}
+ assert output == {
+ 'message': 'Test message',
+ 'severity': 'ERROR',
+ 'ts': FROZEN_TIMESTAMP,
+ }
+ @freeze_time(FROZEN_TIMESTAMP)
def test_extra_fields(self, log_output):
logger, string_io = log_output
@@ -44,6 +60,7 @@ class TestLogOutput:
'key': '..val..',
'message': 'Test message',
'severity': 'INFO',
+ 'ts': FROZEN_TIMESTAMP,
}
def test_format_stack(self):
@@ -257,6 +274,7 @@ class TestLogOutput:
]
assert formatted == expected
+ @freeze_time(FROZEN_TIMESTAMP)
def test_filtering(self):
# Ensure that secret values are still filtered
string_io = StringIO()
@@ -266,4 +284,62 @@ class TestLogOutput:
):
openhands_logger.info('The secret key was supersecretvalue')
output = json.loads(string_io.getvalue())
- assert output == {'message': 'The secret key was ******', 'severity': 'INFO'}
+ assert output == {
+ 'message': 'The secret key was ******',
+ 'severity': 'INFO',
+ 'ts': FROZEN_TIMESTAMP,
+ }
+
+ @freeze_time(FROZEN_TIMESTAMP)
+ def test_console_serializer_uses_ts_not_timestamp(self):
+ """When LOG_JSON_FOR_CONSOLE=1, use 'ts' from custom_json_serializer, not 'timestamp'."""
+ import server.logger as logger_module
+
+ string_io = StringIO()
+ logger = logging.Logger('test_console')
+
+ # Patch LOG_JSON_FOR_CONSOLE to 1 for both setup_json_logger and custom_json_serializer
+ with patch.object(logger_module, 'LOG_JSON_FOR_CONSOLE', 1):
+ setup_json_logger(logger, 'INFO', _out=string_io)
+ logger.info('Test console message')
+
+ # Parse output - LOG_JSON_FOR_CONSOLE pretty-prints JSON across multiple lines
+ output = json.loads(string_io.getvalue())
+
+ # Should have 'ts' from custom_json_serializer but NOT 'timestamp'
+ assert 'ts' in output
+ assert 'timestamp' not in output
+ assert output['message'] == 'Test console message'
+ assert output['severity'] == 'INFO'
+
+ @freeze_time(FROZEN_TIMESTAMP)
+ def test_ts_not_duplicated_when_both_json_modes_enabled(self):
+ """When both LOG_JSON=1 and LOG_JSON_FOR_CONSOLE=1, 'ts' should appear only once."""
+ import server.logger as logger_module
+
+ string_io = StringIO()
+ logger = logging.Logger('test_both_modes')
+
+ # Patch both LOG_JSON and LOG_JSON_FOR_CONSOLE to 1
+ with (
+ patch.object(logger_module, 'LOG_JSON', True),
+ patch.object(logger_module, 'LOG_JSON_FOR_CONSOLE', 1),
+ ):
+ setup_json_logger(logger, 'INFO', _out=string_io)
+ logger.info('Test both modes message')
+
+ raw_output = string_io.getvalue()
+ output = json.loads(raw_output)
+
+ # Should have exactly one 'ts' field (not duplicated)
+ assert 'ts' in output
+ assert 'timestamp' not in output
+ # Verify 'ts' appears only once in the raw output (not duplicated as key)
+ assert (
+ raw_output.count('"ts"') == 1
+ ), f"'ts' should appear exactly once, found in: {raw_output}"
+ assert output['message'] == 'Test both modes message'
+ assert output['severity'] == 'INFO'
+ # When LOG_JSON_FOR_CONSOLE=1, custom_json_serializer uses datetime.now().isoformat()
+ # which doesn't include timezone info
+ assert output['ts'] == FROZEN_TIMESTAMP_NO_TZ