Create Logstash plugins [contributing-java-plugin]

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

Native support for Java plugins in {{ls}} 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 [_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 [_lets_get_started]

Here are the example repos:

• Input plugin example
• Codec plugin example
• Filter plugin example
• Output plugin example

Here are the instructions:

• How to write a Java input plugin
• How to write a Java codec plugin
• How to write a Java filter plugin
• How to write a Java output plugin