rookout 0.1.41 → 0.1.43

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 07a2d9fa41fdf140e81f22c1a46f47bbaf5412b31d1ab62c1f59460c07113c03
-  data.tar.gz: 9dd40c49cc6b8417aa3424cedd26aad1b8e63813fe0e2fcc063749d03c20f602
+  metadata.gz: 451da8de695dcbffddf0e548b213741155298be1877e390c7cbcb776a21744e6
+  data.tar.gz: 5d006c7a1e89e0ab1d6e407c4afa4e1410f50f2770e92c1cdc083498cee54af0
 SHA512:
-  metadata.gz: 7204403b2efd52cce60b533b396c93ffc963b60554d3fbf4fbc414f4a2d6a80c0ced39e7d6c6cceda6d2470ee46563cc8704871b058957599f8b6f7ad1d433ff
-  data.tar.gz: 2a05c92e5f984035bcbe84e5e4f2f25be8b2458032272c03fd4e94f8e94252bcaf8c11d7989c294e5a7d07773e95170bb7f479c3806945636869b2b7b491349d
+  metadata.gz: 743f3550703c0cfaa55527a185f014c31129761addff6584dbd01dc63d8bd0bc245188ce6cb51812de8ebb1c0d8ac1b6df9460c6a9f9c47b342ef5519cba1137
+  data.tar.gz: bb0dbcbb2ee6bbc8fa0b0d957e197021fb156e8a49fd2f8bd365072f665f23d7b7d6eb06bf490ccd880602f02dd43a226496d0e25dbb67e4c90932121a7d2f01

data/lib/rookout/augs/aug.rb

@@ -27,7 +27,7 @@ module Rookout
         return unless @enabled
 
         if output.user_messages_queue_full?
-          Logger.instance.warning "Skipping aug-\t#{id} execution because the queue is full"
+          output.send_output_queue_full_warning @id
           return
         end
 

data/lib/rookout/augs/aug_factory.rb

@@ -67,8 +67,10 @@ module Rookout
       def create_limits_manager configuration
         limiters = []
         if global_rate_limiter.nil?
-          rate_limit = parse_rate_limit configuration["rateLimit"], configuration["rateLimitModifier"], 200, 5000
-          limiters.append AugRateLimiter.new(*rate_limit)
+          rate_limit = parse_rate_limit configuration["rateLimit"], configuration["rateLimitModifier"], 200, 5000, 1
+          unless rate_limit.nil?
+            limiters.append AugRateLimiter.new(*rate_limit)
+          end
         else
           limiters.append global_rate_limiter
         end
@@ -78,7 +80,19 @@ module Rookout
 
       def global_rate_limiter
         if @global_rate_limiter.nil? && Rookout::Config.global_rate_limit != ""
-          rate_limit = parse_rate_limit Rookout::Config.global_rate_limit, "0", 0, 0
+          begin
+            rate_limit = parse_rate_limit Rookout::Config.global_rate_limit,
+                                          "0", 0, 0, Rookout::Config.global_rate_limit_multiplier
+            if rate_limit.nil?
+              raise Exceptions::RookInvalidRateLimitConfiguration, Rookout::Config.global_rate_limit
+            end
+          rescue Exceptions::RookInvalidRateLimitConfiguration => e
+            Logger.instance.warning "Failed to create global rate limiter: #{e.message}"
+            err = Processor::RookError.new e
+            UserWarnings.notify_error err
+            return nil
+          end
+
           @global_rate_limiter = AugRateLimiter.new(*rate_limit)
           Logger.instance.debug "Using global rate limiter with configuration: #{rate_limit}"
           Rookout::Config.using_global_rate_limiter = true
@@ -87,13 +101,15 @@ module Rookout
         @global_rate_limiter
       end
 
-      def parse_rate_limit config, modifier_config, default_quota, default_window
+      def parse_rate_limit config, modifier_config, default_quota, default_window, multiplier
         window_quota = default_quota
         window_size = default_window
 
         unless config.nil? || config.empty?
           rate_limit_split = config.split "/"
-          unless rate_limit_split.length == 2 && rate_limit_split[0].is_number? && rate_limit_split[1].is_number?
+          unless rate_limit_split.length == 2 && \
+                 Utils.is_number?(rate_limit_split[0]) && \
+                 Utils.is_number?(rate_limit_split[1])
             raise Exceptions::RookInvalidRateLimitConfiguration, config
           end
 
@@ -105,7 +121,15 @@ module Rookout
         window_size_ns = Utils.milliseconds_to_nanoseconds window_size
         rate_limit_modifier = modifier_config.to_i || 5
 
-        [window_quota_ns, window_size_ns, rate_limit_modifier]
+        if window_quota_ns == 0
+          return nil
+        end
+
+        if window_quota_ns >= window_size_ns
+          raise Exceptions::RookInvalidRateLimitConfiguration, config
+        end
+
+        [window_quota_ns * multiplier, window_size_ns, rate_limit_modifier]
       end
     end
   end

data/lib/rookout/com_ws/agent_com_ws.rb

