opensearch-project / opensearch-project/data-prepper
Unified mechanism to reference elements within an Event from the pipeline configuration
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.
Users of Data Prepper should be able to reference or key off elements (fields & metadata) within an event in a unified way through pipeline configurations. Currently users can reference fields within an event like ${foo} and expressions reference fields via /foo. Additionally, there is no way to access metadata at this time.
Describe the solution you'd like
A unified standard for all plugins to follow and leverage for keying off of elements (fields & metadata) within pipeline configurations.
Additional context
I have also observed users attempting to access elements .foo even though this is not supported. There is likely an additional documentation gap.
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 by reviewing how pipeline configurations and plugins currently reference event fields with ${foo} and /foo. Determine the intended unified syntax, including metadata access and the unsupported .foo form; the work is done when the standard is defined for all plugins and the documentation gap is addressed.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- backend, data-engineering
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100