Skip to content

feat!: Compress event payloads by default - #477

Open
keelerm84 wants to merge 2 commits into
feat/9.xfrom
mk/SDK-3389/compress-events-default
Open

keelerm84 wants to merge 2 commits into
feat/9.xfrom
mk/SDK-3389/compress-events-default

Conversation

@keelerm84

@keelerm84 keelerm84 commented Nov 2, 2026 •

Copy link
Copy Markdown
Member

The compress_events option now defaults to true. The SDK gzip-compresses
analytics and diagnostic event payloads and sends them with a
Content-Encoding: gzip header. This reduces egress bandwidth for
customers who send events directly to LaunchDarkly.

Relay Proxy versions before 8.9 cannot accept compressed events.
Customers who send events through the Relay Proxy should set
compress_events: false. Older Relay Proxy versions cannot decode the
payloads, and newer versions decode and re-encode them, which adds
overhead.

The stub HTTP server in the specs now decodes a request body based on
its Content-Encoding header instead of a constructor flag.


Note

Overview
compress_events now defaults to true, so new clients gzip analytics/diagnostic event bodies and send Content-Encoding: gzip unless explicitly disabled. Documentation now calls out Relay Proxy versions before 8.9 and recommends compress_events: false when events go through an older proxy.

Specs were updated to match: config tests assert the new default and opt-out, the stub HTTP server auto-decompresses when the request has gzip encoding (replacing an enable_compression constructor flag), and event sender coverage adds a case that default config sends compressed payloads.

Reviewed by Cursor Bugbot for commit 97645fb. Bugbot is set up for automated code reviews on this repo. Configure here.

The compress_events option now defaults to true. The SDK gzip-compresses
analytics and diagnostic event payloads and sends them with a
Content-Encoding: gzip header. This reduces egress bandwidth for
customers who send events directly to LaunchDarkly.

Relay Proxy versions before 8.9 cannot accept compressed events.
Customers who send events through the Relay Proxy should set
compress_events: false. Older Relay Proxy versions cannot decode the
payloads, and newer versions decode and re-encode them, which adds
overhead.

The stub HTTP server in the specs now decodes a request body based on
its Content-Encoding header instead of a constructor flag.
@keelerm84
keelerm84 marked this pull request as ready for review November 2, 2026 17:37
@keelerm84
keelerm84 requested a review from a team as a code owner November 2, 2026 17:37

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant