This documentation contains work-in-progress information for future Elastic Stack and Cloud releases. Use the version selector to view supported release docs. It also contains some Elastic Cloud serverless information. Check out our serverless docs for more details.
« Extending Logstash core How to write a Java input plugin »
Elastic Docs ›Logstash Reference [8.16]

Contributing a Java Plugin

Contributing a Java Plugin

Now you can write your own Java plugin for use with Logstash. We have provided instructions and GitHub examples to give you a head start.

Native support for Java plugins in Logstash consists of several components:

  • Extensions to the Java execution engine to support running Java plugins in Logstash pipelines
  • APIs for developing Java plugins. The APIs are in the co.elastic.logstash.api package. A Java plugin might break if it references classes or specific concrete implementations of API interfaces outside that package. The implementation of classes outside of the API package may change at any time.
  • Tooling to automate the packaging and deployment of Java plugins in Logstash.

Process overview

Here are the steps:

  1. Choose the type of plugin you want to create: input, codec, filter, or output.
  2. Set up your environment.
  3. Code the plugin.
  4. Package and deploy the plugin.
  5. Run Logstash with your new plugin.

Let’s get started

Here are the example repos:

Here are the instructions:

« Extending Logstash core How to write a Java input plugin »