Contributing a Java Plugin

This functionality is in beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features.

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 including:

  • 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.
  • Coming in a future release: Tooling to automate the packaging and deployment of Java plugins in Logstash. (Currently, this process is manual.)

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: