Home Original page

NetworkTarget - Added SendTimeoutSeconds to assign TCP Socket SendTimeout by snakefoot · Pull Request #5587 · NLog/NLog

Caution

Review failed

The pull request is closed.

Walkthrough

A send timeout feature was introduced for network senders in the NLog framework. This involved adding a send timeout property to relevant sender classes, updating factory interfaces and implementations to accept the new parameter, and propagating the configuration option through the NetworkTarget. Corresponding unit tests were updated and a new test was added for the send timeout configuration.

Changes

File(s) Change Summary
src/NLog/Internal/NetworkSenders/HttpNetworkSender.cs, TcpNetworkSender.cs Added internal SendTimeout property; set timeout on sockets/requests if specified.
src/NLog/Internal/NetworkSenders/INetworkSenderFactory.cs, NetworkSenderFactory.cs Updated Create method signature to include a TimeSpan sendTimeout parameter; passed to sender instances.
src/NLog/Targets/NetworkTarget.cs Added public SendTimeoutSeconds property; updated sender creation to pass send timeout.
tests/NLog.UnitTests/Internal/NetworkSenders/HttpNetworkSenderTests.cs, TcpNetworkSenderTests.cs Updated test mocks and overrides to match new method signatures with send timeout parameter.
tests/NLog.UnitTests/Targets/NetworkTargetTests.cs Updated factory mock for new signature; added SendTimeoutConfigTest for new property; removed Linux skip.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant NetworkTarget
    participant NetworkSenderFactory
    participant NetworkSender (TCP/HTTP)

    User->>NetworkTarget: Set SendTimeoutSeconds property
    NetworkTarget->>NetworkSenderFactory: Create(..., keepAliveTime, sendTimeout)
    NetworkSenderFactory->>NetworkSender: Instantiate with SendTimeout
    NetworkSender->>NetworkSender: Set underlying socket/request timeout
Loading

Poem

A timeout for sending, how clever and neat,
Now sockets and HTTP won't endlessly repeat.
With seconds to spare, and tests that align,
Our networked logs will travel just fine.
🕰️🐇

— A rabbit, never late for a very important date!

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b1ab39c and 3e0922b.

📒 Files selected for processing (8)
  • src/NLog/Internal/NetworkSenders/HttpNetworkSender.cs (2 hunks)
  • src/NLog/Internal/NetworkSenders/INetworkSenderFactory.cs (1 hunks)
  • src/NLog/Internal/NetworkSenders/NetworkSenderFactory.cs (6 hunks)
  • src/NLog/Internal/NetworkSenders/TcpNetworkSender.cs (3 hunks)
  • src/NLog/Targets/NetworkTarget.cs (2 hunks)
  • tests/NLog.UnitTests/Internal/NetworkSenders/HttpNetworkSenderTests.cs (3 hunks)
  • tests/NLog.UnitTests/Internal/NetworkSenders/TcpNetworkSenderTests.cs (2 hunks)
  • tests/NLog.UnitTests/Targets/NetworkTargetTests.cs (2 hunks)

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.