rack-mini-profiler 3.2.0 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cacf580297c537f36715f99aa7c7d9e77bce758a122d7b0047767fbdbe44c60c
-  data.tar.gz: 9ce08b2c74e938104ca61eeace17f659c9177e97117c45a346f3e9b3a6706d5f
+  metadata.gz: 569f89edd8e16a6577ec6e22ca4a889026678d288d9282114b8fdeaedc6be2bf
+  data.tar.gz: 7ec71935c344ff9113d3b4b9dc70dfaf3430fa30796075391d7d65bc008cb390
 SHA512:
-  metadata.gz: a40fa57fd372e7a88a566fc200ae355215fcfe0d397cbdc43322777eeb6c770e245328e6d0df0fa4286af23361979cccb85acae7c783bba90048c03af1f66800
-  data.tar.gz: 9b40d0e1deeb4a84e2ed147aba8684294d8bd7840b4d087d3b4ddfad700913e02953d496762a265d8ca7f5afb6a916c7133f0da0f24a40cc80952e27de2879c4
+  metadata.gz: dcb3c67be45ee1b7dc7516f7ddef1f4f9b6fc1513db927009aac3ef11c504caa6d9b11f3d9a8b28028c7f35f2e6e450cdc0a6b124939d1901679129a758d4499
+  data.tar.gz: 28b0c19d557485c1abf1e636bebe911e42c8f3706de174021af6e543c0c52c4a6fa0ecdef39518acb58d18d5284147c4b57c950186a8b630e9bd2e69acbc72c9

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # CHANGELOG
 
+## 3.3.0 - 2023-12-07
+- [FEATURE] Use `?pp=flamegraph?ignore_gc=true` or `config.flamegraph_ignore_gc` to ignore gc in flamegraphs. [#599](https://github.com/MiniProfiler/rack-mini-profiler/pull/599)
+
+## 3.2.1 - 2023-12-07
+- [FIX] memory_profiler was broken due to an undefined local [#597](https://github.com/MiniProfiler/rack-mini-profiler/pull/597)
+
 ## 3.2.0 - 2023-12-06
 - [BREAKING CHANGE] Ruby version 2.7.0 or later is required.
 - [FEATURE] All RMP actions can be chosen by including a X-Rack-Mini-Profiler header as well as by query parameter. [#578](https://github.com/MiniProfiler/rack-mini-profiler/pull/578)

data/README.md

@@ -431,6 +431,7 @@ start_hidden                        | `false`
 backtrace_threshold_ms              | `0`                                                     | Minimum SQL query elapsed time before a backtrace is recorded.
 flamegraph_sample_rate              | `0.5`                                                   | How often to capture stack traces for flamegraphs in milliseconds.
 flamegraph_mode                     | `:wall`                                                 | The [StackProf mode](https://github.com/tmm1/stackprof#all-options) to pass to `StackProf.run`.
+flamegraph_ignore_gc                | `false`                                                 | Whether to ignore garbage collection frames in flamegraphs.
 base_url_path                       | `'/mini-profiler-resources/'`                           | Path for assets; added as a prefix when naming assets and sought when responding to requests.
 cookie_path                         | `'/'`                                                   | Set-Cookie header path for profile cookie
 collapse_results                    | `true`                                                  | If multiple timing results exist in a single page, collapse them till clicked.

data/lib/mini_profiler/actions.rb

@@ -133,7 +133,7 @@ module Rack
           )
         end
 
-        query_params = Rack::Utils.parse_nested_query(query_string)
+        query_params = Rack::Utils.parse_nested_query(env['QUERY_STRING'])
         options = {
           ignore_files: query_params['memory_profiler_ignore_files'],
           allow_files: query_params['memory_profiler_allow_files'],

data/lib/mini_profiler/config.rb

@@ -30,6 +30,7 @@ module Rack
           @backtrace_threshold_ms = 0
           @flamegraph_sample_rate = 0.5
           @flamegraph_mode = :wall
+          @flamegraph_ignore_gc = false
           @storage_failure = Proc.new do |exception|
             if @logger
               @logger.warn("MiniProfiler storage failure: #{exception.message}")
@@ -76,7 +77,7 @@ module Rack
         :storage_options, :user_provider, :enable_advanced_debugging_tools,
         :skip_sql_param_names, :suppress_encoding, :max_sql_param_length,
         :content_security_policy_nonce, :enable_hotwire_turbo_drive_support,
-        :flamegraph_mode, :profile_parameter
+        :flamegraph_mode, :flamegraph_ignore_gc, :profile_parameter
 
       # ui accessors
       attr_accessor :collapse_results, :max_traces_to_show, :position,

data/lib/mini_profiler/version.rb

@@ -2,7 +2,7 @@
 
 module Rack
   class MiniProfiler
-    VERSION = '3.2.0'
+    VERSION = '3.3.0'
     SOURCE_CODE_URI = 'https://github.com/MiniProfiler/rack-mini-profiler'
   end
 end

data/lib/mini_profiler/views.rb

@@ -161,6 +161,7 @@ module Rack
                 #{make_link "async-flamegraph", env} : store flamegraph data for this page and all its AJAX requests. Flamegraph links will be available in the mini-profiler UI (requires the stackprof gem).
                 #{make_link "flamegraph&flamegraph_sample_rate=1", env}: creates a flamegraph with the specified sample rate (in ms). Overrides value set in config
                 #{make_link "flamegraph&flamegraph_mode=cpu", env}: creates a flamegraph with the specified mode (one of cpu, wall, object, or custom). Overrides value set in config
+                #{make_link "flamegraph&flamegraph_ignore_gc=true", env}: ignore garbage collection frames in flamegraphs. Overrides value set in config
                 #{make_link "flamegraph_embed", env} : a graph representing sampled activity (requires the stackprof gem), embedded resources for use on an intranet.
                 #{make_link "trace-exceptions", env} : will return all the spots where your application raises exceptions
                 #{make_link "analyze-memory", env} : will perform basic memory analysis of heap

data/lib/mini_profiler.rb

@@ -302,11 +302,20 @@ module Rack
               mode = config.flamegraph_mode
             end
 
+            ignore_gc_match_data = action_parameters(env)['flamegraph_ignore_gc']
+
+            if ignore_gc_match_data
+              ignore_gc = ignore_gc_match_data == 'true'
+            else
+              ignore_gc = config.flamegraph_ignore_gc
+            end
+
             flamegraph = StackProf.run(
               mode: mode,
               raw: true,
               aggregate: false,
-              interval: (sample_rate * 1000).to_i
+              interval: (sample_rate * 1000).to_i,
+              ignore_gc: ignore_gc
             ) do
               status, headers, body = @app.call(env)
             end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rack-mini-profiler
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.3.0
 platform: ruby
 authors:
 - Sam Saffron
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-06 00:00:00.000000000 Z
+date: 2023-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack