opensearch-project / opensearch-project/data-prepper

Centralizing Plugin Conversion with Plugin Code

Open
#1,066 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

backlog enhancement
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.
Building plugins requires defining components of a plugin (core feature, logstash mapping) in multiple parts of the code base.

Users build their plugins in their specific plugin module in the data-prepper-plugins package. Here they implement the interface (source, prepper, sink) for the plugin type they are developing and define the configuration. To support Logstash conversion, plugin authors must create a separate classes in a separate module in the data-prepper-logstash-configuration package. This current approach scatters plugin concepts across the code base.

Describe the solution you'd like
Ideally, as a plugin author I would like to define my mapping and implementation details in the same package.

Describe alternatives you've considered (Optional)
I am open to alternatives...

Additional context
I think this is an important feature to consider as we build support for the community to bring their own plugins.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by comparing plugin implementations and configuration in data-prepper-plugins with the mapping classes in data-prepper-logstash-configuration/src/main/java/org/opensearch/dataprepper/logstash/mapping. Define the integration approach before changing code; done means plugin authors can keep implementation and Logstash mapping details in the same plugin package without scattering those concepts across modules.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
backend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.