opensearch-project / opensearch-project/custom-codecs
[FEATURE] Add support for experimental codecs
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 14
- Forks
- 29
- Avg merge
- 3h 38m
- Merged PRs (30d)
- 7
Description
Is your feature request related to a problem?
Coming from https://github.com/opensearch-project/custom-codecs/pull/122#issuecomment-2109681404
Given custom-codecs plugin is out of sandbox, any new codecs introduced should get some bake time to be tried by users before it can be marked ready for production usage. We should add some setting to allow-list a codec to be generally available. Codecs like zstd have been existing for quite a few versions, and already have seen backward compatibility handled and working. As new codecs are added (e.g. qat based), it would be helpful to enable them for production usage only after they have been vetted through some community feedback as well.
What solution would you like?
Introduce a setting which allows a codec to be marked experimental, and enabled on demand.
What alternatives have you considered?
Introduce codecs in new sandboxed plugins
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
The issue does not name specific files, tests, or entry points. Start by locating codec registration and configuration in the custom-codecs repository, then determine how an experimental allow-list setting would affect codec availability. Done means new codecs can remain opt-in while vetted codecs stay generally available, with coverage for the setting behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- backend, performance
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100