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

Better asciidoc formatting and text for ID option

Browse source 
Fixes #6679
This commit is contained in:
Suyog Rao 2017-02-09 11:36:13 -08:00
parent bdba81b199
commit 691179f719
2 changed files with 8 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

9
logstash-core/lib/logstash/plugin.rb
View file

@ -19,19 +19,20 @@ class LogStash::Plugin
# for a specific plugin. # for a specific plugin.
config :enable_metric, :validate => :boolean, :default => true config :enable_metric, :validate => :boolean, :default => true
# Add a unique `ID` to the plugin instance, this `ID` is used for tracking # Add a unique `ID` to the plugin configuration. If no ID is specified, Logstash will generate one.
# information for a specific configuration of the plugin. # It is strongly recommended to set this ID in your configuration. This is particulary useful
# when you have two or more plugins of the same type, for example, if you have 2 grok filters.
# Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs.
# #
# [source,ruby] # [source,ruby]
# --------------------------------------------------------------------------------------------------- # ---------------------------------------------------------------------------------------------------
# output { # output {
# stdout { # stdout {
# id => "ABC" # id => "my_plugin_id"
# } # }
# } # }
# --------------------------------------------------------------------------------------------------- # ---------------------------------------------------------------------------------------------------
# #
# If you don't explicitely set this variable Logstash will generate a unique name.
config :id, :validate => :string config :id, :validate => :string
def hash def hash

6
tools/logstash-docgen/templates/plugin-doc.asciidoc.erb
View file

@ -1,9 +1,9 @@
[[plugins-<%= section %>s-<%= name %>]] [[plugins-<%= section %>s-<%= name %>]]
=== <%= name %> === <%= name %>
Version: <%=version%> * Version: <%=version%>
Released on: <%=release_date%> * Released on: <%=release_date%>
<%=changelog_url%>[Changelog] * <%=changelog_url%>[Changelog]
<% unless default_plugin? %> <% unless default_plugin? %>
NOTE: This plugin does not ship with Logstash by default, but it is easy to install by running `bin/logstash-plugin install logstash-<%= section %>-<%= name %>`. NOTE: This plugin does not ship with Logstash by default, but it is easy to install by running `bin/logstash-plugin install logstash-<%= section %>-<%= name %>`.