Include ratelimit headers in debug logs

[russellhaering]

Summary by CodeRabbit

• New Features
  • Enhanced HTTP logging to include key response headers related to rate limiting and retry information for improved visibility during requests.

[coderabbitai]

Walkthrough

A new package-level variable was added to store a list of HTTP response headers relevant to rate limiting and retry information. The HTTP transport logic was updated so that, when logging is enabled and a response is received, the values of these headers are extracted from the response and included in the log output. This change enhances the detail of HTTP request logs by systematically capturing important rate limit and retry headers from responses.

Changes

File(s)	Change Summary
pkg/uhttp/transport.go	Introduced loggedResponseHeaders variable for rate limit/retry headers; updated logging to include these headers from HTTP responses.

Poem

In the warren where requests flow,
New headers in the logs now show.
Rate limits, retries, all in sight,
For every hop through day or night.
With careful notes the rabbits cheer,
More details in the logs appear! 🐇✨

✨ Finishing Touches

• 📝 Generate Docstrings

---

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

• 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.
• @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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

pkg/uhttp/transport.go (1)

161-169: Good implementation for capturing header values

The code efficiently collects and logs only the headers that are present in the response. One small optimization could be to initialize the map with len(loggedResponseHeaders) instead of len(resp.Header) since you'll only be storing a subset of headers.

-			headers := make(map[string][]string, len(resp.Header))
+			headers := make(map[string][]string, len(loggedResponseHeaders))

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 2576903 and 98d74d8.

📒 Files selected for processing (1)

• pkg/uhttp/transport.go (2 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: go-test (1.23.x, windows-latest)

🔇 Additional comments (1)

pkg/uhttp/transport.go (1)

18-37: Well-organized list of rate limit headers!

Good job documenting the purpose of each header group and including non-standard headers from services like Linear and Okta with clear comments. This comprehensive approach ensures capturing all relevant rate limiting information.

[gontzess]

🚀