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

Merge pull request #744 from dpb587/patch-1

Browse source 
Fix a few typos and make docs a bit more readable.
This commit is contained in:
Nick Ethier 2013-11-22 12:09:42 -08:00
commit 41d7a41277
4 changed files with 16 additions and 16 deletions
Download patch file Download diff file Expand all files Collapse all files

6
lib/logstash/filters/csv.rb
View file

@ -21,16 +21,16 @@ class LogStash::Filters::CSV < LogStash::Filters::Base
config :columns, :validate => :array, :default => [] config :columns, :validate => :array, :default => []
# Define the column separator value. If this is not specified the default # Define the column separator value. If this is not specified the default
# is a comma ',' # is a comma ','.
# Optional. # Optional.
config :separator, :validate => :string, :default => "," config :separator, :validate => :string, :default => ","
# Define the character used to quote CSV fields. If this is not specified # Define the character used to quote CSV fields. If this is not specified
# the default is a double quote '"' # the default is a double quote '"'.
# Optional. # Optional.
config :quote_char, :validate => :string, :default => '"' config :quote_char, :validate => :string, :default => '"'
# Define target for placing the data # Define target for placing the data.
# Defaults to writing to the root of the event. # Defaults to writing to the root of the event.
config :target, :validate => :string config :target, :validate => :string

6
lib/logstash/filters/date.rb
View file

@ -28,13 +28,13 @@ class LogStash::Filters::Date < LogStash::Filters::Base
config_name "date" config_name "date"
milestone 3 milestone 3
# specify a timezone canonical ID to be used for date parsing. # Specify a timezone canonical ID to be used for date parsing.
# The valid ID are listed on http://joda-time.sourceforge.net/timezones.html # The valid ID are listed on http://joda-time.sourceforge.net/timezones.html
# Useful in case the timezone cannot be extracted from the value, # Useful in case the timezone cannot be extracted from the value,
# and is not the platform default # and is not the platform default.
# If this is not specified the platform default will be used. # If this is not specified the platform default will be used.
# Canonical ID is good as it takes care of daylight saving time for you # Canonical ID is good as it takes care of daylight saving time for you
# For example, America/Los_Angeles or Europe/France are valid IDs # For example, America/Los_Angeles or Europe/France are valid IDs.
config :timezone, :validate => :string config :timezone, :validate => :string
# specify a locale to be used for date parsing. If this is not specified the # specify a locale to be used for date parsing. If this is not specified the

6
lib/logstash/filters/mutate.rb
View file

@ -76,14 +76,14 @@ class LogStash::Filters::Mutate < LogStash::Filters::Base
config :convert, :validate => :hash config :convert, :validate => :hash
# Convert a string field by applying a regular expression and a replacement # Convert a string field by applying a regular expression and a replacement
# if the field is not a string, no action will be taken # if the field is not a string, no action will be taken.
# #
# This configuration takes an array consisting of 3 elements per # This configuration takes an array consisting of 3 elements per
# field/substitution. # field/substitution.
# #
# be aware of escaping any backslash in the config file # Be aware of escaping any backslash in the config file.
# #
# for example: # Example:
# #
# filter { # filter {
# mutate { # mutate {

14
lib/logstash/filters/range.rb
View file

@ -7,17 +7,17 @@ require "logstash/namespace"
# Numbers are checked to be within numeric value range. # Numbers are checked to be within numeric value range.
# Strings are checked to be within string length range. # Strings are checked to be within string length range.
# More than one range can be specified for same fieldname, actions will be applied incrementally. # More than one range can be specified for same fieldname, actions will be applied incrementally.
# Then field value is with in a specified range and action will be taken # When field value is within a specified range an action will be taken.
# supported actions are drop event add tag or add field with specified value. # Supported actions are drop event, add tag, or add field with specified value.
# #
# Example usecases are for histogram like tagging of events # Example use cases are for histogram-like tagging of events
# or for finding anomaly values in fields or too big events that should be dropped. # or for finding anomaly values in fields or too big events that should be dropped.
class LogStash::Filters::Range < LogStash::Filters::Base class LogStash::Filters::Range < LogStash::Filters::Base
config_name "range" config_name "range"
milestone 1 milestone 1
# An array of field, min, max ,action tuples. # An array of field, min, max, action tuples.
# Example: # Example:
# #
# filter { # filter {
@ -29,8 +29,8 @@ class LogStash::Filters::Range < LogStash::Filters::Base
# "duration", 0, 100, "field:latency:fast", # "duration", 0, 100, "field:latency:fast",
# "duration", 101, 200, "field:latency:normal", # "duration", 101, 200, "field:latency:normal",
# "duration", 201, 1000, "field:latency:slow", # "duration", 201, 1000, "field:latency:slow",
# "duration", 1001, 1e1000, "field:latency:outlier" # "duration", 1001, 1e1000, "field:latency:outlier",
# "requests", 0, 10, "tag:to_few_%{host}_requests" ] # "requests", 0, 10, "tag:too_few_%{host}_requests" ]
# } # }
# } # }
# #
@ -41,7 +41,7 @@ class LogStash::Filters::Range < LogStash::Filters::Base
# TODO(piavlo): simple not nested hashses as values in addition to numaric and string values to prettify the syntax. # TODO(piavlo): simple not nested hashses as values in addition to numaric and string values to prettify the syntax.
config :ranges, :validate => :array, :default => [] config :ranges, :validate => :array, :default => []
# Negate the range match logic, events should be outsize of the specificed range to match. # Negate the range match logic, events should be outsize of the specified range to match.
config :negate, :validate => :boolean, :default => false config :negate, :validate => :boolean, :default => false
public public