sqreen 1.14.0 → 1.14.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f6b572a1d9fe1440b268e4edcdcaab29a177edb3d7d6f915b100d57f77219ad5
-  data.tar.gz: b05840f3d4cbc358d089b50299ccfdc7da0947a52f2603e34d572a97acb1c946
+  metadata.gz: a44b9da6464b0a61db469f75d4b2ff4409aaa60c994c5770b30067c374fbf5c4
+  data.tar.gz: c8f6c266dc33f646c647dd614706acc496c8140325fc03b1401f1d0151750cdf
 SHA512:
-  metadata.gz: be7806a0578560be5926fa04bb3201440072237ce377f4aba73fe4a3b763b2bcf75d585fff195238e8acad6986ef1112635837d1d40d800ad4a6a5df002edb13
-  data.tar.gz: b5d2cf720663a12d7add7b1f5f3ccf23bea712403898b97e10c45e741a1883fd9025b605f3ed2d02fd08f172ef2948b86f15e3e4defc2df6c2f3140e76d1d8da
+  metadata.gz: e610db595536d1370a6f4c56da23dc2144332fba297f65b1e64187d53a535857e9bb6769fd4653f8fe18d866fa2b96d93641f02d51c067ca0012bcfe9820029d
+  data.tar.gz: 618f2a1454edab5fe1df062506c3cdb766e32579ae7874fb47f938e53d326a463415b7729c275aded79f2cb073b1c7b13c1af6f4ed6c628b496445d6bd7cdd65

data/lib/sqreen/metrics/base.rb

@@ -10,7 +10,7 @@ module Sqreen
     FINISH_KEY = 'finish'.freeze
     # Base interface for a metric
     class Base
-      def initialize
+      def initialize(_opts={})
         @sample = nil
       end
 

data/lib/sqreen/metrics/binning.rb

@@ -6,14 +6,18 @@ require 'sqreen/metrics/base'
 module Sqreen
   module Metric
     # Takes numbers as samples and bins them (effectively, rounds them).
+    # Also collect max values
     class Binning < Base
+      BASE_KEY = 'base'.freeze
+      FACTOR_KEY = 'factor'.freeze
       # upper bound of i-th bin is factor * base^(i-1)
-      def initialize(base, factor)
-        super()
-        @base = base
-        @factor = factor
-        log_base = Math.log(base)
-        log_factor = Math.log(factor)
+      def initialize(opts={})
+        options = opts.dup
+        @base = options.delete(BASE_KEY)
+        @factor = options.delete(FACTOR_KEY)
+        super(options)
+        log_base = Math.log(@base)
+        log_factor = Math.log(@factor)
         @inv_log_base = 1 / log_base
         @add_parcel = - log_factor / log_base
         new_sample(Time.now.utc)
@@ -23,6 +27,7 @@ module Sqreen
         h = @sample[OBSERVATION_KEY]
         bin = bin_no(x)
         h[bin] += 1
+        h['max'] = x if x > h['max']
       end
 
       def next_sample(time)
@@ -54,21 +59,5 @@ module Sqreen
         res < 1 ? 1 : res
       end
     end
-
-    # overrides the constructor
-    class ParameterizedBinning < Binning
-      def initialize
-        raise 'Not configured' unless self.class.base && self.class.factor
-        super(self.class.base, self.class.factor)
-      end
-
-      class << self
-        attr_reader :base, :factor
-        def parameters(opts)
-          @base = opts[:base]
-          @factor = opts[:factor]
-        end
-      end
-    end
   end
 end

data/lib/sqreen/metrics_store.rb

@@ -20,6 +20,7 @@ module Sqreen
     NAME_KEY = 'name'.freeze
     KIND_KEY = 'kind'.freeze
     PERIOD_KEY = 'period'.freeze
+    OPTIONS_KEY = 'options'.freeze
 
     # Currently ready samples
     attr_reader :store
@@ -38,7 +39,9 @@ module Sqreen
       name = definition[NAME_KEY]
       kind = definition[KIND_KEY]
       klass = valid_metric(kind, name)
-      metric = mklass || klass.new
+
+      opts = definition[OPTIONS_KEY]
+      metric = mklass || klass.new(opts)
       @metrics[name] = [
         metric,
         definition[PERIOD_KEY],

data/lib/sqreen/performance_notifications/binned_metrics.rb

@@ -8,26 +8,36 @@ module Sqreen
   module PerformanceNotifications
     # Logs callback performance
     class BinnedMetrics
+      DEFAULT_PERF_BASE = 2.0
+      DEFAULT_PERF_UNIT = 0.1 # ms
+      DEFAULT_PERF_PCT_BASE = 1.3
+      DEFAULT_PERF_PCT_UNIT = 1.0 # %
       EVENT_REQ = 'req'.freeze # request total time
       EVENT_TOTAL_TIME = 'sq'.freeze # sqreen total overhead callback time
+      EVENT_PERCENT = 'pct'.freeze # sqreen total overhead percent of time
 
       EVT_NAME_REGEXP = %r{\ACallbacks/([^/]+)/([^/]+)\z}
 
       # @param metrics_store [Sqreen::MetricsStore]
-      def initialize(metrics_store, period)
+      def initialize(metrics_store, period, perf_metric_opts, perf_metric_percent_opts)
         @metrics_store = metrics_store
         @period = period
         @subid = nil
+        @perf_metric_opts = perf_metric_opts
+        @perf_metric_percent_opts = perf_metric_percent_opts
       end
 
       def enable
         return unless @subid.nil?
 
         metrics_store.create_metric(
-          'name' => EVENT_REQ, 'period' => period, 'kind' => 'ParameterizedBinning'
+          'name' => EVENT_REQ, 'period' => period, 'kind' => 'Binning', 'options' => @perf_metric_opts
         )
         metrics_store.create_metric(
-          'name' => EVENT_TOTAL_TIME, 'period' => period, 'kind' => 'ParameterizedBinning'
+          'name' => EVENT_TOTAL_TIME, 'period' => period, 'kind' => 'Binning', 'options' => @perf_metric_opts
+        )
+        metrics_store.create_metric(
+          'name' => EVENT_PERCENT, 'period' => period, 'kind' => 'Binning', 'options' => @perf_metric_percent_opts
         )
 
         @subid = Sqreen::PerformanceNotifications.subscribe(&method(:log))
@@ -67,9 +77,15 @@ module Sqreen
         Sqreen.observations_queue.push(
           [EVENT_REQ, nil, duration_millis, finish_time_obj]
         )
+        total_t = SharedStorage[:sqreen_request_time]
         Sqreen.observations_queue.push(
           [EVENT_TOTAL_TIME, nil,
-           SharedStorage[:sqreen_request_time], finish_time_obj]
+           total_t, finish_time_obj]
+        )
+        return if !duration_millis or total_t >= duration_millis
+        Sqreen.observations_queue.push(
+          [EVENT_PERCENT, nil,
+           (total_t*100.0)/(duration_millis-total_t), finish_time_obj]
         )
       end
 
