opensearch-project / opensearch-project/data-prepper
Remove PluginSettings from data-prepper-api
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 374
- Forks
- 354
- Avg merge
- 3d 18h
- Merged PRs (30d)
- 8
Description
Is your feature request related to a problem? Please describe.
Plugin authors should be using the pluginConfigurationType and use their own POJO models.
This approach should be preferred to using PluginSettings for plugin authors.
Describe the solution you'd like
I recommend that Data Prepper deprecate the PluginSettings class and migrate all existing plugins to use a POJO model for plugin configurations.
Path to completion:
- Add the
@Deprecatedannotation toPluginSettings. - #5246
- #4838
- In a breaking release (perhaps 3.0) move
PluginSettingsto data-prepper-core. - Any time after that we can refactor
PluginSettingswithin data-prepper-core without this being a breaking change.
Additional context
Some existing proposals will work best with use of the POJO model. A couple examples are #656 and #475.
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 PluginSettings class and the DataPrepperPlugin annotation's pluginConfigurationType reference in data-prepper-api. Review the existing plugin migrations linked in #5246 and #4838, then determine the scope for deprecation and the breaking-release move to data-prepper-core; completion follows the unchecked path-to-completion items.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- backend-api-design
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100