github-mirrors/logstash
1
0
Fork 0
mirror of https://github.com/elastic/logstash.git synced 2025-04-24 06:37:19 -04:00
Code Issues Projects Releases Packages Wiki Activity

Update version info shown in doc for building LS plugins

Browse source 
Fixes #6206
This commit is contained in:
DeDe Morton 2016-11-03 17:38:11 -07:00
parent ec5f8712b0
commit 9cad323e70
2 changed files with 8 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

6
docs/static/contributing-to-logstash.asciidoc vendored
View file

@ -24,9 +24,9 @@ deploying your own plugins:
* <<submitting-plugin,Submitting a Plugin>>
[float]
==== Plugin API Changes added[2.0]
==== Plugin Shutdown APIs
The 2.0 release of Logstash changes how input plugins shut down to increase shutdown reliability. There are three methods
Starting in Logstash 2.0, we changed 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.
@ -37,7 +37,7 @@ exit. The `close` method is a a new name for the method known as `teardown` in p
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].
Sample code for the plugin shutdown APIs is https://github.com/logstash-plugins/logstash-input-example/blob/master/lib/logstash/inputs/example.rb[available].
[float]
=== Extending Logstash core

10
docs/static/include/pluginbody.asciidoc vendored
View file

@ -851,7 +851,7 @@ Gem::Specification.new do |s|
s.metadata = { "logstash_plugin" => "true", "logstash_group" => "{plugintype}" }
# Gem dependencies
s.add_runtime_dependency 'logstash-core', '>= 1.4.0', '< 2.0.0'
s.add_runtime_dependency 'logstash-core', '>= 5.0.0', '< 6.0.0'
s.add_development_dependency 'logstash-devutils'
end
----------------------------------
@ -909,12 +909,12 @@ Logstash plugins:
[subs="attributes"]
----------------------------------
# Gem dependencies
s.add_runtime_dependency 'logstash-core', '>= 1.4.0', '< 2.0.0'
s.add_runtime_dependency 'logstash-core', '>= 5.0.0', '< 6.0.0'
s.add_development_dependency 'logstash-devutils'
----------------------------------
This gemspec has a runtime dependency on the core Logstash gem and requires that
it have a version number greater than or equal to version 1.4.0 `'>= 1.4.0'`,
and less than version 2.0 `'< 2.0.0'`.
it have a version number greater than or equal to version 5.0.0 `'>= 5.0.0'`,
and less than version 6.0 `'< 6.0.0'`.
=========================
@ -932,7 +932,7 @@ added in the gemspec file in this manner:
[subs="attributes"]
----------------------------------
# Jar dependencies
s.requirements << "jar 'org.elasticsearch:elasticsearch', '1.4.0'"
s.requirements << "jar 'org.elasticsearch:elasticsearch', '5.0.0'"
s.add_runtime_dependency 'jar-dependencies'
----------------------------------