Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Introduces the experimental plugin feature #5318

Merged

Conversation

dlvenable
Copy link
Member

Description

Introduces the experimental plugin feature, allowing plugin developers to mark plugins as experimental.

This PR adds a new annotation @Experimental which can be applied to plugin types. When loading plugins, the plugin framework will now check whether the plugin is experimental or not. If the plugin is experimental, Data Prepper will fail if experimental plugins are not enabled. This PR also adds a new configuration in data-prepper-config.yaml to enable all experimental plugins if they are desired.

New configuration:

experimental:
  enable_all: true

Additionally, I refactored the code that logs deprecated plugin names into a consumer to help the overall code structure and fit the code design I took for checking for experimental plugins.

Issues Resolved

Resolves #2695

Check List

  • New functionality includes testing.
  • New functionality has a documentation issue. Please link to it in this PR.
    • New functionality has javadoc added
  • Commits are signed with a real name per the DCO

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

…s to mark plugins as experimental.

This PR adds a new annotation @experimental which can be applied to plugin types. When loading plugins, the plugin framework will now check whether the plugin is experimental or not. If the plugin is experimental, Data Prepper will fail if experimental plugins are not enabled. This PR also adds a new configuration in data-prepper-config.yaml to enable all experimental plugins if they are desired.

Additionally, I refactored the code that logs deprecated plugin names into a consumer to help the overall code structure and fit the code design I took for checking for experimental plugins.

Resolves opensearch-project#2695

Signed-off-by: David Venable <[email protected]>
@dlvenable dlvenable force-pushed the 2695-experimental-plugins branch from 0f246ee to 0bb02eb Compare January 9, 2025 18:26
Copy link
Collaborator

@san81 san81 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for adding this. This is a really clean separation! Let just a minor comment.

@@ -0,0 +1,26 @@
/*
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Newly added files could use the new copyright message

/*
 * Copyright OpenSearch Contributors
 * SPDX-License-Identifier: Apache-2.0
 *
 * The OpenSearch Contributors require contributions made to
 * this file be licensed under the Apache-2.0 license or a
 * compatible open source license.
 *
*/

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@san81 , Thank you for catching this. I have updated all the new files with this header.

@dlvenable dlvenable merged commit b13a645 into opensearch-project:main Jan 15, 2025
45 of 47 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add experimental feature concept
3 participants