sqreen 1.1.11481117869 → 1.1.21481714484

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 91392d998d033e2ad340e87c9fc4d6da258c7bfb
-  data.tar.gz: a8fffe09a9eed7a0394abe65bbd7ab228fc33025
+  metadata.gz: 8905d51e03a06c6b055b278c05bd838b05d83a94
+  data.tar.gz: b1d6025eac52dbb97cfa082b065999c22c810fde
 SHA512:
-  metadata.gz: 039484cddbbc0081a71107265af61c7e1d809d34252eba7635316ce8e294d000686909f034f10d377307256705bf43f444b776e430b2349651a717f13c003fe5
-  data.tar.gz: a95939c4986594a0eee6403b6995df008446514f89f257113f1afc63fa69cea6c97c5360e3dfc5e61c97e5cc9bfc9aa2a932030a4151fa49c5dd92bc72eee380
+  metadata.gz: d9673ef509fce6642499f54e5663881c433e9e02924c53bcfa6fb4888a8fd7f56ae26e14a9adce3c9a1576913debb6c36f646bc07d2da861e6749710c0210918
+  data.tar.gz: a3f64e54167a755d772adcaf469fd411b7e5e2f1d7d8940a3a269aba79de81fe22ffea6db87d6603adf43c81b869b25167cc98f0d997298a7f9794b30ac5d69c

data/lib/sqreen/call_countable.rb

@@ -0,0 +1,67 @@
+# Copyright (c) 2015 Sqreen. All Rights Reserved.
+# Please refer to our terms for more information: https://www.sqreen.io/terms.html
+
+module Sqreen
+  # A module that will dynamically had call_counts to the pre/post/failing
+  # callbacks
+  module CallCountable
+    # Hook the necessary callback function
+    # The module being decorated is expected to have a
+    # record_observation & rulespack_id & rule_name method available (like RuleCallback)
+    #
+    # @param count [Hash] hash of callback names => count
+    def count_callback_calls(count)
+      base = self.class
+      @call_count_interval = 0
+      return if count.to_i == 0
+      @call_counts = {}
+      @call_count_interval = count
+      @call_count_names = {}
+      %w(pre post failing).each do |cb|
+        next unless base.method_defined?(cb)
+        @call_counts[cb] = 0
+        @call_count_names[cb] = "#{rulespack_id}/#{rule_name}/#{cb}".freeze
+        defd = base.instance_variable_defined?("@call_count_hooked_#{cb}")
+        next if defd && base.instance_variable_get("@call_count_hooked_#{cb}")
+        base.send(:alias_method, "#{cb}_without_count", cb)
+        base.send(:alias_method, cb, "#{cb}_with_count")
+        base.instance_variable_set("@call_count_hooked_#{cb}", true)
+      end
+    end
+    PRE = 'pre'.freeze
+    POST = 'post'.freeze
+    FAILING = 'failing'.freeze
+    COUNT_CALLS = 'sqreen_calls_count'.freeze
+
+    def pre_with_count(inst, *args, &block)
+      ret = pre_without_count(inst, *args, &block)
+      count_calls('pre')
+      ret
+    end
+
+    def post_with_count(rv, inst, *args, &block)
+      ret = post_without_count(rv, inst, *args, &block)
+      count_calls('post')
+      ret
+    end
+
+    def failing_with_count(rv, inst, *args, &block)
+      ret = failing_without_count(rv, inst, *args, &block)
+      count_calls('failing')
+      ret
+    end
+
+    attr_reader :call_counts
+    attr_reader :call_count_interval
+
+    protected
+
+    def count_calls(what)
+      return unless @call_count_interval > 0
+      new_value = (@call_counts[what] += 1)
+      return unless new_value % call_count_interval == 0
+      @call_counts[what] = 0
+      record_observation(COUNT_CALLS, @call_count_names[what], new_value)
+    end
+  end
+end

data/lib/sqreen/conditionable.rb

@@ -11,13 +11,12 @@ module Sqreen
     #
     # @param conditions [Hash] hash of callback names => conditions
     def condition_callbacks(conditions)
+      conditions = {} if conditions.nil?
       base = self.class
       %w(pre post failing).each do |cb|
-        next unless conditions.key?(cb)
         conds = conditions[cb]
-        next if conds.respond_to?(:empty?) && conds.empty?
         next unless base.method_defined?(cb)
-        send("#{cb}_conditions=", ConditionEvaluator.new(conds))
+        send("#{cb}_conditions=", ConditionEvaluator.new(conds)) unless conds.nil?
         defd = base.instance_variable_defined?("@conditional_hooked_#{cb}")
         next if defd && base.instance_variable_get("@conditional_hooked_#{cb}")
         base.send(:alias_method, "#{cb}_without_conditions", cb)

data/lib/sqreen/instrumentation.rb

@@ -6,6 +6,7 @@ require 'sqreen/log'
 require 'sqreen/stats'
 require 'sqreen/exception'
 require 'sqreen/performance_notifications'
+require 'sqreen/call_countable'
 require 'sqreen/events/remote_exception'
 require 'sqreen/rules_signature'
 require 'set'
