10000 Support socket timeout in SysLogHandler to prevent indefinite blocking on socket creation · Issue #126400 · python/cpython · GitHub
[go: up one dir, main page]
Skip to content

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

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

Jump to bottom
Closed
hodamarr opened this issue Nov 4, 2024 · 6 comments
Closed

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

hodamarr opened this issue Nov 4, 2024 · 6 comments
Assignees
@hodamarr
Labels
stdlib Python modules in the Lib dir type-feature A feature request or enhancement

Comments

@hodamarr
Copy link
Contributor
hodamarr commented Nov 4, 2024 •
edited by bedevere-app bot
Loading

Feature or enhancement

Proposal:

Hi,
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. This is problematic because there is no way to set a socket timeout during the connection's creation without overriding the entire createSocket method.

The only way to add timeout is to override the whole createSocket method (if I use super().createSocket() it will get stuck on this line)

my suggestion:

class SysLogHandler(logging.Handler):
    def __init__(self, address=('localhost', SYSLOG_UDP_PORT), 
                 facility=LOG_USER, socktype=None, timeout=None):
        # Existing initialization
        self.timeout = timeout  # New timeout parameter
        self.createSocket()
    
    def createSocket(self):
        # Existing code ....
        try:
            sock = socket.socket(af, socktype, proto)
            **if self.timeout:
                     sock.setttimeout(self.timeout)**
            # Existing code ........

Thanks

Has this already been discussed elsewhere?

No response given

Links to previous discussion of this feature:

No response

Linked PRs
@hodamarr hodamarr added the type-feature A feature request or enhancement label Nov 4, 2024
@Zheaoli
Copy link
Contributor
Zheaoli commented Nov 4, 2024

If I remember correct, the SysLog is based on the UDP protocol. I'm sure the timeout is useful for UDP

@hodamarr hodamarr closed this as completed Nov 4, 2024
@hodamarr hodamarr reopened this Nov 4, 2024
@hodamarr
Copy link
Contributor Author
hodamarr commented Nov 4, 2024

If I remember correct, the SysLog is based on the UDP protocol. I'm sure the timeout is useful for UDP

Syslog uses both UDP and TCP. A timeout is crucial to avoid blocking the process if the service is unreachable or slow to respond. In my case, I'm using TCP, and the server is unreachable, causing my process to be blocked indefinitely. Adding timeout support to SysLogHandler would allow the application to fail gracefully in such scenarios, instead of hanging due to network issues.

@picnixz picnixz added the stdlib Python modules in the Lib dir label Nov 6, 2024
@hodamarr
Copy link
Contributor Author

Hey @picnixz I can take care of this—could you assign me to it?

@picnixz picnixz moved this to Todo in Logging issues 🪵 Nov 10, 2024
@picnixz
Copy link
Member
picnixz commented Nov 10, 2024

Before starting the implementation, I wonder whether this should count as a bug fix or not (and whether there is another way to fix it). So let's ask @vsajip first.

@hodamarr
Copy link
Contributor Author

Sure, let me know when its okay to open a pull request.
@vsajip @picnixz

@vsajip
Copy link
Member
vsajip commented Nov 10, 2024

Yes, this seems a reasonable feature to add. You're welcome to submit a PR with docs/tests.

hodamarr added a commit to hodamarr/cpython that referenced this issue Nov 12, 2024
@hodamarr
pythongh-126400: Add TCP socket timeout to SysLogHandler
6ee0928
@hodamarr hodamarr mentioned this issue Nov 12, 2024
Merged
hodamarr added a commit to hodamarr/cpython that referenced this issue Nov 30, 2024
@hodamarr
pythongh-126400: Add TCP socket timeout to SysLogHandler
73e6f80
@github-actions github-actions bot mentioned this issue Dec 1, 2024
Monthly issue metrics report hugovk/test#88
Closed
vsajip added a commit that referenced this issue Jan 29, 2025
@hodamarr @vsajip
gh-126400: Add TCP socket timeout to SysLogHandler to prevent blocking (
fdcedfd 
GH-126716)

Co-authored-by: Vinay Sajip <vinay_sajip@yahoo.co.uk>
@vsajip vsajip closed this as completed Jan 29, 2025
@github-project-automation github-project-automation bot moved this from Todo to Done in Logging issues 🪵 Jan 29, 2025
srinivasreddy pushed a commit to srinivasreddy/cpython that referenced this issue Feb 7, 2025
@hodamarr @vsajip @srinivasreddy
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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@hodamarr hodamarr

Labels
stdlib Python modules in the Lib dir type-feature A feature request or enhancement
Projects
Logging issues 🪵
Status: Done
Milestone
No milestone
Development

No branches or pull requests
4 participants
@vsajip @Zheaoli @picnixz @hodamarr
0