sc4ry 0.1.2 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9ae3dacd25cc9d2d453bdb6a8e6bd78fd27e0b366112d43bfdff4572a6fd31ae
-  data.tar.gz: 0bf6f07d3a1a32767218c136c84c299fc9583e73e2b37a4f3631dcd6ff660c79
+  metadata.gz: f9a3fb1c8109f854824988f024f067a17a4911af9a50a6fe2b3810b48ee04a3e
+  data.tar.gz: b76605ccc355dcba888eae092ed01fd554a1d74de80bbc576e5942ff1f8e6d41
 SHA512:
-  metadata.gz: b8c2fbf08267a79b0b2157f9164905c576663e662c1259e1a1c6b1f8227fb2cc66a022f9f4ff55adf3d785ce41b71705ff8df78b807243cce14cf37491e8ac07
-  data.tar.gz: 6cf5d585617227d28d9c7669f4f1152ad6949b6ecd167a2ca12c1972c6003d4bd91dd2d72ede4c7241385b29c2e306af580e6f7ad041b64828393bf7c9ef0d13
+  metadata.gz: 466cbe185262a5b854b70812ce7d37f8e2032fb3f85346f3d3c42dfe202757dcc1f1b7634b91327d73bb8e795c11093c75867de002011b0e6832c28221396eea
+  data.tar.gz: f93131f1c494030d16377fec8fb8380755265a44a497365e8246e9e9a80c43cd3d921ac2b327cf17e74df6c665541a9a1c610a6916b20d9f3ae2b30391760a08

data/README.md

@@ -39,16 +39,24 @@ pp Sc4ry::Circuits.list
 # display default config, must be override with a nested hash by calling default_config= method
 pp  Sc4ry::Circuits.default_config
 
+
+# Config an alternate logger 
+Sc4ry::Logger.register name: :perso, instance: ::Logger.new('/tmp/logfile.log')
+Sc4ry::Logger::current = :perso
+
+
 # default values, circuit is half open before one of the max count is reached
 
 # {:max_failure_count=>5,                      => maximum failure before opening circuit
 #  :timeout_value=>20,                         => timeout value, if :timeout => true
-#  :timeout=>false,                            => activate internal timeout
+#  :timeout=>false,                            => (de)activate internal timeout
 #  :max_timeout_count=>5,                      => maximum timeout try before opening circuit
 #  :max_time=>10,                              => maximum time for a circuit run
 #  :max_overtime_count=>3,                     => maximum count of overtime before opening circuit
 #  :check_delay=>30,                           => delay after opening, before trying again to closed circuit or after an other check
 #  :notifiers=>[],                             => active notifier, must be :symbol in [:prometheus, :mattermost]
+#  :forward_unknown_exceptions => true,        => (de)activate forwarding of unknown exceptions, just log in DEBUG if false
+#  :raise_on_opening => false,                 => (de)activate raise specific Sc4ry exceptions ( CircuitBreaked ) if circuit opening
 #  :exceptions=>[StandardError, RuntimeError]} => list of selected Exceptions considered for failure, others are SKIPPED. 
 
 # display configuration for a specific circuit

data/lib/sc4ry/circuits.rb

@@ -11,6 +11,8 @@ module Sc4ry
                  :max_overtime_count => 3,
                  :check_delay => 30,
                  :notifiers => [],
+                 :forward_unknown_exceptions => true,
+                 :raise_on_opening => false,
                  :exceptions => [StandardError, RuntimeError]
                  }
 
@@ -86,7 +88,10 @@ module Sc4ry
       [:closed,:half_open,:open].each do |status|
         data[:status][:general] = status if worst_status.include? status
       end
-      Sc4ry::Helpers.notify circuit: options[:circuit], config: data if save != data[:status][:general]          
+      if save != data[:status][:general] then
+        raise Sc4ry::Exceptions::CircuitBreaked if data[:status][:general] == :open and data[:raise_on_opening]
+        Sc4ry::Helpers.notify circuit: options[:circuit], config: data 
+      end          
       @@circuits_store.put key: options[:circuit], value: data
     end
   end

data/lib/sc4ry/dependencies.rb

@@ -13,7 +13,9 @@ require 'uri'
 require 'json'
 
 
+
 require_relative 'helpers'
+require_relative 'exceptions'
 require_relative 'logger'
 require_relative 'backends/init'
 require_relative 'store'

data/lib/sc4ry/exceptions.rb

@@ -0,0 +1,11 @@
+module Sc4ry
+    module Exceptions
+        class CircuitBreaked < StandardError
+            def initialize(msg="Circuit just opened")
+                super(msg)
+              end
+        
+        end
+
+    end
+end

data/lib/sc4ry/run_controller.rb

@@ -43,7 +43,12 @@ module Sc4ry
         elsif @circuit[:exceptions].include? e.class
           @failure = true
         else  
-          Sc4ry::Loggers.warning "skipped : #{@last_exception}"
+          if @circuit[:forward_unknown_exceptions] then
+            raise e.class, "Sc4ry forward: #{e.message}" 
+          else
+            Sc4ry::Helpers.log level: :debug, message: "skipped : #{@last_exception}"
+          end
+          
         end 
       end
       @end_time = Process.clock_gettime(Process::CLOCK_MONOTONIC)

data/lib/sc4ry/version.rb

@@ -1,3 +1,3 @@
 module Sc4ry
-  VERSION = "0.1.2"
+  VERSION = "0.1.5"
 end

data/sc4ry.gemspec

@@ -19,4 +19,9 @@ Gem::Specification.new do |spec|
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
   spec.require_paths = ["lib"]
+  
+  spec.add_dependency "prometheus-client", "~> 3.0"
+  spec.add_dependency "rest-client", "~> 2.1"
+
+
 end

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: sc4ry
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.5
 platform: ruby
 authors:
 - Romain GEORGES
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-03-01 00:00:00.000000000 Z
-dependencies: []
+date: 2022-03-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: prometheus-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
 description: Sc4ry provide the design pattern Circuit breaker for your application.
 email:
 - romain.georges@orange.com
@@ -33,6 +61,7 @@ files:
 - lib/sc4ry/backends/redis.rb
 - lib/sc4ry/circuits.rb
 - lib/sc4ry/dependencies.rb
+- lib/sc4ry/exceptions.rb
 - lib/sc4ry/exporters/init.rb
 - lib/sc4ry/helpers.rb
 - lib/sc4ry/logger.rb