mirror of
https://github.com/elastic/logstash.git
synced 2025-04-25 07:07:54 -04:00
48 lines
2.4 KiB
Text
48 lines
2.4 KiB
Text
[[contributing-to-logstash]]
|
|
== Contributing to Logstash
|
|
|
|
Before version 1.5, Logstash included all plugins in each release. This made it
|
|
easy to make use of any plugin, but it complicated plugin development--a new
|
|
release of Logstash became necessary if a plugin needed patching. Since version
|
|
1.5, all plugins are independent of the Logstash core. Now you can add your own
|
|
input, codec, filter, or output plugins to Logstash much more easily!
|
|
|
|
[float]
|
|
=== Adding plugins
|
|
|
|
Since plugins can now be developed and deployed independently of the Logstash
|
|
core, there are documents which guide you through the process of coding and
|
|
deploying your own plugins:
|
|
|
|
* http://www.elasticsearch.org/guide/en/logstash/current/_how_to_write_a_logstash_input_plugin.html[How to write a Logstash input plugin]
|
|
* http://www.elasticsearch.org/guide/en/logstash/current/_how_to_write_a_logstash_codec_plugin.html[How to write a Logstash codec plugin]
|
|
* http://www.elasticsearch.org/guide/en/logstash/current/_how_to_write_a_logstash_filter_plugin.html[How to write a Logstash filter plugin]
|
|
* http://www.elasticsearch.org/guide/en/logstash/current/_how_to_write_a_logstash_output_plugin.html[How to write a Logstash output plugin]
|
|
|
|
[float]
|
|
==== Plugin API Changes added[2.0]
|
|
|
|
The 2.0 release of Logstash changes how input plugins shut down to increase shutdown reliability. There are three methods
|
|
for plugin shutdown: `stop`, `stop?`, and `close`.
|
|
|
|
* Call the `stop` method from outside the plugin thread. This method signals the plugin to stop.
|
|
* The `stop?` method returns `true` when the `stop` method has already been called for that plugin.
|
|
* The `close` method performs final bookkeeping and cleanup after the plugin's `run` method and the plugin's thread both
|
|
exit. The `close` method is a a new name for the method known as `teardown` in 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 new plugin shutdown APIs is https://github.com/logstash-plugins/logstash-input-example/blob/master/lib/logstash/inputs/example.rb[available].
|
|
|
|
|
|
[float]
|
|
=== Extending Logstash core
|
|
|
|
We also welcome contributions and bug fixes to the Logstash core feature set.
|
|
|
|
Please read through our
|
|
https://github.com/elastic/logstash/blob/master/CONTRIBUTING.md[contribution]
|
|
guide, and the Logstash
|
|
https://github.com/elastic/logstash/blob/master/README.md[readme]
|
|
document.
|