philae 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4058dbbd9d47df1d46c0bb68315c17dfd38981a3d8d884be768df8aca9fa68d0
-  data.tar.gz: f745431b27b4371084f53ae649c94b362164ce68ab88353a7c8cee6213ccd014
+  metadata.gz: ffa3d30f51168d0d1ae72b1689900daf71eeb832aa9434f2c8d13040b962e156
+  data.tar.gz: e2eca87f43d64cf211f8d8705032f35378473c53e50dad83520bf408fbfcf857
 SHA512:
-  metadata.gz: c3a8c85060058e306066489391a38abf0cd81dbc03f505b7bd033f75eb282dc9f9a1cc77f285755c32a92cf8739f5aba77c1d01018dbf27b29dad73c997cd1fa
-  data.tar.gz: 96aab47fb98d8d03b6260046a4b3aa8bd6933ebf0c25126b25487bb8dead8d08db6d4ebdb00abb89b29cc8d0d67212f9ba68ca68b923f46b28cd9490aa284035
+  metadata.gz: 186c411027e257cd9d2b482c2228e0bdc1cd8be2f68730b40ff23329ecd8b544afed4866fdad86625ecd57d3ce6a31a6627c4450110846885d8c6389e6005bae
+  data.tar.gz: 19377fb811659ff0a3339f223ff1502ed3678e2e9626476338811caa7e258c27676ae63f4ddb8fd1147a7bd683af5a0b6a700e386302892530637d44d4d75b75

data/lib/philae/collection_probe.rb

@@ -0,0 +1,54 @@
+module Philae
+  class CollectionProbe
+    def initialize(*args)
+      raise ArgumentError, "can't be instantiate, use specialized class"
+    end
+
+    def probes
+      raise ArgumentError, 'specialized class should implement :probes'
+    end
+
+    def check
+      results = []
+      result_queue = Queue.new
+      probes.each do |probe|
+        Thread.new do
+          begin
+            result = probe.check
+          rescue StandardError => e
+            result = {
+              healthy: false,
+              error: "probe #{probe.name} check failed: #{e.class} - #{e.message}",
+            }
+          end
+          result[:probe] = probe
+          result_queue.push result
+        end
+      end
+
+      loop do
+        results.push result_queue.pop
+        break if results.count == probes.length
+      end
+
+      failed_results = results.select do |result|
+        result[:healthy] == false
+      end
+
+      error = failed_results.map do |result|
+        msg = "#{result[:probe].name}: #{result[:comment]} "
+        msg += result[:code] if result[:code]
+        msg += result[:error] if result[:error]
+        next msg
+      end.join(', ')
+
+      if failed_results.count == probes.count
+        return { healthy: false, comment: "All #{name} nodes are down", error: error }
+      elsif failed_results.count > 0
+        return { healthy: true, comment: "#{failed_results.count} #{name} nodes are down: #{error}" }
+      else
+        return { healthy: true, comment: '' }
+      end
+    end
+  end
+end

data/lib/philae/docker_probe.rb

@@ -4,19 +4,19 @@ module Philae
   class DockerProbe
     attr_reader :name
 
-    def initialize(name, endpoint = '/var/run/docker.sock', options = nil)
+    def initialize(name, endpoint = '/var/run/docker.sock', options = {})
       @name = name
       @endpoint = endpoint
-      @docker_options = options
+      @docker_options = {read_timeout: 50, connect_timeout: 50}.merge(options)
     end
 
     def check
       Docker.url = @endpoint
-      Docker.options = @docker_options if !@docker_options.nil?
+      Docker.options = @docker_options
       begin
         Docker::Container.all
-      rescue
-        return { healthy: false, comment: 'Unable to communicate with docker' }
+      rescue => e
+        return { healthy: false, comment: "Unable to communicate with docker (#{e.message})" }
       end
 
       return { healthy: true, comment: '' }

data/lib/philae/etcd_cluster_probe.rb

@@ -0,0 +1,30 @@
+require_relative 'collection_probe'
+require_relative 'etcd_probe'
+
+module Philae
+  class EtcdClusterProbe < CollectionProbe
+    attr_reader :name, :etcd_probes
+
+    # @param [Integer] read_timeout Timeout in second for the HTTP request
+    def initialize(name, endpoints, read_timeout: 1, cacert: nil, ssl_cert: nil, ssl_key: nil)
+      raise ArgumentError, 'empty endpoints' if endpoints.nil? || endpoints.empty?
+
+      @etcd_probes = endpoints.map do |endpoint|
+        endpoint_uri = URI(endpoint)
+        next EtcdProbe.new(
+          "#{name}-#{endpoint_uri.host}-#{endpoint_uri.port}",
+          endpoint_uri.host,
+          endpoint_uri.port,
+          read_timeout: read_timeout, cacert: cacert,
+          ssl_cert: ssl_cert, ssl_key: ssl_key,
+        )
+      end
+
+      @name = name
+    end
+
+    def probes
+      return @etcd_probes
+    end
+  end
+end

