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

More asciidoc fixes for base input and output

Browse source 
Fixes #2038
This commit is contained in:
Suyog Rao 2014-11-07 14:20:26 -08:00 • committed by Jordan Sissel
parent 24d03b4bce
commit c3f2f94cad
2 changed files with 11 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

20
lib/logstash/inputs/base.rb
View file

@ -11,7 +11,7 @@ class LogStash::Inputs::Base < LogStash::Plugin
include LogStash::Config::Mixin
config_name "input"
# Add a 'type' field to all events handled by this input.
# Add a `type` field to all events handled by this input.
#
# Types are used mainly for filter activation.
#
@ -33,20 +33,20 @@ class LogStash::Inputs::Base < LogStash::Plugin
# The codec used for input data. Input codecs are a convenient method for decoding your data before it enters the input, without needing a separate filter in your Logstash pipeline.
config :codec, :validate => :codec, :default => "plain"
# The character encoding used in this input. Examples include "UTF-8"
# and "cp1252"
# The character encoding used in this input. Examples include `UTF-8`
# and `cp1252`
#
# This setting is useful if your log files are in Latin-1 (aka cp1252)
# or in another character set other than UTF-8.
# This setting is useful if your log files are in `Latin-1` (aka `cp1252`)
# or in another character set other than `UTF-8`.
#
# This only affects "plain" format logs since json is UTF-8 already.
# This only affects "plain" format logs since json is `UTF-8` already.
config :charset, :validate => ::Encoding.name_list, :deprecated => true
# If format is "json", an event sprintf string to build what
# the display @message should be given (defaults to the raw JSON).
# sprintf format strings look like %{fieldname}
# If format is `json`, an event `sprintf` string to build what
# the display `@message` should be given (defaults to the raw JSON).
# `sprintf` format strings look like `%{fieldname}`
#
# If format is "json_event", ALL fields except for @type
# If format is `json_event`, ALL fields except for `@type`
# are expected to be present. Not receiving all fields
# will cause unexpected results.
config :message_format, :validate => :string, :deprecated => true

2
lib/logstash/outputs/base.rb
View file

@ -13,7 +13,7 @@ class LogStash::Outputs::Base < LogStash::Plugin
config_name "output"
# The type to act on. If a type is given, then this output will only
# act on messages with the same type. See any input plugin's "type"
# act on messages with the same type. See any input plugin's `type`
# attribute for more.
# Optional.
config :type, :validate => :string, :default => "", :deprecated => "You can achieve this same behavior with the new conditionals, like: `if [type] == \"sometype\" { %PLUGIN% { ... } }`."