Skip to content

plugin_development.md

Latest commit

 

History

History
97 lines (64 loc) · 3.56 KB

plugin_development.md

File metadata and controls

97 lines (64 loc) · 3.56 KB

Plugin Development

Data Prepper supports plugins. All sources, buffers, and processors are created as Data Prepper plugins.

Plugin Requirements

Plugins are created as Java classes. They must conform to the following.

  • The class must be annotated with @DataPrepperPlugin
  • The class must be in the org.opensearch.dataprepper.plugins package
  • The class must implement the required interface
  • The class must have a valid constructor (see below)

Plugin Constructors

The preferred way to create a plugin constructor is to choose a single constructor and annotate it with @DataPrepperConstructor. The constructor can only take in class types which are supported by the plugin framework.

The plugin framework can inject the following types into this constructor:

  • An instance of the plugin configuration class type as defined by DataPrepperPlugin::pluginConfigurationType. The plugin framework will deserialize this type from the Pipeline configuration and supply it in the constructor if requested.
  • An instance of PluginMetrics.
  • An instance of PluginSetting.

If your plugin requires no arguments, it can use a default constructor which will be chosen instead.

Additionally, the plugin framework can create a plugin using a single parameter constructor with a single parameter of type PluginSetting. This behavior is deprecated and planned for removal.

Maven artifacts

If you are developing a plugin in another Gradle project your project will depend on at least the data-prepper-api project. The Data Prepper maintainers publish Data Prepper libraries to Maven Central.

All Maven artifacts are published to the org.opensearch.dataprepper group id.

org.opensearch.dataprepper:data-prepper-api:2.13.0

As a plugin developer, you should also consider using org.opensearch.dataprepper.test:plugin-test-framework to test your plugin.

For example, to use in Gradle:

dependencies {
    implementation 'org.opensearch.dataprepper:data-prepper-api:2.13.0'
    testImplementation 'org.opensearch.dataprepper.test:plugin-test-framework:2.13.0'
}

Browse using Maven Central:

Nightly snapshots

Data Prepper Maven artifacts release nightly snapshot builds.

The OpenSearch project has a browsable web interface. You can view Data Prepper snapshots.

The Maven repository is:

  • https://central.sonatype.com/repository/maven-snapshots

For example, to use in Gradle:

repositories {
    // Other repositories such as mavenCentral()
    maven {
        name = "Snapshots"
        url = "https://central.sonatype.com/repository/maven-snapshots"
    }
}

Deploying Maven artifacts from local

You can deploy Data Prepper artifacts locally so that you can add add any local changes as a dependency in your plugin project.

From the Data Prepper repository, run the following command:

./gradlew publishToMavenLocal

The Maven artifacts will then be available in your local Maven repository. In standard environments they will be available at ${USER}/.m2/repository/org/opensearch/dataprepper/.

Be sure to enable mavenLocal() as a repository in your plugin's build project.

Other documentation for plugin developers