Skip to content

Commit f4d12ae

Browse files
committed
Merge pull request #148 from cgunther/readme-backtrace
Update readme to document backtrace config options
2 parents b11b830 + 884f572 commit f4d12ae

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ To disable this behavior, use the following config setting:
121121

122122
```ruby
123123
# Do not let rack-mini-profiler disable caching
124-
Rack::MiniProfiler.config.disable_caching = false # defaults to true
124+
Rack::MiniProfiler.config.disable_caching = false # defaults to true
125125
```
126126

127127
### Storage
@@ -182,7 +182,9 @@ The available configuration options are:
182182
* skip_paths - Specifies path list that can be skipped.
183183
* skip_schema_queries - Whether or not you want to log the queries about the schema of your tables. Default is 'false', 'true' in rails development.
184184
* auto_inject (default true) - when false the miniprofiler script is not injected in the page
185-
* backtrace_filter - a regex you can use to filter out unwanted lines from the backtraces
185+
* backtrace_ignores (default nil) - an array of regexes you can use to filter out unwanted lines from the backtraces
186+
* backtrace_includes (default nil, or [/^\/?(app|config|lib|test)/] in rails) - an array of regexes you can use to keep lines in the backtrace
187+
* backtrace_remove (default nil, or Rails.root in rails) - A string or regex to remove part of each line in the backtrace
186188
* toggle_shortcut (default Alt+P) - a jquery.hotkeys.js-style keyboard shortcut, used to toggle the mini_profiler's visibility. See https://github.com/jeresig/jquery.hotkeys for more info.
187189
* start_hidden (default false) - Whether or not you want the mini_profiler to be visible when loading a page
188190
* backtrace_threshold_ms (default zero) - Minimum SQL query elapsed time before a backtrace is recorded. Backtrace recording can take a couple of milliseconds on rubies earlier than 2.0, impacting performance for very small queries.

0 commit comments

Comments
 (0)