@@ -82,7 +98,7 @@ module Sqreen
       def ensure_metric(metric_name)
         return if metrics_store.metric?(metric_name)
         metrics_store.create_metric(
-          'name' => metric_name, 'period' => period, 'kind' => 'ParameterizedBinning'
+          'name' => metric_name, 'period' => period, 'kind' => 'Binning', 'options' => @perf_metric_opts
         )
       end
 
@@ -90,12 +106,12 @@ module Sqreen
       class << self
         # @return [Sqreen::PerformanceNotifications::BinnedMetrics]
         attr_reader :instance
-        def enable(metrics_store, period = 60, base = 2.0, factor = 0.1)
+        def enable(metrics_store, period = 60, base = DEFAULT_PERF_BASE, factor = DEFAULT_PERF_UNIT, base_pct = DEFAULT_PERF_PCT_BASE, factor_pct = DEFAULT_PERF_PCT_UNIT)
           disable
-          Sqreen::Metric::ParameterizedBinning.parameters(
-            :base => base, :factor => factor
-          )
-          @instance = new(metrics_store, period).tap(&:enable)
+          @instance = new(metrics_store, period,
+                          {'base'=> base, 'factor' => factor},
+                          {'base' => base_pct, 'factor' => factor_pct}
+                      ).tap(&:enable)
         end
 
         def disable

data/lib/sqreen/runner.rb

@@ -33,8 +33,6 @@ module Sqreen
 
   PERF_METRICS_PERIOD = 60 # 1 min
   DEFAULT_PERF_LEVEL = 0 # disabled
-  DEFAULT_PERF_UNIT = 0.1 # ms
-  DEFAULT_PERF_BASE = 2.0
 
   class << self
     attr_reader :features
@@ -213,7 +211,7 @@ module Sqreen
       end
     end
 
-    def config_binned_metrics(level, base, factor)
+    def config_binned_metrics(level, base, factor, base_pct, factor_pct)
       level = level.to_i
       if level <= 0
         Sqreen.log.debug('Disabling binned metrics')
@@ -221,7 +219,7 @@ module Sqreen
       else
         Sqreen.log.warn("Unknown value for perf_level: #{level}. Treating as 1") unless level == 1
         PerformanceNotifications::BinnedMetrics.enable(
-          metrics_engine, PERF_METRICS_PERIOD, base.to_f, factor.to_f
+          metrics_engine, PERF_METRICS_PERIOD, base.to_f, factor.to_f, base_pct.to_f, factor_pct.to_f
         )
       end
     end
@@ -306,8 +304,11 @@ module Sqreen
       session.request_compression = features['request_compression'] if session
       self.performance_metrics_period = features['performance_metrics_period']
       config_binned_metrics(features['perf_level'] || DEFAULT_PERF_LEVEL,
-                            features['perf_base'] || DEFAULT_PERF_BASE,
-                            features['perf_unit'] || DEFAULT_PERF_UNIT)
+                            features['perf_base'] || PerformanceNotifications::BinnedMetrics::DEFAULT_PERF_BASE,
+                            features['perf_unit'] || PerformanceNotifications::BinnedMetrics::DEFAULT_PERF_UNIT,
+                            features['perf_pct_base'] || PerformanceNotifications::BinnedMetrics::DEFAULT_PERF_PCT_BASE,
+                            features['perf_pct_unit'] || PerformanceNotifications::BinnedMetrics::DEFAULT_PERF_PCT_UNIT,
+                           )
       self.call_counts_metrics_period = features['call_counts_metrics_period']
       hd = features['heartbeat_delay'].to_i
       self.heartbeat_delay = hd if hd > 0

data/lib/sqreen/version.rb

@@ -1,5 +1,5 @@
 # Copyright (c) 2015 Sqreen. All Rights Reserved.
 # Please refer to our terms for more information: https://www.sqreen.io/terms.html
 module Sqreen
-  VERSION = '1.14.0'.freeze
+  VERSION = '1.14.1'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sqreen
 version: !ruby/object:Gem::Version
-  version: 1.14.0
+  version: 1.14.1
 platform: ruby
 authors:
 - Sqreen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-13 00:00:00.000000000 Z
+date: 2018-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sq_mini_racer