opensearch-project / opensearch-project/data-prepper

Configuration Consistency

Open
#291 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

backlog breaking change ease-of-use
Dominant language
Java
Stars
374
Forks
355
Avg merge
3d 18h
Merged PRs (30d)
8

Description

Is your feature request related to a problem? Please describe.

Data Prepper configuration names inconsistently use snake_case or lowerCamelCase. Configuring Data Prepper is clearer when the naming convention is consistent.

Describe the solution you'd like

Most importantly Data Prepper should have a consistent naming convention for configuration names. The standard we are proposing is snake_case. This convention is used by most of the existing properties. Thus, users will have fewer properties to reconfigure.

Data Prepper will need to:

  • Have documentation clearly stating the standard.
  • Provide a migration for names which are not in compliance. The first part of this migration is adding snake_case properties for each camelCase property. The existing camelCase properties will remain as deprecated properties. The next major release of Data Prepper will remove the cameCase versions.

Tasks

  • #2184
  • #2202
  • #2203

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 reviewing the remaining task #2202 and the completed tasks #2184 and #2203 to understand the configuration-consistency work already covered. Identify the remaining camelCase configuration names and the documentation and migration scope. Done means the naming standard is documented, compliant snake_case properties are available, and the old names are deprecated.

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
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.