gh-126400: Add TCP socket timeout to SysLogHandler to prevent blocking by hodamarr · Pull Request #126716 · python/cpython · GitHub

Issue #126400.
branch name - fix-issue-126400

Summary

In the current implementation of the SysLogHandler class from the logging.handlers module, if the specified address does not respond or is unreachable, the createSocket method may block indefinitely in case of using TCP socket (based on stream). This is problematic because there is no way to set a socket timeout during the connection's creation without overriding the entire createSocket method.

Changes

Added a timeout parameter to the SysLogHandler.__init__ method, allowing users to specify a timeout for the socket connection.
Updated the createSocket method to apply the timeout to the socket if provided.

This change allows users to prevent indefinite blocking on socket creation, enabling more robust error handling when the SysLog server is unresponsive.

Example Usage

With this update, users can now create a SysLogHandler with a timeout as follows:

import logging
from logging.handlers import SysLogHandler

# Create a SysLogHandler with a 5-second timeout
handler = SysLogHandler(address=('localhost', 514), timeout=5)

Issue: Support socket timeout in SysLogHandler to prevent indefinite blocking on socket creation #126400

All commit authors signed the Contributor License Agreement.

Most changes to Python require a NEWS entry. Add one using the blurb_it web app or the blurb command-line tool.

If this change has little impact on Python users, wait for a maintainer to apply the skip news label instead.

Thank you for the PR. Would you mind updating the documentation, adding a NEWS entry using the blurb tool and signing the CLA? Thanks again.

Hi @vsajip, added

Thanks for those. You don't feel comfortable updating the docs?

@vsajip Oh, I thought you meant only the blurb. I'll update the documentation as well
This is the first time that I'm contributing to open source :)

This is the first time that I'm contributing to open source

Hopefully the first of many contributions! As it's an API change, it needs the documentation updating so users will know about the new parameter.

Suggested change

      
            Added a timeout parameter to logging.handlers.SysLogHandler class to control the TCP socket timeout and prevent process blocking when the Syslog server is unreachable; this improves resilience when working with unresponsive Syslog servers. 
          
            Added a timeout parameter to :class:`logging.handlers.SysLogHandler` class to control the TCP socket timeout and prevent process blocking when the Syslog server is unreachable; this improves resilience when working with unresponsive Syslog servers.

Please update file ./Doc/library/logging.handlers.rst to mention added timeout parameter.

Take a look atsocktype argument for inspiration.

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

Most changes to Python require a NEWS entry. Add one using the blurb_it web app or the blurb command-line tool.

If this change has little impact on Python users, wait for a maintainer to apply the skip news label instead.

Most changes to Python require a NEWS entry. Add one using the blurb_it web app or the blurb command-line tool.

If this change has little impact on Python users, wait for a maintainer to apply the skip news label instead.

Most changes to Python require a NEWS entry. Add one using the blurb_it web app or the blurb command-line tool.

If this change has little impact on Python users, wait for a maintainer to apply the skip news label instead.

The docs build is failing with some unrelated error in processing the Misc/NEWS entries, same happens locally. I've fixed the sphinx lint error and missing blurb in this PR. Not sure what the docs build problem is.

Somewhere, perhaps during a force-push, the original blurb got lost. I added a new one (a bit shorter) and everything now seems to be building correctly. I had to update a couple of unrelated blurb files, seemingly because they wrongly had gh: instead of gh-issue: in places (perhaps a change to blurb caused the build failures).

…locking (pythonGH-126716) Co-authored-by: Vinay Sajip <vinay_sajip@yahoo.co.uk>

hodamarr requested a review from vsajip as a code owner November 12, 2024 07:05

bedevere-app Bot added the awaiting review label Nov 12, 2024

bedevere-app Bot mentioned this pull request Nov 12, 2024

Support socket timeout in SysLogHandler to prevent indefinite blocking on socket creation #126400

Closed

asvetlov reviewed Nov 13, 2024

View reviewed changes

asvetlov requested changes Nov 13, 2024

View reviewed changes

bedevere-app Bot added awaiting changes and removed awaiting review labels Nov 13, 2024

