feat(elasticsearch): add flag to enable gzip compression #7072
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit adds a new flag `--es.http-compression=true|false` that optionally enables gzip compression for requests to ElasticSearch. The setting is supported by both client libraries that are used. ElasticSearch has accepted compressed requests since version 5.0, anyway the default has been left on false to avoid breaking any existing setups. Signed-off-by: Timon Engelke <[email protected]>
yurishkuro
reviewed
Apr 25, 2025
|
No, I think it would be best to turn compression on by default (I can't even imagine why you would want to turn it off, so I probably would have just turned it on without exposing the setting), but I was afraid that you would hesitate to merge such a change and this seemed to be the easier solution. If you are open to that, I can adapt the changes to either change the default or not expose the configuration option. Either will probably save a lot of people a lot of money. |
|
It's the right way to have is as an option, but I agree it should be on by default |
yurishkuro
reviewed
Apr 25, 2025
yurishkuro
added
the
changelog:breaking-change
Since gzip compression has no negative effect in a normal setup, we have decided to turn the setting on by default. Signed-off-by: Timon Engelke <[email protected]>
yurishkuro
approved these changes
Apr 26, 2025
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #7072 +/- ##
==========================================
+ Coverage 96.01% 96.05% +0.04%
==========================================
Files 355 355
Lines 20993 21007 +14
==========================================
+ Hits 20156 20178 +22
+ Misses 630 624 -6
+ Partials 207 205 -2
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
amilbcahat
pushed a commit
to amilbcahat/jaeger
that referenced
this pull request
May 4, 2025
…ng#7072) ## Which problem is this PR solving? Currently, Jaeger sends its traces to ElasticSearch as uncompressed text. Since text is can be compressed quite well, enabling Gzip compression can significantly reduce Jaeger's network traffic. ElasticSearch has accepted compressed requests since version 5.0 and since the same version it has already sent compressed responses by default (cf. elastic/elasticsearch@0a6f40c). ## Description of the changes * 🛑 (breaking change) **Enable by default** the compression for requests to ElasticSearch * Add a new flag `--es.http-compression=true|false` that can be used to opt-out of compression . The setting is already supported by both client libraries that are used. ## How was this change tested? I tested the change running a local ElasticSearch instance and `SPAN_STORAGE_TYPE=elasticsearch ./cmd/collector/collector-linux-amd64 --es.http-compression=true`. I sent traces to Jaeger using `tracepusher` and observed the network traffic between Jaeger and ElasticSearch using `tcpdump` to verify that the traffic is indeed compressed. ## Checklist - [x] I have read https://github.com/jaegertracing/jaeger/blob/master/CONTRIBUTING_GUIDELINES.md - [x] I have signed all commits - [x] I have added unit tests for the new functionality - [x] I have run lint and test steps successfully - for `jaeger`: `make lint test` - for `jaeger-ui`: `npm run lint` and `npm run test` --------- Signed-off-by: Timon Engelke <[email protected]>
amilbcahat
pushed a commit
to amilbcahat/jaeger
that referenced
this pull request
May 4, 2025
…ng#7072) ## Which problem is this PR solving? Currently, Jaeger sends its traces to ElasticSearch as uncompressed text. Since text is can be compressed quite well, enabling Gzip compression can significantly reduce Jaeger's network traffic. ElasticSearch has accepted compressed requests since version 5.0 and since the same version it has already sent compressed responses by default (cf. elastic/elasticsearch@0a6f40c). ## Description of the changes * 🛑 (breaking change) **Enable by default** the compression for requests to ElasticSearch * Add a new flag `--es.http-compression=true|false` that can be used to opt-out of compression . The setting is already supported by both client libraries that are used. ## How was this change tested? I tested the change running a local ElasticSearch instance and `SPAN_STORAGE_TYPE=elasticsearch ./cmd/collector/collector-linux-amd64 --es.http-compression=true`. I sent traces to Jaeger using `tracepusher` and observed the network traffic between Jaeger and ElasticSearch using `tcpdump` to verify that the traffic is indeed compressed. ## Checklist - [x] I have read https://github.com/jaegertracing/jaeger/blob/master/CONTRIBUTING_GUIDELINES.md - [x] I have signed all commits - [x] I have added unit tests for the new functionality - [x] I have run lint and test steps successfully - for `jaeger`: `make lint test` - for `jaeger-ui`: `npm run lint` and `npm run test` --------- Signed-off-by: Timon Engelke <[email protected]> Signed-off-by: amol-verma-allen <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Which problem is this PR solving?
Currently, Jaeger sends its traces to ElasticSearch as uncompressed text. Since text is can be compressed quite well, enabling Gzip compression can significantly reduce Jaeger's network traffic. ElasticSearch has accepted compressed requests since version 5.0 and since the same version it has already sent compressed responses by default (cf. elastic/elasticsearch@0a6f40c).
Description of the changes
--es.http-compression=true|falsethat can be used to opt-out of compression . The setting is already supported by both client libraries that are used.How was this change tested?
I tested the change running a local ElasticSearch instance and
SPAN_STORAGE_TYPE=elasticsearch ./cmd/collector/collector-linux-amd64 --es.http-compression=true. I sent traces to Jaeger usingtracepusherand observed the network traffic between Jaeger and ElasticSearch usingtcpdumpto verify that the traffic is indeed compressed.Checklist
jaeger:make lint testjaeger-ui:npm run lintandnpm run test