OpenSearch SDK for Java

Extension Documentation

OpenSearch Logo

opensearch-sdk-java repository

OpenSearch user documentation

codecov GHA gradle check GHA validate pull request

OpenSearch SDK for Java

To view extension documentation as a webpage, go to


With OpenSearch plugins, you can extend and enhance various core features. However, the current plugin architecture may fatally impact clusters in the event of failure. To ensure that plugins run safely without impacting the system, our goal is to isolate plugin interactions with OpenSearch. The OpenSearch SDK for Java modularizes the extension points onto which plugins hook.

For more information about extensibility, see this GitHub issue.


For an overview of extension architecture and information about how extensions work, see DESIGN.

Creating an extension

For information about developing an extension, see CREATE_YOUR_FIRST_EXTENSION.

Developer Guide

For instructions on building, testing, and running an extension, see the DEVELOPER_GUIDE.

Plugin migration

For tips on migrating an existing plugin to an extension, see PLUGIN_MIGRATION.


For information about contributing, see CONTRIBUTING.


For points of contact, see MAINTAINERS.

Code of Conduct

This project has adopted the Amazon Open Source Code of Conduct. For more information see the Code of Conduct FAQ, or contact with any additional questions or comments.