@@ -496,6 +497,11 @@ module Sqreen
 
     def initialize(metrics_engine = nil)
       self.metrics_engine = metrics_engine
+      unless metrics_engine.nil?
+        metrics_engine.create_metric('name' => CallCountable::COUNT_CALLS,
+                                     'period' => 60,
+                                     'kind' => 'Sum')
+      end
     end
   end
 end

data/lib/sqreen/metrics_store.rb

@@ -23,6 +23,8 @@ module Sqreen
 
     # Currently ready samples
     attr_reader :store
+    # All known metrics
+    attr_reader :metrics
 
     def initialize
       @store = []

data/lib/sqreen/rule_attributes.rb

@@ -18,6 +18,7 @@ module Sqreen
       CALLBACK_CLASS = 'callback_class'.freeze
       METRICS = 'metrics'.freeze
       CONDITIONS = 'conditions'.freeze
+      CALL_COUNT_INTERVAL = 'call_count_interval'.freeze
 
       freeze
     end

data/lib/sqreen/rule_callback.rb

@@ -3,6 +3,7 @@
 
 require 'sqreen/callbacks'
 require 'sqreen/conditionable'
+require 'sqreen/call_countable'
 require 'sqreen/rule_attributes'
 require 'sqreen/events/attack'
 require 'sqreen/events/remote_exception'
@@ -14,6 +15,7 @@ module Sqreen
     # Base class for callback that are initialized by rules from Sqreen
     class RuleCB < CB
       include Conditionable
+      include CallCountable
       # If nothing was asked by the rule we will ask for all sections available
       # These information will be pruned later when exporting in #to_hash
       DEFAULT_PAYLOAD = PayloadCreator::METHODS.keys.freeze
@@ -32,8 +34,8 @@ module Sqreen
         @rule = rule_hash
         payload_tpl = @rule[Attrs::PAYLOAD] || DEFAULT_PAYLOAD
         @payload_generator = PayloadCreator.new(payload_tpl)
-        conditions = @rule[Attrs::CONDITIONS]
-        condition_callbacks(conditions) unless conditions.nil?
+        condition_callbacks(@rule[Attrs::CONDITIONS])
+        count_callback_calls(@rule[Attrs::CALL_COUNT_INTERVAL])
       end
 
       def rule_name

data/lib/sqreen/rules_callbacks/crawler_user_agent_matches_metrics.rb

@@ -13,7 +13,6 @@ module Sqreen
       def pre(_inst, *_args, &_block)
         ua = framework.client_user_agent
         return unless ua
-        ua = ua.freeze
         found = match(ua)
         return unless found
         Sqreen.log.debug { "Found UA #{ua} - found: #{found}" }

data/lib/sqreen/runner.rb

@@ -17,6 +17,7 @@ require 'sqreen/deliveries/simple'
 require 'sqreen/deliveries/batch'
 require 'sqreen/performance_notifications/metrics'
 require 'sqreen/instrumentation'
+require 'sqreen/call_countable'
 
 module Sqreen
   @features = {}
@@ -108,7 +109,6 @@ module Sqreen
 
       # Ensure a deliverer is there unless features have set it first
       self.deliverer ||= Deliveries::Simple.new(session)
-
       context_infos = {}
       %w(rules pack_id).each do |p|
         context_infos[p] = response[p] unless response[p].nil?
@@ -160,6 +160,14 @@ module Sqreen
       [rulespack_id, rules]
     end
 
+    def call_counts_metrics_period=(value)
+      value = value.to_i
+      return unless value > 0 # else disable collection?
+      metrics_engine.create_metric('name' => CallCountable::COUNT_CALLS,
+                                   'period' => value,
+                                   'kind' => 'Sum')
+    end
+
     def performance_metrics_period=(value)
       value = value.to_i
       if value > 0
@@ -214,6 +222,7 @@ module Sqreen
       Sqreen.update_features(features)
       session.request_compression = features['request_compression'] if session
       self.performance_metrics_period = features['performance_metrics_period']
+      self.call_counts_metrics_period = features['call_counts_metrics_period']
       hd = features['heartbeat_delay'].to_i
       self.heartbeat_delay = hd if hd > 0
       return if features['batch_size'].nil?

data/lib/sqreen/version.rb

@@ -2,5 +2,5 @@
 # Please refer to our terms for more information: https://www.sqreen.io/terms.html
 # Warning This file is auto generated! DO NOT edit.
 module Sqreen
-  VERSION = "1.1.11481117869".freeze
+  VERSION = "1.1.21481714484".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sqreen
 version: !ruby/object:Gem::Version
-  version: 1.1.11481117869
+  version: 1.1.21481714484
 platform: ruby
 authors:
 - Sqreen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-07 00:00:00.000000000 Z
+date: 2016-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: execjs
@@ -51,6 +51,7 @@ files:
 - lib/sqreen.rb
 - lib/sqreen/binding_accessor.rb
 - lib/sqreen/ca.crt
+- lib/sqreen/call_countable.rb
 - lib/sqreen/callback_tree.rb
 - lib/sqreen/callbacks.rb
 - lib/sqreen/capped_queue.rb
@@ -130,7 +131,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.4
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Sqreen Ruby agent