You can add your own input, codec, filter, or output plugins to Logstash.
Start with the end in mind. These guidelines and best practices can help you build a better plugin, even if you choose not to share it with the world.
-
Consistency. Your plugin must be consistent in quality and naming conventions used by other plugins.
The plugin name must be unique and in this format:
logstash-plugintype-pluginname. If the plugin name is more than one word, separate words after plugin type with underscores. Example: logstash-output-elastic_app_search - Documentation. Documentation is a required component of your plugin. If we list your plugin in the Logstash Reference, we point to your documentation—a readme.md, docs/index.asciidoc, or both—in your plugin repo.
- Code Review. Your plugin must be reviewed by members of the community for coherence, quality, readability, stability and security.
-
Tests. Your plugin must contain tests to be accepted. You can refer to http://betterspecs.org/ for examples.
- Step 1. Enable travis on your account
- Step 2. Import our standard travis.yml https://github.com/logstash-plugins/.ci/blob/1.x/travis/travis.yml, as shown in the fingerprint filter example.
- Step 3. Have specs in the spec folder.
Plugins can be developed and deployed independently of the Logstash core. Here are some documents to guide you through the process of coding, deploying, and sharing your plugin:
-
Write a new plugin
- Document your plugin
- Publish your plugin to RubyGems.org
- List your plugin
-
Contribute a patch
You have three options for shutting down a plugin: stop, stop?, and close.
-
Call the
stopmethod from outside the plugin thread. This method signals the plugin to stop. -
The
stop?method returnstruewhen thestopmethod has already been called for that plugin. -
The
closemethod performs final bookkeeping and cleanup after the plugin’srunmethod and the plugin’s thread both exit. Theclosemethod is a a new name for the method known asteardownin previous versions of Logstash.
The shutdown, finished, finished?, running?, and terminating? methods are redundant and no longer present in the
Plugin Base class.
Sample code for the plugin shutdown APIs is available.