@@ -26,8 +26,12 @@ module Rookout
       attr_reader :pending_messages
 
       def initialize output, agent_host, agent_port, proxy, token, labels, print_on_connect
-        agent_host_with_protocl = agent_host.include?("://") ? agent_host : "ws://#{agent_host}"
-        @uri = "#{agent_host_with_protocl}:#{agent_port}/v1"
+        if agent_host.nil? || agent_host.empty?
+          @uri = ""
+        else
+          agent_host_with_protocl = agent_host.include?("://") ? agent_host : "ws://#{agent_host}"
+          @uri = "#{agent_host_with_protocl}:#{agent_port}/v1"
+        end
         if proxy.nil? || proxy.empty?
           @proxy = nil
         else
@@ -57,14 +61,7 @@ module Rookout
         msg_size = envelope_wrapper.calculate_size
         if @pending_messages_length + msg_size > Config.agent_com_max_queue_messages_length ||
            queue_full?
-          exc = Exceptions::RookMessageSizeExceeded.new msg_size, Config.agent_com_max_queue_messages_length
-          warning = Processor::RookError.new exc
-          UserWarnings.notify_warning warning
-
-          Logger.instance.warning "Dropping message, size was #{msg_size}, pedning messages: #{@pending_messages_length}
-                                  which is over the message size limit #{Config.agent_com_max_queue_messages_length},
-                                  queue length: #{@pending_messages.length}"
-          return
+          raise Exceptions::RookOutputQueueFull
         end
 
         @pending_messages.push envelope_wrapper
@@ -108,7 +105,6 @@ module Rookout
 
       private
 
-      # rubocop:disable Style/StderrPuts
       def connection_thread
         backoff = Backoff.new
 
@@ -118,7 +114,8 @@ module Rookout
 
             if @print_on_initial_connection
               @print_on_initial_connection = false
-              $stderr.puts "[Rookout] Successfully connected to controller"
+              Utils.quiet_puts "[Rookout] Successfully connected to controller"
+              Utils.quiet_puts "[Rookout] Rook's ID is #{@agent_id}"
             end
             Logger.instance.debug "WebSocket connected successfully"
             Logger.instance.info "Finished initialization"
@@ -142,13 +139,11 @@ module Rookout
       rescue Exception => e
         Logger.instance.error "Unexpected error in connection_thread", e
       end
-      # rubocop:enable Style/StderrPuts
 
       def open_new_connection
         client = WebsocketClient.new @uri, @proxy, @token
         client.connect
 
-        Logger.instance.info "Registering agent with id #{@agent_id}"
         msg = Com::Rookout::NewAgentMessage.new agent_info: @info.pack
         client.send_frame wrap_in_envelope(msg)
 

data/lib/rookout/com_ws/output.rb

@@ -11,11 +11,15 @@ module Rookout
     require_relative "token_bucket"
     require_relative "envelope_wrapper"
 
+    require "concurrent"
+
     class Output
       def initialize
         @agent_id = nil
         @agent_com = nil
 
+        @skipped_aug_ids = Concurrent::Set.new
+
         @rule_status_update_bucket = TokenBucket.new Config.output_max_status_updates,
                                                      Config.output_bucket_refresh_rate do
           Logger.instance.error "Limit reached, dropping status updates"
@@ -55,6 +59,17 @@ module Rookout
         @user_message_bucket.exhausted? || (!@agent_com.nil? && @agent_com.queue_full?)
       end
 
+      def send_output_queue_full_warning aug_id
+        if @skipped_aug_ids.include? aug_id
+          return
+        end
+
+        @skipped_aug_ids.add aug_id
+        error = Processor::RookError.new Exceptions::RookOutputQueueFull.new
+        send_rule_status aug_id, :Warning, error
+        Logger.instance.warning "Skipping aug-\t#{aug_id} execution because the queue is full"
+      end
+
       def send_warning rule_id, error
         send_rule_status rule_id, :Warning, error
       end
@@ -63,6 +78,10 @@ module Rookout
         return if @closing || !@agent_com
 
         @rule_status_update_bucket.if_available do
+          if active == "Deleted"
+            @skipped_aug_ids.delete? rule_id
+          end
+
           status = Com::Rookout::RuleStatusMessage.new agent_id: @agent_id,
                                                        rule_id: rule_id,
                                                        active: active
@@ -73,7 +92,11 @@ module Rookout
 
           envelope_wrapper = EnvelopeWrapper.new status
 
-          @agent_com.add envelope_wrapper
+          begin
+            @agent_com.add envelope_wrapper
+          rescue Exceptions::RookOutputQueueFull
+            # Ignored
+          end
         end
       end
 
@@ -100,7 +123,12 @@ module Rookout
             )
           end
 
-          @agent_com.add envelope_wrapper
+          begin
+            @agent_com.add envelope_wrapper
+            @skipped_aug_ids.delete? aug_id
+          rescue Exceptions::RookOutputQueueFull
+            send_output_queue_full_warning aug_id
+          end
         end
       end
 
@@ -144,7 +172,11 @@ module Rookout
 
         envelope_wrapper = EnvelopeWrapper.new msg
 
