Skip to content
This repository has been archived by the owner on Dec 21, 2024. It is now read-only.

only rename existing fields and keep the order #176

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions src/pythonjsonlogger/jsonlogger.py
Original file line number Diff line number Diff line change
Expand Up @@ -228,9 +228,9 @@ def add_fields(
self._perform_rename_log_fields(log_record)

def _perform_rename_log_fields(self, log_record):
for old_field_name, new_field_name in self.rename_fields.items():
log_record[new_field_name] = log_record[old_field_name]
del log_record[old_field_name]
"""Perform a substitution in place to maintain the order"""
for key, value in list(log_record.items()):
log_record[self.rename_fields.get(key, key)] = log_record.pop(key)

def process_log_record(self, log_record):
"""
Expand Down
16 changes: 9 additions & 7 deletions tests/test_jsonlogger.py
Original file line number Diff line number Diff line change
Expand Up @@ -62,15 +62,17 @@ def test_rename_base_field(self):

self.assertEqual(log_json["@message"], msg)

def test_rename_nonexistent_field(self):
fr = jsonlogger.JsonFormatter(rename_fields={'nonexistent_key': 'new_name'})
self.log_handler.setFormatter(fr)
def test_rename_maintaining_order(self):
fr = jsonlogger.JsonFormatter(
"%(levelname)s %(message)s %(asctime)",
rename_fields={'levelname': 'level'}
)

stderr_watcher = StringIO()
sys.stderr = stderr_watcher
self.log.info("testing logging rename")
self.log_handler.setFormatter(fr)
self.log.info("testing rename while maintaining order")
log_json = json.loads(self.buffer.getvalue())

self.assertTrue("KeyError: 'nonexistent_key'" in stderr_watcher.getvalue())
self.assertTrue(list(log_json.keys())[0] == "level")

def test_add_static_fields(self):
fr = jsonlogger.JsonFormatter(static_fields={'log_stream': 'kafka'})
Expand Down