sensu-redis 1.6.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c2ae81e88a971e4f2a7e4dd8a4fb8fa5d293d0d9
-  data.tar.gz: 469995301c9de2f01dbafd4865ba342b6337499d
+  metadata.gz: 5bfbf215d8c3a1975203dc6f5c08d65e54ff3167
+  data.tar.gz: 9ba122e38b68809b037ddf97a338729a6d8104fc
 SHA512:
-  metadata.gz: 3c5493adc40c41ae6e7fc38da259d239bc807e0a56dc835b6c4e4dfaa22b0c034246b057bddc95e4760be6889782f244af99ee1d8cb444695834ee68c691f9ba
-  data.tar.gz: 0cddcba167fc57f6b6e61f9513034716790a51125d6f957721f9fcda60586fc7937943c67fdd3647c89531b03e3b3e0e1eb7cff3b91e322da2b30627a413fe80
+  metadata.gz: 0416a9108788879d8cb8a6f688142a85b87f9c5d5a324c0e8301f823557f3d8994b5e2413719e178ed785579fd7e452de6d3ac3c03e7251f6199eef600081b7f
+  data.tar.gz: 84569b024c3cae5f170ddc0e3c5fa39ebff6b838ed7c6952190c54e236534743f159e7b61c753153ded0d6137b835a991166887dd248fad9f6330d314e98866c

data/README.md

