Skip to content

feat: Add option to enable compression of event payloads #91

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Dec 4, 2024

Conversation

keelerm84
Copy link
Member

No description provided.

@keelerm84 keelerm84 requested a review from a team as a code owner December 4, 2024 18:46
@@ -5,7 +5,7 @@ cabal-version: 1.12
-- see: https://github.com/sol/hpack

name: launchdarkly-server-sdk
version: 4.2.0
version: 4.3.0
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am a little confused about the version number being out of date?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A deficiency of the build system I need to fix.

@@ -69,12 +74,15 @@ eventThread manager client clientContext = do
payloadId <- liftIO $ atomicModifyIORef' rngRef (swap . random)
let
encoded = encode events'
compressed = if compressEvents then GZip.compress encoded else encoded
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should it maybe be something like maybeCompressed? Or alternatively more generic like payload.

@keelerm84 keelerm84 merged commit cb21081 into main Dec 4, 2024
8 checks passed
@keelerm84 keelerm84 deleted the mk/sdk-846/gzip branch December 4, 2024 22:01
keelerm84 added a commit that referenced this pull request Dec 6, 2024
🤖 I have created a release *beep* *boop*
---


##
[4.4.0](4.3.0...4.4.0)
(2024-12-05)

This release introduces the ability to enable compression of event
payloads. When enabled, the SDK will compress events before sending them
to the LaunchDarkly servers. This can reduce the bandwidth required to
send events, which can be useful in high-traffic environments to reduce
egress traffic costs.

> [!IMPORTANT]
> Relay Proxy users **MUST** upgrade to version 8.9 or higher prior to
enabling this option to prevent loss of event data.
>
> However, enabling this feature is **NOT** required when using the
Relay Proxy as it will manage compression automatically.

### Features

* Add option to enable compression of event payloads
([#91](#91))
([cb21081](cb21081))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Matthew Keeler <mkeeler@launchdarkly.com>
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.

2 participants