opensearch-project / opensearch-project/data-prepper
Documentation update for Pattern Interface
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 374
- Forks
- 355
- Avg merge
- 3d 18h
- Merged PRs (30d)
- 8
Description
Description
In #6279, we identified vulnerabilities using the default java pattern library. For the fix, @dlvenable suggested a ServiceLoader implementation - we followed this approach in the PR but need to update the corresponding documentation to reflect how users can set the pattern library.
The Pattern is loaded in via reading the system property:
dataprepper.pattern.provider
Customers can set this property to "re2j" to leverage the Re2j library, or they can create new pattern provider implementations and commit it to the repo for use.
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
Search the documentation for the Pattern Interface and the system property dataprepper.pattern.provider. Update the relevant guidance to explain selecting re2j and using custom pattern provider implementations, then verify the documentation accurately reflects the ServiceLoader-based behavior described in the issue.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100