- update docs

lib/logstash/inputs/amqp.rb

@@ -3,8 +3,9 @@ require "logstash/namespace"
 
 # Pull events from an AMQP exchange.
 #
-# 
-# TODO(sissel): Document where to learn more about AMQP and brokers.
+# AMQP is a messaging system. It requires you to run an AMQP server or 'broker'
+# Examples of AMQP servers are [RabbitMQ](http://www.rabbitmq.com/) and 
+# [QPid](http://qpid.apache.org/)
 class LogStash::Inputs::Amqp < LogStash::Inputs::Base
   MQTYPES = [ "fanout", "direct", "topic" ]
 

lib/logstash/inputs/base.rb

@@ -11,6 +11,13 @@ class LogStash::Inputs::Base < LogStash::Plugin
   config_name "input"
 
   # Label this input with a type.
+  # Types are used mainly for filter activation.
+  #
+  # If you create an input with type "foobar", then only filters
+  # which also have type "foobar" will act on them.
+  #
+  # The type is also stored as part of the event itself, so you
+  # can also use the type to search for in the web interface.
   config :type, :validate => :string, :required => true
 
   # Set this to true to enable debugging on an input.

lib/logstash/inputs/redis.rb

@@ -1,7 +1,8 @@
 require "logstash/inputs/base"
 require "logstash/namespace"
 
-# Read events from a redis using BLPOP
+# Read events from a redis. Supports both redis channels and also redis lists
+# (using BLPOP)
 #
 # For more information about redis, see <http://redis.io/>
 class LogStash::Inputs::Redis < LogStash::Inputs::Base

lib/logstash/inputs/syslog.rb

@@ -10,13 +10,16 @@ require "socket"
 # It is also a good choice if you want to receive logs from
 # appliances and network devices where you cannot run your own
 # log collector.
+#
+# Note: this input will start listeners on both TCP and UDP
 class LogStash::Inputs::Syslog < LogStash::Inputs::Base
   config_name "syslog"
 
   # The address to listen on
   config :host, :validate => :string, :default => "0.0.0.0"
 
-  # The port to listen on
+  # The port to listen on. Remember that ports less than 1024 (privileged
+  # ports) may require root to use.
   config :port, :validate => :number, :default => 514
 
   public

lib/logstash/inputs/twitter.rb

@@ -4,6 +4,7 @@ require "net/http"
 require "json"
 #require "net/https"
 
+# Read events from the twitter streaming api.
 class LogStash::Inputs::Twitter < LogStash::Inputs::Base
 
   config_name "twitter"