opensearch-project / opensearch-project/opensearch-java
[FEATURE] Provide an example of HA client configuration
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 165
- Forks
- 250
- Avg merge
- 1d 18h
- Merged PRs (30d)
- 26
Description
Is your feature request related to a problem?
During an OpenSearch cluster upgrade the client might go unresponsive from various low-level reasons - cache ignoring the DNS switch, opened TCP connections becoming stale for long time, etc.
This is a problem mainly in HA environments.
What solution would you like?
Adding a "HA config" example snippet to Java client | OpenSearch Documentation
What alternatives have you considered?
Creating a minimal working code example directly in the repo.
Do you have any additional context?
Apache HC5 provides a vast array of low-level configuration options but having an official recommendation would make things clear.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the Java client documentation page linked in the issue and review the Apache HC5 configuration options relevant to HA upgrades. Determine whether the contribution belongs as a documentation snippet or a minimal working repository example; it is done when an official HA configuration example is provided and its scope is clear.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100