philae 0.2.12 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 98c6b24b9ffa3987fffbb4a47f404e8d20e728663be1dd3a6953972bfab2a7d6
-  data.tar.gz: f646a2b162c96cf3eced95b894f75ab74e64a13fb9dc40618ebf6757a721a068
+  metadata.gz: 30d73e3e0425c11acc1fb1f03291b6d922b9141b077d5df15c82fd1bb654be9a
+  data.tar.gz: f2296b07a57836132bc39c34de390d54a19cf91b31fe91420629fac920ff1a5b
 SHA512:
-  metadata.gz: c0a665aee100b59fa4057f1cb688aebf8fcf52282408142b3186d53da9e236522ad74c2945c26f0be66e38a377329cfb494863e24a85acde4f7ac72b4a7102e8
-  data.tar.gz: 8316c82012b480bb5cd6b43b2992a5b6e3712a78337031c51760903cc9d79a6962f71aeef5e1ed3a426a33c4d4ede4ddc0c99218c47835a5f881363cd4afd417
+  metadata.gz: 80374b372327ad433cfe231df3cba1e555af3225b4bc0747c66fa304885f08242058666a8d7853e64751666d15cd419d2d72a805ca8a71be1b32779f532de46e
+  data.tar.gz: 68507be35885a378a305df2172a718c331e8b51b1bd7b2b5630228d10a4d1cc21ddb82c5eb28b4e59f167fea9d8847905140b0c566f065ef5b26597f1d10efe6

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/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/etcd_probe.rb

@@ -14,15 +14,12 @@ module Philae
 
     # @param [Integer] read_timeout Timeout in second for the HTTP request
     def initialize(name, host, port, read_timeout: 1, cacert: nil, ssl_cert: nil, ssl_key: nil)
-      if not cacert.nil?
-        if !File.exists? cacert
-          raise InvalidSSLConfig, "cacert"
-        elsif ssl_cert.nil? or !File.exists? ssl_cert
-          raise InvalidSSLConfig, "ssl_cert"
-        elsif ssl_key.nil? or !File.exists? ssl_key
-          raise InvalidSSLConfig, "ssl_key"
-        end
+      if !cacert.nil?
+        raise InvalidSSLConfig, 'cacert' if !File.exist?(cacert)
+        raise InvalidSSLConfig, 'ssl_cert' if ssl_cert.nil? || !File.exist?(ssl_cert)
+        raise InvalidSSLConfig, 'ssl_key' if ssl_key.nil? || !File.exist?(ssl_key)
       end
+
       @name = name
       @host = host
       @port = port
@@ -34,22 +31,25 @@ module Philae
 
     def check
       begin
-        if not @cacert.nil?
-          client = Etcd.client host: @host, port: @port, read_timeout: @read_timeout do |c|
-            c.use_ssl = true
-            c.ca_file = @cacert
-            c.ssl_cert = OpenSSL::X509::Certificate.new(File.read(@ssl_cert))
-            c.ssl_key = OpenSSL::PKey::RSA.new(File.read(@ssl_key))
-          end
-        else
-          client = Etcd.client host: @host, port: @port, read_timeout: @read_timeout
-        end
-        client.get '/'
-      rescue Exception => e
+        etcd_client.get '/'
+      rescue StandardError => e
         return { healthy: false, comment: "Unable to contact etcd (#{e.message})" }
       end
 
       return { healthy: true, comment: '' }
     end
+
+    protected
+
+    def etcd_client
+      return Etcd.client host: @host, port: @port, read_timeout: @read_timeout do |c|
+        next if @cacert.nil?
+
+        c.use_ssl = true
+        c.ca_file = @cacert
+        c.ssl_cert = OpenSSL::X509::Certificate.new(File.read(@ssl_cert))
+        c.ssl_key = OpenSSL::PKey::RSA.new(File.read(@ssl_key))
+      end
+    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.2.12
+  version: 0.4.0
 platform: ruby
 authors:
 - leo@scalingo.com
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-30 00:00:00.000000000 Z
+date: 2021-08-23 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.1.4
 signing_key: 
 specification_version: 4
 summary: Provide an health check API