-        @agent_com.add envelope_wrapper
+        begin
+          @agent_com.add envelope_wrapper
+        rescue Exceptions::RookOutputQueueFull
+          # Ignored
+        end
       end
     end
   end

data/lib/rookout/commit.rb

@@ -1,3 +1,3 @@
 module Rookout
-  COMMIT = "ed682099e24a661d30178506cb58f2a25d4af877".freeze
+  COMMIT = "5444c2c813f2ee703b7bbcd51f5591ace3e1150f".freeze
 end

data/lib/rookout/config.rb

@@ -6,8 +6,10 @@ module Rookout
     # Magic to allow for module variables to be easily accessible
     class << self
       attr_accessor :debug
+      attr_accessor :quiet
 
       Rookout::Config.debug = false
+      Rookout::Config.quiet = false
 
       attr_accessor :logger_filename
       attr_accessor :logger_log_to_stderr
@@ -76,10 +78,16 @@ module Rookout
 
       Rookout::Config.true_values = ["y", "Y", "yes", "Yes", "YES", "true", "True", "TRUE", "1"]
 
+      attr_accessor :global_rate_limit_quota
+      attr_accessor :global_rate_limit_window_size
       attr_accessor :global_rate_limit
+      attr_accessor :global_rate_limit_multiplier
       attr_accessor :using_global_rate_limiter
 
+      Rookout::Config.global_rate_limit_quota = ""
+      Rookout::Config.global_rate_limit_window_size = ""
       Rookout::Config.global_rate_limit = ""
+      Rookout::Config.global_rate_limit_multiplier = 1
       Rookout::Config.using_global_rate_limiter = false
 
       def update_config configuration
@@ -103,7 +111,12 @@ module Rookout
       def update_global_rate_limit_config configuration
         global_rate_limit = ENV["ROOKOUT_GLOBAL_RATE_LIMIT"]
         if global_rate_limit.nil?
-          global_rate_limit = configuration["RUBY_GLOBAL_RATE_LIMIT"]
+          quota = configuration["RUBY_GLOBAL_RATE_LIMIT_QUOTA_MS"]
+          window_size = configuration["RUBY_GLOBAL_RATE_LIMIT_WINDOW_SIZE_MS"]
+
+          if quota != "" && !quota.nil? && window_size != "" && !window_size.nil?
+            global_rate_limit = "#{quota}/#{window_size}"
+          end
         end
 
         return if global_rate_limit.nil? || global_rate_limit == ""

data/lib/rookout/exceptions.rb

@@ -95,6 +95,13 @@ module Rookout
       end
     end
 
+    class RookOutputQueueFull < ToolException
+      def initialize
+        super "Breakpoint triggered but output queue is full. " \
+              "Data collection will be disabled until the queue has emptied."
+      end
+    end
+
     class RookRuleAugRateLimited < ToolException
       def initialize
         super "Breakpoint was disabled due to rate-limiting. " \
@@ -234,7 +241,7 @@ module Rookout
       def initialize config
         super "Invalid rate limit configuration: #{config}",
               {
-                "rate_limit_config" => config
+                "config" => config
               }
       end
     end

data/lib/rookout/interface.rb

@@ -4,6 +4,7 @@ module Rookout
     include Singleton
 
     require_relative "config"
+    require_relative "utils"
     require_relative "exceptions"
     include Exceptions
 

data/lib/rookout/utils.rb

@@ -1,26 +1,34 @@
-module Utils
-  require "securerandom"
+module Rookout
+  module Utils
+    require "securerandom"
+    require_relative "config"
 
-  module_function
+    module_function
 
-  def uuid
-    SecureRandom.uuid.gsub(/-/, "")
-  end
+    def uuid
+      SecureRandom.uuid.gsub(/-/, "")
+    end
 
-  def milliseconds_to_nanoseconds milliseconds
-    nano = milliseconds * (10**6)
-    nano.to_i
-  end
+    def milliseconds_to_nanoseconds milliseconds
+      nano = milliseconds * (10**6)
+      nano.to_i
+    end
 
-  def time_to_nanoseconds time_obj
-    secs = time_obj.to_i
-    nsecs = time_obj.nsec
-    ((10**9) * secs) + nsecs
-  end
-end
+    def time_to_nanoseconds time_obj
+      secs = time_obj.to_i
+      nsecs = time_obj.nsec
+      ((10**9) * secs) + nsecs
+    end
+
+    def quiet_puts msg
+      # rubocop:disable Style/StderrPuts
+      return if Config.quiet
+      $stderr.puts msg
+      # rubocop:enable Style/StderrPuts
+    end
 
-class String
-  def is_number?
-    to_f.to_s == self || to_i.to_s == self
+    def is_number? string
+      true if Float(string) rescue false
+    end
   end
 end

data/lib/rookout/version.rb

@@ -1,3 +1,3 @@
 module Rookout
-  VERSION = "0.1.41".freeze
+  VERSION = "0.1.43".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rookout
 version: !ruby/object:Gem::Version
-  version: 0.1.41
+  version: 0.1.43
 platform: ruby
 authors:
 - Liran Haimovitch
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-09-12 00:00:00.000000000 Z
+date: 2022-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: binding_of_caller