Add support for Redis unix sockets (#64)

* Add support for Redis unix sockets
* Make `path` and `host` mutually exclusive
* Add documentation updates

Author: brennentsmith

docs/index.asciidoc

@@ -45,6 +45,7 @@ This plugin supports the following configuration options plus the <<plugins-{typ
 | <<plugins-{type}s-{plugin}-data_type>> |<<string,string>>, one of `["list", "channel", "pattern_channel"]`|Yes
 | <<plugins-{type}s-{plugin}-db>> |<<number,number>>|No
 | <<plugins-{type}s-{plugin}-host>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-path>> |<<string,string>>|No
 | <<plugins-{type}s-{plugin}-key>> |<<string,string>>|Yes
 | <<plugins-{type}s-{plugin}-password>> |<<password,password>>|No
 | <<plugins-{type}s-{plugin}-port>> |<<number,number>>|No
@@ -58,15 +59,15 @@ input plugins.
 &nbsp;
 
 [id="plugins-{type}s-{plugin}-batch_count"]
-===== `batch_count` 
+===== `batch_count`
 
   * Value type is <<number,number>>
   * Default value is `125`
 
 The number of events to return from Redis using EVAL.
 
 [id="plugins-{type}s-{plugin}-data_type"]
-===== `data_type` 
+===== `data_type`
 
   * This is a required setting.
   * Value can be any of: `list`, `channel`, `pattern_channel`
@@ -77,23 +78,32 @@ key.  If `redis\_type` is `channel`, then we will SUBSCRIBE to the key.
 If `redis\_type` is `pattern_channel`, then we will PSUBSCRIBE to the key.
 
 [id="plugins-{type}s-{plugin}-db"]
-===== `db` 
+===== `db`
 
   * Value type is <<number,number>>
   * Default value is `0`
 
 The Redis database number.
 
 [id="plugins-{type}s-{plugin}-host"]
-===== `host` 
+===== `host`
 
   * Value type is <<string,string>>
   * Default value is `"127.0.0.1"`
 
 The hostname of your Redis server.
 
+id="plugins-{type}s-{plugin}-path"]
+===== `path`
+
+  * Value type is <<string,string>>
+  * There is no default value for this setting.
+  * Path will override Host configuration if both specified.
+
+The unix socket path of your Redis server.
+
 [id="plugins-{type}s-{plugin}-key"]
-===== `key` 
+===== `key`
 
   * This is a required setting.
   * Value type is <<string,string>>
@@ -102,31 +112,31 @@ The hostname of your Redis server.
 The name of a Redis list or channel.
 
 [id="plugins-{type}s-{plugin}-password"]
-===== `password` 
+===== `password`
 
   * Value type is <<password,password>>
   * There is no default value for this setting.
 
 Password to authenticate with. There is no authentication by default.
 
 [id="plugins-{type}s-{plugin}-port"]
-===== `port` 
+===== `port`
 
   * Value type is <<number,number>>
   * Default value is `6379`
 
 The port to connect on.
 
 [id="plugins-{type}s-{plugin}-threads"]
-===== `threads` 
+===== `threads`
 
   * Value type is <<number,number>>
   * Default value is `1`
 
 
 
 [id="plugins-{type}s-{plugin}-timeout"]
-===== `timeout` 
+===== `timeout`
 
   * Value type is <<number,number>>
   * Default value is `5`
@@ -136,4 +146,4 @@ Initial connection timeout in seconds.
 
 
 [id="plugins-{type}s-{plugin}-common-options"]
-include::{include_path}/{type}.asciidoc[]
+include::{include_path}/{type}.asciidoc[]

lib/logstash/inputs/redis.rb

@@ -29,6 +29,10 @@ module LogStash module Inputs class Redis < LogStash::Inputs::Threadable
   # The port to connect on.
   config :port, :validate => :number, :default => 6379
 
+  # The unix socket path to connect on. Will override host and port if defined.
+  # There is no unix socket path by default.
+  config :path, :validate => :string
+
   # The Redis database number.
   config :db, :validate => :number, :default => 0
 
@@ -68,7 +72,7 @@ def new_redis_instance
   end
 
   def register
-    @redis_url = "redis://#{@password}@#{@host}:#{@port}/#{@db}"
+    @redis_url = @path.nil? ? "redis://#{@password}@#{@host}:#{@port}/#{@db}" : "#{@password}@#{@path}/#{@db}"
 
     @redis_builder ||= method(:internal_redis_builder)
 
@@ -114,13 +118,25 @@ def is_list_type?
 
   # private
   def redis_params
-    {
-      :host => @host,
-      :port => @port,
+    if @path.nil?
+      connectionParams = {
+        :host => @host,
+        :port => @port
+      }
+    else
+      @logger.warn("Parameter 'path' is set, ignoring parameters: 'host' and 'port'")
+      connectionParams = {
+        :path => @path
+      }
+    end
+
+    baseParams = {
       :timeout => @timeout,
       :db => @db,
       :password => @password.nil? ? nil : @password.value
     }
+
+    return connectionParams.merge(baseParams)
   end
 
   # private