Redis input docs

This commit is contained in:
Bob Corsaro 2011-05-10 06:07:51 -04:00
parent f8dce8d5df
commit c2c04998d7

View file

@ -1,33 +1,32 @@
require "logstash/inputs/base"
require "logstash/namespace"
# read events from a redis using BLPOP
# Read events from a redis using BLPOP
#
# For more information about redis, see <http://redis.io/>
class LogStash::Inputs::Redis < LogStash::Inputs::Base
config_name "redis"
# name is used for logging in case there are multiple instances
# Name is used for logging in case there are multiple instances.
config :name, :validate => :string, :default => "default"
# the hostname of your redis server
config :host, :validate => :string, :default => "localhost"
# The hostname of your redis server. Default hostname is 127.0.0.1.
config :host, :validate => :string
# the port to connect on (optional)
# The port to connect on. The default port is 6379.
config :port, :validate => :number
# The redis database number
# The redis database number. Db is 0 by default.
config :db, :validate => :number
# Timeout of some kind? This isn't really documented in the Redis rubygem
# docs...
# Initial connection timeout in seconds. Default timeout is 5 seconds.
config :timeout, :validate => :number
# Password to authenticate with
# Password to authenticate with. There is no authentication by default.
config :password, :validate => :password
# The name of the redis queue (we'll use BLPOP against this)
# The name of the redis queue (we'll use BLPOP against this).
config :queue, :validate => :string, :required => true
# Maximum number of retries on a read before we give up.