hangc0276 opened a new pull request, #21667:
URL: https://github.com/apache/pulsar/pull/21667
<!--
### Contribution Checklist
- PR title format should be *[type][component] summary*. For details, see
*[Guideline - Pulsar PR Naming
Convention](https://pulsar.apache.org/contribute/develop-semantic-title/)*.
- Fill out the template below to describe the changes contributed by the
pull request. That will give reviewers the context they need to do the review.
- Each pull request should address only one issue, not mix up code from
multiple issues.
- Each commit in the pull request has a meaningful commit message
- Once all items of the checklist are addressed, remove the above text and
this checklist, leaving only the filled out template below.
-->
<!-- Either this PR fixes an issue, -->
Fixes #16321
<!-- or this PR is one task of an issue -->
Main Issue: #xyz
<!-- If the PR belongs to a PIP, please add the PIP link here -->
PIP: #xyz
<!-- Details of when a PIP is required and how the PIP process work, please
see: https://github.com/apache/pulsar/blob/master/pip/README.md -->
### Motivation
The original PR is https://github.com/apache/pulsar/pull/18102, after
communicating with the author @xuesongxs, I opened a new PR to handle it.
I tested the Prometheus metric with 1000 topics and enabled the compression
to get 33x data saving.
```
# curl -H 'Accept-Encoding: gzip' -o kk0.log.gz
http://localhost:8080/metrics/
% Total % Received % Xferd Average Speed Time Time Time
Current
Dload Upload Total Spent Left Speed
100 927k 0 927k 0 0 1910k 0 --:--:-- --:--:-- --:--:--
1941k
# curl -o kk1.log http://localhost:8080/metrics/
% Total % Received % Xferd Average Speed Time Time Time
Current
Dload Upload Total Spent Left Speed
100 33.2M 0 33.2M 0 0 73.1M 0 --:--:-- --:--:-- --:--:--
74.4M
# ll -lrt |grep kk
-rw-r--r-- 1 hangc staff 928K Nov 28 18:46 kk0.log.gz
-rw-r--r-- 1 hangc staff 33M Nov 28 18:46 kk1.log
```
### Modifications
Add a new parameter to control whether to enable the Serverlet response
compression support or not. Even though enabling the response compression is
based on the client request header `Accept-Encoding: gzip`, it is a breaking
change for current Pulsar versions, and if this feature can't be disabled, the
user will be confused if they upgraded Pulsar to a new version but their
Prometheus server is still in an old version which can't disable the
compression request.
The feature will improve the metric cross-zone traffic a lot especially
Pulsar broker deployed on Cloud. We introduced a flag to control the feature,
so I think it is safe to cherry-pick it to the 3.0.x LTS versions.
### Verifying this change
- [ ] Make sure that the change passes the CI checks.
*(Please pick either of the following options)*
This change is a trivial rework / code cleanup without any test coverage.
*(or)*
This change is already covered by existing tests, such as *(please describe
tests)*.
*(or)*
This change added tests and can be verified as follows:
*(example:)*
- *Added integration tests for end-to-end deployment with large payloads
(10MB)*
- *Extended integration test for recovery after broker failure*
### Does this pull request potentially affect one of the following parts:
<!-- DO NOT REMOVE THIS SECTION. CHECK THE PROPER BOX ONLY. -->
*If the box was checked, please highlight the changes*
- [ ] Dependencies (add or upgrade a dependency)
- [ ] The public API
- [ ] The schema
- [ ] The default values of configurations
- [ ] The threading model
- [ ] The binary protocol
- [ ] The REST endpoints
- [ ] The admin CLI options
- [x] The metrics
- [ ] Anything that affects deployment
### Documentation
<!-- DO NOT REMOVE THIS SECTION. CHECK THE PROPER BOX ONLY. -->
- [ ] `doc` <!-- Your PR contains doc changes. -->
- [x] `doc-required` <!-- Your PR changes impact docs and you will update
later -->
- [ ] `doc-not-needed` <!-- Your PR changes do not impact docs -->
- [ ] `doc-complete` <!-- Docs have been already added -->
### Matching PR in forked repository
PR in forked repository: <!-- ENTER URL HERE -->
<!--
After opening this PR, the build in apache/pulsar will fail and instructions
will
be provided for opening a PR in the PR author's forked repository.
apache/pulsar pull requests should be first tested in your own fork since
the
apache/pulsar CI based on GitHub Actions has constrained resources and quota.
GitHub Actions provides separate quota for pull requests that are executed
in
a forked repository.
The tests will be run in the forked repository until all PR review comments
have
been handled, the tests pass and the PR is approved by a reviewer.
-->
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
