Skip to content

PYTHON-4557 - Add log message for retried commands #2248

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Apr 2, 2025
Merged

PYTHON-4557 - Add log message for retried commands #2248

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
6ce31b6
PYTHON-4557 - Add log message for retried commands
NoahStapp Mar 31, 2025
0b6c4fb
Add operation name and ID to message
NoahStapp Apr 1, 2025
ffb3ebb
Use logging format
NoahStapp Apr 1, 2025
9808a0d
Merge branch 'master' into PYTHON-4557
NoahStapp Apr 1, 2025
c10ed80
Fix clientId
NoahStapp Apr 1, 2025
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
4 changes: 2 additions & 2 deletions pymongo/asynchronous/mongo_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2837,7 +2837,7 @@ async def _write(self) -> T:
if self._retrying:
_debug_log(
_COMMAND_LOGGER,
message=f"Retrying write attempt number {self._attempt_number}",
message=f"Retrying write attempt number {self._attempt_number} for operation `{self._operation}` with id {self._operation_id}",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's use the logging format:

                    _debug_log(
                        _COMMAND_LOGGER,
                        message=f"Retrying write attempt number {self._attempt_number}",
                        clientId=...,
                        commandName=self._operation,
                        operationId=self._operation_id

)
return await self._func(self._session, conn, self._retryable) # type: ignore
except PyMongoError as exc:
Expand All @@ -2863,7 +2863,7 @@ async def _read(self) -> T:
if self._retrying:
_debug_log(
_COMMAND_LOGGER,
message=f"Retrying read attempt number {self._attempt_number}",
message=f"Retrying read attempt number {self._attempt_number} for operation `{self._operation}` with id {self._operation_id}",
)
return await self._func(self._session, self._server, conn, read_pref) # type: ignore

Expand Down
4 changes: 2 additions & 2 deletions pymongo/synchronous/mongo_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2823,7 +2823,7 @@ def _write(self) -> T:
if self._retrying:
_debug_log(
_COMMAND_LOGGER,
message=f"Retrying write attempt number {self._attempt_number}",
message=f"Retrying write attempt number {self._attempt_number} for operation `{self._operation}` with id {self._operation_id}",
)
return self._func(self._session, conn, self._retryable) # type: ignore
except PyMongoError as exc:
Expand All @@ -2849,7 +2849,7 @@ def _read(self) -> T:
if self._retrying:
_debug_log(
_COMMAND_LOGGER,
message=f"Retrying read attempt number {self._attempt_number}",
message=f"Retrying read attempt number {self._attempt_number} for operation `{self._operation}` with id {self._operation_id}",
)
return self._func(self._session, self._server, conn, read_pref) # type: ignore

Expand Down
1 change: 1 addition & 0 deletions test/asynchronous/test_logger.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,7 @@ async def test_logging_retry_read_attempts(self):
retry_messages = [
r.getMessage() for r in cm.records if "Retrying read attempt" in r.getMessage()
]
print(retry_messages)
self.assertEqual(len(retry_messages), 1)


Expand Down
1 change: 1 addition & 0 deletions test/test_logger.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,7 @@ def test_logging_retry_read_attempts(self):
retry_messages = [
r.getMessage() for r in cm.records if "Retrying read attempt" in r.getMessage()
]
print(retry_messages)
self.assertEqual(len(retry_messages), 1)


Expand Down
Loading