README.md in rack-insight-0.5.26 vs README.md in rack-insight-0.5.27
- old
+ new
@@ -6,11 +6,11 @@
Description
-----------
Rack::Insight adds a diagnostics toolbar to Rack apps. When enabled, it injects a floating div
-allowing exploration of logging, database queries, template rendering times, etc. Rack::Insight
+allowing exploration of logging, database queries, template rendering times, etc. Rack::Insight
stores debugging info over many requests, incuding AJAX requests.
Features
--------
@@ -23,11 +23,11 @@
* Request Variables
* Cache
* Templates
* Log (can configure which loggers to watch!)
* Memory
- * SQL (Failing specs, and I don't use it, someone please pull me a fix!)
+ * SQL
* Active Record (Thanks to [Kevin Glowacz](https://github.com/kjg) for the fix!)
* Other bundled panels:
* Sphinx (thanks to Oggy for updating this to the rack-insight panel API)
* Redis
* Speedtracer
@@ -57,23 +57,20 @@
config.middleware.use "Rack::Insight::App",
:secret_key => "someverylongandveryhardtoguesspreferablyrandomstring"
Any environment with Rack::Insight loaded will have a link to "Rack::Insight" added to as
-the last child of BODY to normal responses. Clicking that link will load the
+the last child of `<body>` to normal responses. Clicking that link will load the
toolbar. It's set with an id of "rack-insight-enabler", so it can be styled
to go somewhere more noticeable. E.g. "position: absolute; top: 0; left: 0"
Using with non-Rails Rack apps
------------------------------
Just 'use Rack::Insight' as any other middleware. See the SampleApp in the
spec/fixtures folder for an example Sinatra app.
-If you wish to use the logger panel define the LOGGER constant that is a ruby
-Logger or ActiveSupport::BufferedLogger
-
Configure Rack::Insight
---------------------
Pattern:
@@ -89,15 +86,15 @@
:log_file - The logdev parameter for the Ruby Logger (a file path, an IO, like STDOUT, or STDERR, etc)
:log_level - The maximum severity at which things should be logged.
:rails_log_copy - If you are setting :logger to the Rails Logger, you should set this to false (default is true).
- :verbosity - true is default .
+ :verbosity - true is default.
true is equivalent to relying soley on the logger's log level to determine if a message is logged.
Other potential values are:
anything falsey => no logging at all
- Rack::Insight::Logging::VERBOSITY[*level*] where *level* is one of:
+ Rack::Insight::Config::VERBOSITY[*level*] where *level* is one of:
:debug, :high, :med, :low, :silent
:panel_load_paths => [File::join('rack', 'insight', 'panels')] (default)
See *Configuring custom panels* section for example usage
@@ -204,12 +201,14 @@
:ip_masks => false # Default is 127.0.0.1
:password => "yourpassword"
#### custom file path for the request recording database ####
-Rack::Insight uses SQLite to store data from requests, and outputs a database
+Rack::Insight uses SQLite to store data across requests, and outputs a database
file in the root directory. If you need the file to be created at another
location (i.e. Heroku), you can pass a custom file path.
+
+Please report back if you have success with this on Heroku!
ActionController::Dispatcher.middleware.use "Rack::Insight::App"
:secret_key => "someverylongandveryhardtoguesspreferablyrandomstring",
:database_path => "tmp/my_insight_db.sqlite"