OpenSearch icon indicating copy to clipboard operation
OpenSearch copied to clipboard

Document GRPC settings and default values in README

Open karenyrx opened this issue 6 months ago • 6 comments

Description

Document how the GRPC settings should be used and add the missing grpc.netty.max_msg_size setting to the README. A corresponding PR in the documentation-webste repo will be created later on as well to reflect these changes.

Related Issues

https://github.com/opensearch-project/OpenSearch/issues/16787

Check List

  • [ ] Functionality includes testing.
  • [ ] API changes companion pull request created, if applicable.
  • [ ] Public documentation issue/PR created, if applicable.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license. For more information on following Developer Certificate of Origin and signing off your commits, please check here.

karenyrx avatar Jun 12 '25 18:06 karenyrx

Let me know if a changelog entry is required for this. Thanks!

karenyrx avatar Jun 12 '25 18:06 karenyrx

:x: Gradle check result for 23c2de6e7df22b1759519236733d147b1b8ee7c2: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

github-actions[bot] avatar Jun 12 '25 20:06 github-actions[bot]

:x: Gradle check result for 23c2de6e7df22b1759519236733d147b1b8ee7c2: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

github-actions[bot] avatar Jun 13 '25 17:06 github-actions[bot]

:white_check_mark: Gradle check result for 23c2de6e7df22b1759519236733d147b1b8ee7c2: SUCCESS

github-actions[bot] avatar Jun 13 '25 18:06 github-actions[bot]

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 72.79%. Comparing base (4d6f8ba) to head (23c2de6). Report is 39 commits behind head on main.

Additional details and impacted files
@@             Coverage Diff              @@
##               main   #18506      +/-   ##
============================================
+ Coverage     72.67%   72.79%   +0.12%     
- Complexity    67881    67967      +86     
============================================
  Files          5516     5516              
  Lines        312443   312443              
  Branches      45360    45360              
============================================
+ Hits         227067   227451     +384     
+ Misses        66893    66455     -438     
- Partials      18483    18537      +54     

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

:rocket: New features to boost your workflow:
  • :snowflake: Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

codecov[bot] avatar Jun 13 '25 18:06 codecov[bot]

Approved but asking @andrross @finnegancarroll to check as well.

Thanks.

peterzhuamazon avatar Jun 13 '25 19:06 peterzhuamazon