Increase nginx proxy_read_timeout

[elcajon]

Proposed Changes

#744 (reply in thread)
Increase timeout to 1d to prevent HA from duplicating latest log entries.

Related Issues

(Github link to related issues or pull requests)

Summary by CodeRabbit

• Bug Fixes
  • Improved proxy connection timeout for API log streaming, allowing longer-running log follow operations without interruption.

[coderabbitai]

Walkthrough

The pull request modifies the Nginx configuration template by adding a proxy_read_timeout directive specifically for the /api/hassio/.*/logs.*/follow location block. The new directive sets the proxy read timeout to one day (1d), which extends the time Nginx will wait for a response from the proxied server before timing out. This change appears to be targeted at improving handling of long-running log follow requests.

Changes

File	Change Summary
cloudflared/rootfs/etc/nginx/template/nginx.conf.gtpl	Added proxy_read_timeout 1d; in the /api/hassio/.*/logs.*/follow location block

Possibly related PRs

• Restrict live log nginx location #780: Modifies Nginx configuration for the /api/hassio/.*/logs endpoint, which is directly related to the location block changes in this PR

Suggested reviewers

• brenner-tobias

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.
  • Generate unit testing code for this file.
  • 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 generate unit testing code for this file.
  • @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 generate unit testing code.
  • @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.

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 docstrings to generate docstrings for this PR. (Beta)
• @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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

cloudflared/rootfs/etc/nginx/template/nginx.conf.gtpl (1)

43-43: Consider a more moderate timeout value.

While setting proxy_read_timeout to 1 day will prevent log duplication, it's an unusually long timeout that could potentially:

1. Tie up server resources with stale connections
2. Make it harder to detect actual connection issues
3. Impact server performance under high load

Consider using a shorter timeout (e.g., 1 hour) and implementing a reconnection strategy on the client side:

-            proxy_read_timeout 1d;
+            proxy_read_timeout 1h;

For a more robust solution, consider:

1. Implementing WebSocket for real-time log streaming
2. Using Server-Sent Events (SSE) with automatic reconnection
3. Adding client-side retry logic with exponential backoff

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between f391f4e and 4365adf.

📒 Files selected for processing (1)

• cloudflared/rootfs/etc/nginx/template/nginx.conf.gtpl (1 hunks)

🔇 Additional comments (1)

cloudflared/rootfs/etc/nginx/template/nginx.conf.gtpl (1)

51-51: LGTM: Proper file formatting.

The addition of a newline at the end of the file follows good file formatting practices.

[othorp]

I'm not sure this PR is effective to fix proxy timeout end-to-end. proxy_read_timeout for Cloudflare itself is 100s: https://developers.cloudflare.com/fundamentals/reference/connection-limits/

Without being on an enterprise plan, I haven't found a way to override this. I see timeouts for live-logs at 1.7min in the developer console, which aligns with the above.

[elcajon]

I'm afraid you're right, I only tested for a little over a minute but not >100 seconds. I guess we then are only fixing a problem for customers who have subscribed to the enterprise plan...