docs: add throughput config options, NR auto-disable note, high-throughput example by ankurs · Pull Request #48 · go-coldbrew/docs.coldbrew.cloud

ankurs · 2026-04-02T20:19:36Z

Summary

config-reference: New sections for HTTP Compression (DISABLE_HTTP_COMPRESSION, HTTP_COMPRESSION_MIN_SIZE) and Response Time Logging (RESPONSE_TIME_LOG_LEVEL, RESPONSE_TIME_LOG_ERROR_ONLY)
config-reference: Note that DISABLE_NEW_RELIC is auto-set to true when license key is empty
config-reference: New "High-Throughput Production" example with recommended env vars for 70k+ QPS services
FAQ: Mention coldbrew.trace_id OTEL span attribute in trace ID propagation section

Test plan

Verify docs site builds and pages render correctly

Summary by CodeRabbit

Documentation
- Updated trace ID propagation documentation to include OpenTelemetry spans.
- Added new HTTP compression configuration options for controlling gateway response compression.
- Added response time logging configuration options for performance monitoring.
- Included high-throughput production configuration example.

- config-reference: add HTTP Compression section (DISABLE_HTTP_COMPRESSION, HTTP_COMPRESSION_MIN_SIZE), Response Time Logging section (RESPONSE_TIME_LOG_LEVEL, RESPONSE_TIME_LOG_ERROR_ONLY) - config-reference: note NR auto-disable when license key is empty - config-reference: add high-throughput production example - FAQ: mention coldbrew.trace_id OTEL span attribute in trace ID propagation

coderabbitai · 2026-04-02T20:19:49Z

Warning

Rate limit exceeded

@ankurs has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 24 minutes and 39 seconds before requesting another review.

Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 24 minutes and 39 seconds.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 6a5e45ff-60f9-4050-a16c-9ef446caa054

📥 Commits

Reviewing files that changed from the base of the PR and between 7aa457f and 14d3349.

📒 Files selected for processing (1)

config-reference.md

📝 Walkthrough

Walkthrough

Documentation updates extending trace ID propagation details to include OpenTelemetry spans and adding new HTTP compression and response time logging configuration documentation with example high-throughput production settings.

Changes

Cohort / File(s)	Summary
Documentation Updates `FAQ.md`, `config-reference.md`	Extended FAQ to cover OpenTelemetry span trace ID propagation using `coldbrew.trace_id` attribute; clarified `DISABLE_NEW_RELIC` auto-set behavior; documented new HTTP compression options (`DISABLE_HTTP_COMPRESSION`, `HTTP_COMPRESSION_MIN_SIZE`) and response time logging options (`RESPONSE_TIME_LOG_LEVEL`, `RESPONSE_TIME_LOG_ERROR_ONLY`); added high-throughput production configuration example.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Possibly related PRs

docs: update for OTEL migration — remove OpenTracing references #44: Both PRs update tracing documentation to reflect OpenTelemetry trace ID propagation behavior and add the coldbrew.trace_id span attribute specification.

Poem

🐰 Hops through docs with carrot cheer,
Trace IDs now in OTEL appear!
Compression tuned for speed and might,
Config examples burning bright—
Knowledge shared, the garden's right! 🥕✨

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately summarizes the main changes: adding throughput configuration options, documenting New Relic auto-disable behavior, and providing a high-throughput example.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Commit unit tests in branch docs/add-throughput-config-reference

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

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

Copilot

Pull request overview

This PR updates the ColdBrew docs to better document throughput/overhead-related configuration knobs and trace ID propagation details, primarily by expanding the configuration reference and clarifying FAQ guidance.

Changes:

Adds new config-reference sections for HTTP compression and per-request response-time logging controls.
Clarifies DISABLE_NEW_RELIC behavior when NEW_RELIC_LICENSE_KEY is empty.
Adds a “High-Throughput Production” environment variable example and updates the FAQ to mention an OTEL span attribute for trace ID.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.

File	Description
FAQ.md	Updates trace ID propagation text to include OpenTelemetry span attribute mention.
config-reference.md	Adds new config sections + a high-throughput example; clarifies New Relic disable behavior.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

… OTLP example

Copilot

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated no new comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated no new comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot AI review requested due to automatic review settings April 2, 2026 20:19

Copilot started reviewing on behalf of ankurs April 2, 2026 20:20 View session

Copilot AI reviewed Apr 2, 2026

View reviewed changes

Comment thread config-reference.md

Comment thread config-reference.md

Comment thread FAQ.md

Comment thread config-reference.md Outdated

fix: merge compression into HTTP Gateway section, clarify NR default,…

2ddae0b

… OTLP example

ankurs requested a review from Copilot April 3, 2026 06:07

Copilot started reviewing on behalf of ankurs April 3, 2026 06:07 View session

Copilot AI reviewed Apr 3, 2026

View reviewed changes

Comment thread config-reference.md Outdated

Comment thread config-reference.md Outdated

fix: clarify LOG_LEVEL interaction, remove redundant example var

14d3349

ankurs requested a review from Copilot April 3, 2026 06:31

Copilot started reviewing on behalf of ankurs April 3, 2026 06:31 View session

Copilot AI reviewed Apr 3, 2026

View reviewed changes

ankurs requested a review from Copilot April 3, 2026 06:39

Copilot started reviewing on behalf of ankurs April 3, 2026 06:40 View session

Copilot AI reviewed Apr 3, 2026

View reviewed changes

ankurs merged commit 51cd6e8 into main Apr 3, 2026
15 checks passed

ankurs deleted the docs/add-throughput-config-reference branch April 3, 2026 07:46

This was referenced Apr 4, 2026

docs: add performance benchmarks, pprof analysis, and tuning trade-offs #54

Merged

docs: update for native stats/opentelemetry migration #62

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: add throughput config options, NR auto-disable note, high-throughput example#48

docs: add throughput config options, NR auto-disable note, high-throughput example#48
ankurs merged 3 commits intomainfrom
docs/add-throughput-config-reference

ankurs commented Apr 2, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

coderabbitai Bot commented Apr 2, 2026 •

edited

Loading

Rate limit exceeded

Walkthrough

Changes

Estimated code review effort

Possibly related PRs

Poem

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

ankurs commented Apr 2, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Test plan

Summary by CodeRabbit

Uh oh!

coderabbitai Bot commented Apr 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Rate limit exceeded

Walkthrough

Changes

Estimated code review effort

Possibly related PRs

Poem

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

ankurs commented Apr 2, 2026 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented Apr 2, 2026 •

edited

Loading