pythongh-126400 : Add TCP socket timeout to SysLogHandler

73e6f80

hodamarr force-pushed the fix-issue-126400 branch from bffa2ed to 73e6f80 Compare November 30, 2024 15:12

vsajip reviewed Jan 19, 2025

View reviewed changes

Comment thread Doc/library/logging.handlers.rst Outdated

Use Specific Python version.

cd4bba9

Use double backticks to placate sphinx-lint.

603596f

Add Misc/NEWS entry.

07b7a63

Manually fix up NEWS files adding missing -issue to gh metadata.

32370d3

vsajip approved these changes Jan 29, 2025

View reviewed changes

bedevere-app Bot added awaiting merge and removed awaiting changes labels Jan 29, 2025

vsajip merged commit fdcedfd into python:main Jan 29, 2025

bedevere-app Bot removed the awaiting merge label Jan 29, 2025

srinivasreddy pushed a commit to srinivasreddy/cpython that referenced this pull request Feb 7, 2025

pythongh-126400 : Add TCP socket timeout to SysLogHandler to prevent b…

f10f690

…locking (pythonGH-126716) Co-authored-by: Vinay Sajip <vinay_sajip@yahoo.co.uk>

RazerM mentioned this pull request Oct 18, 2026

Add a timeout to SyslogHandler getlogbook/logbook#706

Merged

		@@ -0,0 +1,3 @@
		Added a timeout parameter to logging.handlers.SysLogHandler class to control the TCP socket timeout and prevent process blocking when the Syslog server is unreachable; this improves resilience when working with unresponsive Syslog servers.

	Added a timeout parameter to logging.handlers.SysLogHandler class to control the TCP socket timeout and prevent process blocking when the Syslog server is unreachable; this improves resilience when working with unresponsive Syslog servers.
	Added a timeout parameter to :class:`logging.handlers.SysLogHandler` class to control the TCP socket timeout and prevent process blocking when the Syslog server is unreachable; this improves resilience when working with unresponsive Syslog servers.

gh-126400: Add TCP socket timeout to SysLogHandler to prevent blocking by hodamarr · Pull Request #126716 · python/cpython · GitHub

Repository navigation

gh-126400: Add TCP socket timeout to SysLogHandler to prevent blocking - #126716

gh-126400: Add TCP socket timeout to SysLogHandler to prevent blocking#126716vsajip merged 5 commits intopython:mainpython/cpython:mainfrom hodamarr:fix-issue-126400hodamarr/cpython:fix-issue-126400Copy head branch name to clipboard

Conversation

hodamarr commented Nov 12, 2024 • edited by bedevere-app Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Changes

Example Usage

Uh oh!

ghost commented Nov 12, 2024 • edited by ghost Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

bedevere-app Bot commented Nov 12, 2024

Uh oh!

vsajip commented Nov 12, 2024

Uh oh!

hodamarr commented Nov 12, 2024

Uh oh!

vsajip commented Nov 12, 2024

Uh oh!

hodamarr commented Nov 12, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

vsajip commented Nov 13, 2024

Uh oh!

asvetlov Nov 13, 2024

Choose a reason for hiding this comment

Uh oh!

asvetlov left a comment

Choose a reason for hiding this comment

Uh oh!

bedevere-app Bot commented Nov 13, 2024

Uh oh!

bedevere-app Bot commented Nov 30, 2024

Uh oh!

Uh oh!

bedevere-app Bot commented Jan 19, 2025

Uh oh!

bedevere-app Bot commented Jan 29, 2025

Uh oh!

vsajip commented Jan 29, 2025

Uh oh!

vsajip commented Jan 29, 2025

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

gh-126400: Add TCP socket timeout to SysLogHandler to prevent blocking#126716
vsajip merged 5 commits into
python:mainfrom
hodamarr:fix-issue-126400

hodamarr commented Nov 12, 2024 •
edited by bedevere-app Bot
Loading

ghost commented Nov 12, 2024 •
edited by ghost
Loading

hodamarr commented Nov 12, 2024 •
edited
Loading