README.md in rack-insight-0.5.0 vs README.md in rack-insight-0.5.1
- old
+ new
@@ -88,20 +88,21 @@
:panel_files => %w[
timer_panel
request_variables_panel
redis_panel
templates_panel
+ cache_panel
log_panel
memory_panel
]
By default panel files are looked up by prepending "rack/insight/panels/" and requiring them.
Subclasses of Rack::Insight::Panel are loaded and added to the toolbar. This makes
it easier to work with the configuration and extend Rack::Insight with plugin gems.
If you need to customize the load paths where Rack::Insight will look for panels you can configure the load paths in an
-initializer. Example config/initializers/rack_insight.rb:
+initializer, or in your gem prior to requiring your panels. Example config/initializers/rack_insight.rb:
Rack::Insight::Config.configure do |config|
# Note: The parent directory of the 'special' directory must already be in Ruby's load path.
config[:panel_load_paths] = File.join('special','path')
@@ -112,10 +113,16 @@
# Example 2: Add your custom path to the existing load paths, to have your panels join the party!
config[:panel_load_paths] << 'custom/panels'
end
+When you create custom panels use the render_template method and pass it the path to the view to be rendered
+*relative to the panel load path you added above*:
+
+ # with Example #2 from above, will try to render 'custom/panels/thunder_panel/views/thor.html.erb'
+ render_template 'thunder_panel/views/thor'
+
Running Rack::Insight in staging or production
------------------------------------------
We have have found that Rack::Insight is fast enough to run in production for specific troubleshooting efforts.
@@ -151,13 +158,14 @@
:database_path => "tmp/my_insight_db.sqlite"
Authors
-------
-- Maintained by [Judson Lester](mailto:judson@lrdesign.com)
-- Contributions from Luke Melia, Joey Aghion, Tim Connor, and more
-- Based on Rack::Bug by Bryan Helmkamp
+- Maintained by [Peter Boling](mailto:peter.boling@gmail.com)
+- Based on LogicalInsight by Judson Lester
+ - Contributions from Luke Melia, Joey Aghion, Tim Connor, and more
+ - Which in turn was based on Rack::Bug by Bryan Helmkamp
Thanks
------
Rack::Insight owes a lot to both LogicalInsight and Rack::Bug, as the basis projects. There's a lot of smart
in there. Many thanks to Evan, Judson, and Bryan for building them.
@@ -167,23 +175,23 @@
and Rack::Cache
License
-------
-See LICENSE.txt in this directory.
+See LICENSE in this directory.
Notes
-----
Legacy files: would like to re-include them, but they need work
- lib/insight/views/panels/mongo.html.erb
- lib/insight/panels/mongo_panel/mongo_extension.rb
- lib/insight/panels/mongo_panel/stats.rb
- lib/insight/panels/mongo_panel.rb
+ lib/rack/insight/views/panels/mongo.html.erb
+ lib/rack/insight/panels/mongo_panel/mongo_extension.rb
+ lib/rack/insight/panels/mongo_panel/stats.rb
+ lib/rack/insight/panels/mongo_panel.rb
- lib/insight/views/panels/sphinx.html.erb
- lib/insight/panels/sphinx_panel/stats.rb
- lib/insight/panels/sphinx_panel.rb
+ lib/rack/insight/views/panels/sphinx.html.erb
+ lib/rack/insight/panels/sphinx_panel/stats.rb
+ lib/rack/insight/panels/sphinx_panel.rb
This one is mostly just a curiosity
- lib/insight/panels/speedtracer_panel/profiling.rb
+ lib/rack/insight/panels/speedtracer_panel/profiling.rb