[DOC] Documentation Gap: Missing http.compression Parameter Reference

[c-neto]

Issue Description

• Request a change to existing documentation
• Add new documentation
• Report a technical problem with the documentation

---

The http.compression option is not currently documented in the OpenSearch reference, specifically in the 🔗 Install and Configure » Configuring OpenSearch » Network Settings » Advanced HTTP Settings section. However, there is evidence of its presence in the OpenSearch node startup log, as highlighted below:

...
[2023-06-05T10:10:08,986][INFO ][o.o.p.PluginsService     ] [os-manager-node2] loaded plugin [opensearch-security-analytics]
[2023-06-05T10:10:08,986][INFO ][o.o.p.PluginsService     ] [os-manager-node2] loaded plugin [opensearch-sql]
+ [2023-06-05T10:10:09,021][INFO ][o.o.s.OpenSearchSecurityPlugin] [os-manager-node2] Disabled https compression by default to mitigate BREACH attacks. You can enable it by setting 'http.compression: true' in opensearch.yml
[2023-06-05T10:10:09,059][INFO ][o.o.e.NodeEnvironment    ] [os-manager-node2] using [1] data paths, mounts [[/usr/share/opensearch/data (/dev/sdc2)]], net usable_space [174.7gb], net total_space [199.8gb], types [xfs]
[2023-06-05T10:10:09,059][INFO ][o.o.e.NodeEnvironment    ] [os-manager-node2] heap size [512mb], compressed ordinary object pointers [true]
...

The absence of this parameter in the official documentation raises a question about its existence or if there might be a documentation gap.

Field References

I found the http.compression parameter behavior documented in the AWS OpenSearch Service and Elasticsearch in the following links:

• AWS OpenSearch Service: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/gzip.html#gzip-enable
• Elasticsearch: https://www.elastic.co/guide/en/elasticsearch/reference/8.11/modules-network.html#http-settings

Clarification Required

I would appreciate clarification regarding the inclusion of the http.compression parameter in OpenSearch documentation. Please confirm whether its absence is intentional or if it is specific to the AWS OpenSearch Service.

Proposed Action

I am willing to create a Pull Request to add the http.compression documentation. I plan to base the documentation on the descriptions provided in the Elasticsearch and AWS OpenSearch Service references. However, if the parameter is not a part of OpenSearch, please disregard the PR.

Your guidance on this matter would be greatly appreciated. Thank you!

[c-neto]

PR Created!

As mentioned in the Issue description, I created the PR with the documentation of the field http.compression.

PR Link: #6051