data/lib/philae/http_probe.rb

@@ -11,12 +11,13 @@ module Philae
     #   key: "path/to/key",
     #   ca: "path/to/ca"
     # }
-    def initialize(name, uri, username = nil, password = nil, tls_context = nil)
+    def initialize(name, uri, username = nil, password = nil, tls_context = nil, timeout = nil)
       @name = name
       @uri = uri
       @username = username
       @password = password
       @tls_context = tls_context
+      @timeout = timeout
     end
 
     def check
@@ -32,6 +33,14 @@ module Philae
             http.verify_mode = OpenSSL::SSL::VERIFY_PEER
           end
         end
+
+        if !@timeout.nil?
+          http.read_timeout = @timeout
+          http.open_timeout = @timeout
+          http.write_timeout = @timeout
+          http.ssl_timeout = @timeout
+        end
+
         req = Net::HTTP::Get.new(uri)
         req.basic_auth @username, @password if !@username.nil? || !@password.nil?
         resp = http.start do |httpconn|

data/lib/philae/nsq_cluster_probe.rb

@@ -0,0 +1,46 @@
+require_relative 'collection_probe.rb'
+require_relative 'nsq_probe.rb'
+
+module Philae
+  class NSQClusterProbe < CollectionProbe
+    DEFAULT_HTTP_PORT = 4152
+
+    attr_reader :name, :nsq_probes
+
+    def self.new_from_env(name, opts = {})
+      if ENV['NSQD_HOSTS'].nil? || ENV['NSQD_HTTP_PORT'].nil?
+        raise ArgumentError, 'no NSQD_HOSTS and NSQD_HTTP_PORT defined'
+      end
+
+      tls_context = nil
+      if ENV['NSQD_TLS'] == 'true'
+        tls_context = {
+          cert: ENV['NSQD_TLS_CERT'],
+          key: ENV['NSQD_TLS_KEY'],
+          ca: ENV['NSQD_TLS_CACERT'],
+        }
+      end
+
+      http_hosts = ENV['NSQD_HOSTS'].split(',').map do |host|
+        host.split(':')[0] + ":#{ENV['NSQD_HTTP_PORT']}"
+      end
+
+      new(name, http_hosts, tls_context, opts)
+    end
+
+    def initialize(name, hosts, tls_context = nil, opts = {})
+      raise ArgumentError, 'should have at least one host' if hosts.nil? || hosts.empty?
+
+      @name = name
+      @nsq_probes = hosts.map do |hostport|
+        host, port = hostport.split(':')
+        port = DEFAULT_HTTP_PORT if port.nil?
+        next Philae::NSQProbe.new("#{name}-#{host}-#{port}", host, port, tls_context, opts)
+      end
+    end
+
+    def probes
+      @nsq_probes
+    end
+  end
+end

data/lib/philae/nsq_probe.rb

@@ -2,19 +2,19 @@ require File.join File.dirname(__FILE__), 'http_probe.rb'
 
 module Philae
   class NSQProbe < HttpProbe
-    def self.new_from_env(name)
+    def self.new_from_env(name, opts = {})
       if ENV["NSQD_TLS"] == "true"
         return self.new(name, ENV["NSQD_HOST"], ENV["NSQD_HTTP_PORT"], {
           cert: ENV["NSQD_TLS_CERT"],
           key:  ENV["NSQD_TLS_KEY"],
           ca:   ENV["NSQD_TLS_CACERT"],
-        })
+        }, opts)
       else
         return self.new(name, ENV["NSQD_HOST"], ENV["NSQD_HTTP_PORT"])
       end
     end
 
-    def initialize(name, host, port = 4151, tls_context = nil)
+    def initialize(name, host, port = 4151, tls_context = nil, opts = {})
       @name = name
       scheme = "http"
       if !tls_context.nil?
@@ -22,6 +22,7 @@ module Philae
       end
       @uri = "#{scheme}://#{host}:#{port}/ping"
       @tls_context = tls_context
+      @timeout = opts.fetch(:timeout, 5)
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: philae
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.0
 platform: ruby
 authors:
 - leo@scalingo.com
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-24 00:00:00.000000000 Z
+date: 2022-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: docker-api
@@ -68,6 +68,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
 description: 
 email: hello@scalingo.com
 executables: []
@@ -75,10 +89,13 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/philae.rb
+- lib/philae/collection_probe.rb
 - lib/philae/docker_probe.rb
+- lib/philae/etcd_cluster_probe.rb
 - lib/philae/etcd_probe.rb
 - lib/philae/http_probe.rb
 - lib/philae/mongo_probe.rb
+- lib/philae/nsq_cluster_probe.rb
 - lib/philae/nsq_probe.rb
 - lib/philae/pgsql_probe.rb
 - lib/philae/philae_probe.rb
@@ -103,7 +120,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.22
 signing_key: 
 specification_version: 4
 summary: Provide an health check API