app_profiler 0.2.3 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f312a0076c72716017684a2438e0a255250fda160f5e7450813869da8bcac922
-  data.tar.gz: cbec087431d3a5271599bb6e6b2238aa4e67d7f51c79e7d1f3a50a3da3d12feb
+  metadata.gz: 36a0afed63f70a16ab782039e981583c16e80f846eb6caf6cefce219d7934d0d
+  data.tar.gz: eda36bd2a579b25757db0e872c3f2aa1cbdda60ddf486b4bd3ad90f34f74829c
 SHA512:
-  metadata.gz: 55c7acf18a8c4933e348e80ac6f58201797c1f2935b928c1749fca01fec1d65bf4414648240aeac65fdd5044838565b46a002c4ea87f6472c543478946221c3e
-  data.tar.gz: a5b18127dff76a6482f30d17b18bb9dcb4f3db42a5c0434b6dc764e57f6383ba86417fa1fa9f5e6ce0dcae007aa0470a294f566346c07c87b30a733021451483
+  metadata.gz: 8ef999eb872722bca7b910b88df8a091c756b4d9f0e95da4ac770aacfb0b5454a160ca37b8c13852e25e5fd8aecf698f6bc06f6669104cbbb02c5af033b66a80
+  data.tar.gz: 2896ca3138e8b631445b628bcd6206e77bcd94fbef57c00560b0a63f8677b3103555eef97aabbb936722406d5667ec6c8885c9224fe85cd82d2619f45fdb9051

data/lib/app_profiler/backend/base_backend.rb

@@ -40,7 +40,7 @@ module AppProfiler
       end
 
       def release_run_lock
-        self.class.run_lock.unlock
+        self.class.run_lock.unlock if self.class.run_lock.locked?
       rescue ThreadError
         AppProfiler.logger.warn("[AppProfiler] run lock not released as it was never acquired")
       end

data/lib/app_profiler/middleware.rb

@@ -50,7 +50,6 @@ module AppProfiler
 
     def profile_params(params)
       return params if params.valid?
-
       return unless AppProfiler.profile_sampler_enabled
 
       AppProfiler::Sampler.profile_params(params, AppProfiler.profile_sampler_config)

data/lib/app_profiler/profile/stackprof.rb

@@ -8,6 +8,10 @@ module AppProfiler
       @data[:mode]
     end
 
+    def metadata
+      @data[:metadata]
+    end
+
     def format
       FILE_EXTENSION
     end

data/lib/app_profiler/profile/vernier.rb

@@ -8,6 +8,10 @@ module AppProfiler
       @data[:meta][:mode]
     end
 
+    def metadata
+      @data[:meta]
+    end
+
     def format
       FILE_EXTENSION
     end

data/lib/app_profiler/profile.rb

@@ -81,7 +81,7 @@ module AppProfiler
     end
 
     def metadata
-      @data[:metadata]
+      raise NotImplementedError
     end
 
     def mode

data/lib/app_profiler/sampler/config.rb

@@ -5,19 +5,21 @@ require "app_profiler/sampler/vernier_config"
 module AppProfiler
   module Sampler
     class Config
-      attr_reader :sample_rate, :paths, :cpu_interval, :backends_probability
+      attr_reader :sample_rate, :targets, :exclude_targets, :cpu_interval, :backends_probability
 
       SAMPLE_RATE = 0.001 # 0.1%
-      PATHS = ["/"]
+      TARGETS = ["/"]
       BACKEND_PROBABILITES = { stackprof: 1.0, vernier: 0.0 }
-      @backends = {}
+      EMPTY_ARRAY = []
 
       def initialize(sample_rate: SAMPLE_RATE,
-        paths: PATHS,
+        targets: TARGETS,
         backends_probability: BACKEND_PROBABILITES,
         backends_config: {
           stackprof: StackprofConfig.new,
-        })
+        },
+        paths: nil,
+        exclude_targets: EMPTY_ARRAY)
 
         if sample_rate < 0.0 || sample_rate > 1.0
           raise ArgumentError, "sample_rate must be between 0 and 1"
@@ -25,10 +27,13 @@ module AppProfiler
 
         raise ArgumentError, "mode probabilities must sum to 1" unless backends_probability.values.sum == 1.0
 
+        ActiveSupport::Deprecation.new.warn("passing paths is deprecated, use targets instead") if paths
+
         @sample_rate = sample_rate
-        @paths = paths
+        @targets = paths || targets
         @backends_config = backends_config
         @backends_probability = backends_probability
+        @exclude_targets = exclude_targets
       end
 
       def get_backend_config(backend_name)

data/lib/app_profiler/sampler.rb

@@ -3,20 +3,30 @@
 require "app_profiler/sampler/config"
 module AppProfiler
   module Sampler
+    @excluded_cache = {}
     class << self
       def profile_params(request, config)
-        return unless sample?(config, request)
+        profile_params_for(request.path, config)
+      end
+
+      def profile_params_for(target, config)
+        return unless sample?(config, target)
 
         get_profile_params(config)
       end
 
       private
 
-      def sample?(config, request)
+      def sample?(config, target)
         return false if Kernel.rand > config.sample_rate
+        return false if @excluded_cache[target]
+
+        if config.exclude_targets.any? { |t| target.match?(t) }
+          @excluded_cache[target] = true
+          return false
+        end
 
-        path = request.path
-        return false unless config.paths.any? { |p| path.match?(p) }
+        return false unless config.targets.any? { |t| target.match?(t) }
 
         true
       end

data/lib/app_profiler/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module AppProfiler
-  VERSION = "0.2.3"
+  VERSION = "0.2.5"
 end

data/lib/app_profiler.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "active_support"
 require "active_support/core_ext/class"
 require "active_support/core_ext/module"
 require "logger"
@@ -63,7 +64,7 @@ module AppProfiler
   mattr_reader :profile_enqueue_failure, default: nil
   mattr_reader :after_process_queue, default: nil
   mattr_accessor :forward_metadata_on_upload, default: false
-  mattr_accessor :profile_sampler_enabled, default: false
+
   mattr_accessor :profile_sampler_config
 
   class << self
@@ -116,6 +117,28 @@ module AppProfiler
       @profiler_backend = new_profiler_backend
     end
 
+    def profile_sampler_enabled=(value)
+      if value.is_a?(Proc)
+        raise ArgumentError,
+          "profile_sampler_enabled must be a proc or a lambda that accepts no argument" if value.arity != 0
+      else
+        raise ArgumentError, "Must be TrueClass or FalseClass" unless [TrueClass, FalseClass].include?(value.class)
+      end
+
+      @profile_sampler_enabled = value
+    end
+
+    def profile_sampler_enabled
+      return false unless defined?(@profile_sampler_enabled)
+
+      @profile_sampler_enabled.is_a?(Proc) ? @profile_sampler_enabled.call : @profile_sampler_enabled
+    rescue => e
+      logger.error(
+        "[AppProfiler.profile_sampler_enabled] exception: #{e}, message: #{e.message}",
+      )
+      false
+    end
+
     def backend_for(backend_name)
       if vernier_supported? &&
           backend_name == AppProfiler::Backend::VernierBackend.name

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: app_profiler
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.5
 platform: ruby
 authors:
 - Gannon McGibbon
@@ -13,7 +13,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-28 00:00:00.000000000 Z
+date: 2024-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -184,7 +184,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.17
+rubygems_version: 3.5.21
 signing_key:
 specification_version: 4
 summary: Collect performance profiles for your Rails application.