@@ -2,9 +2,6 @@
 
 [![Build Status](https://travis-ci.org/sensu/sensu-redis.svg?branch=master)](https://travis-ci.org/sensu/sensu-redis)
 
-[![Code Climate](https://codeclimate.com/github/sensu/sensu-redis.png)](https://codeclimate.com/github/sensu/sensu-redis)
-[![Code Climate Coverage](https://codeclimate.com/github/sensu/sensu-redis/coverage.png)](https://codeclimate.com/github/sensu/sensu-redis)
-
 ## Installation
 
 Add this line to your application's Gemfile:

data/lib/sensu/redis.rb

@@ -1,4 +1,5 @@
 require "rubygems"
+require "sensu/redis/utilities"
 require "sensu/redis/client"
 require "sensu/redis/sentinel"
 require "eventmachine"
@@ -7,6 +8,15 @@ require "uri"
 module Sensu
   module Redis
     class << self
+      include Utilities
+
+      # Set the Redis logger.
+      #
+      # @param logger [Object] Redis logger.
+      def logger=(logger)
+        @logger = logger
+      end
+
       # Parse a Redis URL. An argument error exception is thrown if
       # this method is unable to parse the provided URL string.
       #
@@ -34,18 +44,35 @@ module Sensu
         sentinel = Sentinel.new(options)
         sentinel.resolve do |host, port|
           redis = EM.connect(host, port, Client, options)
+          redis.logger = @logger
           redis.sentinel = sentinel
           block.call(redis)
         end
       end
 
       # Connect to the current Redis master directly, using the
-      # provided connection options.
+      # provided connection options. This method uses `resolve_host()`
+      # to first resolve the provided host, if it's not already an IP
+      # address. Resolving the hostname upfront guards against lookup
+      # failures that would cause the Sensu process to crash. Upfront
+      # hostname resolution also allows this Redis library to work
+      # with Amazon AWS ElastiCache & where DNS is used as a failover
+      # mechanism.
       #
       # @param options [Hash]
       # @yield callback to be called with the redis connection object.
       def connect_direct(options, &block)
-        block.call(EM.connect(options[:host], options[:port], Client, options))
+        resolve_host(options[:host]) do |ip_address|
+          if ip_address.nil?
+            EM::Timer.new(1) do
+              connect_direct(options, &block)
+            end
+          else
+            redis = EM.connect(ip_address, options[:port], Client, options)
+            redis.logger = @logger
+            block.call(redis)
+          end
+        end
       end
 
       # Connect to Redis using the provided connection options.

data/lib/sensu/redis/client.rb

@@ -1,13 +1,15 @@
 require "sensu/redis/client/constants"
 require "sensu/redis/client/errors"
+require "sensu/redis/utilities"
 require "eventmachine"
 
 module Sensu
   module Redis
     class Client < EM::Connection
       include EM::Deferrable
+      include Utilities
 
-      attr_accessor :sentinel, :auto_reconnect, :reconnect_on_error
+      attr_accessor :logger, :sentinel, :auto_reconnect, :reconnect_on_error
 
       # Initialize the connection, creating the Redis command methods,
       # and setting the default connection options and callbacks.
@@ -81,13 +83,28 @@ module Sensu
 
       # Reconnect to Redis. The before reconnect callback is first
       # called if not already reconnecting. This method uses a 1
-      # second delay before attempting a reconnect.
+      # second delay before attempting a reconnect. The method
+      # `determine_address()` is used to determine the correct host
+      # and port to reconnect to, either via Sentinel (new master) or
+      # the previous host and port. This method uses `resolve_host()`
+      # to first resolve the determined host, if it's not already an
+      # IP address. Resolving the hostname upfront guards against
+      # lookup failures that would cause the Sensu process to crash.
+      # Upfront hostname resolution also allows this Redis library to
+      # work with Amazon AWS ElastiCache & where DNS is used as a
+      # failover mechanism.
       def reconnect!
         @reconnect_callbacks[:before].call unless @reconnecting
         @reconnecting = true
         EM.add_timer(1) do
           determine_address do |host, port|
-            reconnect(host, port)
+            resolve_host(host) do |ip_address|
+              if ip_address.nil?
+                reconnect!
+              else
+                reconnect(ip_address, port)
+              end
+            end
           end
         end
       end

data/lib/sensu/redis/sentinel.rb

@@ -55,7 +55,6 @@ module Sensu
         end
       end
 
-
       # Create a Sentinel master resolve timeout, causing the previous
       # attempt to fail/cancel, while beginning another attempt.
       #

data/lib/sensu/redis/utilities.rb

@@ -0,0 +1,68 @@
+require "ipaddr"
+require "socket"
+
+module Sensu
+  module Redis
+    module Utilities
+      # Determine if a host is an IP address (or DNS hostname).
+      #
+      # @param host [String]
+      # @return [TrueClass, FalseClass]
+      def ip_address?(host)
+        begin
+          ip_address = IPAddr.new(host)
+          ip_address.ipv4? || ip_address.ipv6?
+        rescue IPAddr::InvalidAddressError
+          false
+        end
+      end
+
+      # Resolve a hostname to an IP address for a host. This method
+      # will return `nil` to the provided block when the hostname
+      # cannot be resolved to an IP address.
+      #
+      # @param host [String]
+      # @param block [Proc] called with the result of the DNS
+      #   query (IP address).
+      def resolve_hostname(host, &block)
+        resolve = Proc.new do
+          begin
+            info = case RUBY_PLATFORM
+            when /linux/
+              flags = Socket::AI_NUMERICSERV | Socket::AI_ADDRCONFIG
+              Socket.getaddrinfo(host, nil, Socket::AF_UNSPEC, nil, nil, flags)
+            else
+              Socket.getaddrinfo(host, nil)
+            end
+            info.first.nil? ? nil : info.first[2]
+          rescue => error
+            @logger.error("redis connection error", {
+              :reason => "unable to resolve hostname",
+              :host => host,
+              :error => error.to_s
+            }) if @logger
+            nil
+          end
+        end
+        EM.defer(resolve, block)
+      end
+
+      # Resolve a hostname to an IP address for a host. This method
+      # will return the provided host to the provided block if it
+      # is already an IP address. This method will return `nil` to the
+      # provided block when the hostname cannot be resolved to an
+      # IP address.
+      #
+      # @param host [String]
+      # @param block [Proc] called with the result of the DNS
+      #   query (IP address).
+      def resolve_host(host, &block)
+        if ip_address?(host)
+          yield host
+        else
+          resolve_hostname(host, &block)
+        end
+      end
+    end
+  end
+end

data/sensu-redis.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name          = "sensu-redis"
-  spec.version       = "1.6.1"
+  spec.version       = "2.0.0"
   spec.authors       = ["Sean Porter"]
   spec.email         = ["portertech@gmail.com"]
   spec.summary       = "The Sensu Redis client library"
@@ -20,5 +20,4 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake", "10.5.0"
   spec.add_development_dependency "rspec"
-  spec.add_development_dependency "codeclimate-test-reporter" unless RUBY_VERSION < "1.9"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sensu-redis
 version: !ruby/object:Gem::Version
-  version: 1.6.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Sean Porter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-12 00:00:00.000000000 Z
+date: 2016-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eventmachine
@@ -66,20 +66,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: codeclimate-test-reporter
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description: The Sensu Redis client library
 email:
 - portertech@gmail.com
@@ -94,6 +80,7 @@ files:
 - lib/sensu/redis/client/constants.rb
 - lib/sensu/redis/client/errors.rb
 - lib/sensu/redis/sentinel.rb
+- lib/sensu/redis/utilities.rb
 - sensu-redis.gemspec
 homepage: https://github.com/sensu/sensu-redis
 licenses: