README.md in rack-insight-0.5.23 vs README.md in rack-insight-0.5.24
- old
+ new
@@ -1,6 +1,6 @@
-Rack::Insight
+Rack::Insight [](https://gemnasium.com/pboling/rack-insight) [](https://codeclimate.com/github/pboling/rack-insight) [](https://travis-ci.org/pboling/rack-insight) [](http://coderwall.com/pboling)
=============
Rack::Insight began life as an fork of Logical::Insight by LRDesign.
* I started a fork because:
@@ -41,21 +41,28 @@
* Log (can configure which loggers to watch!)
* Memory
* SQL (Failing specs, and I don't use it, someone please pull me a fix!)
* Active Record (Failing specs, and I don't use it, someone please pull me a fix!)
* Other bundled panels:
+ * Sphinx (thanks to Oggy for updating this to the rack-insight panel API)
* Redis
* Speedtracer
- * Retired panels - if needed they could come back quickly:
- * Sphinx
+ * Panels under construction:
* Mongo
* The API for adding your own panels is simple and very powerful
* Consistent interface to instrument application code
* Consistent timing across panels
* Easy to add sub-applications for more detailed reports (c.f. SQLPanel)
* Ask me (pboling) if you need help with this.
+Build Status
+---------------------------
+
+Travis-ci: [](https://travis-ci.org/pboling/rack-insight) - Please help if you have time!
+
+CodeClimate: [](https://codeclimate.com/github/pboling/rack-insight)
+
Rails quick start
---------------------------
Add this to your Gemfile
gem "rack-insight"
@@ -151,11 +158,12 @@
request_variables_panel
redis_panel
templates_panel
cache_panel
log_panel
- memory_panel
+ memory_panel,
+ sphinx_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.
@@ -209,11 +217,11 @@
:ip_masks => false # Default is 127.0.0.1
:password => "yourpassword"
#### custom file path for the request recording database ####
-Logical Rack::Insight uses SQLite to store data from requests, and outputs a database
+Rack::Insight uses SQLite to store data from 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.
ActionController::Dispatcher.middleware.use "Rack::Insight::App"
:secret_key => "someverylongandveryhardtoguesspreferablyrandomstring",
@@ -239,11 +247,11 @@
end
Custom Panels
-------------
-See Magic Panels above, remove teh is_magic declaration, and add your own methods.
+See Magic Panels above, remove the is_magic declaration, and add your own methods.
Look at the panels bundled with this gem for pointers. Here are some important methods to watch for:
* initialize
* after_detect
* content_for_request(number)
@@ -257,11 +265,11 @@
- 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.
+in there. Many thanks to Judson, and Bryan for building them.
Inspiration for Rack::Bug is primarily from the Django debug toolbar.
Additional ideas from Rails footnotes, Rack's ShowException middleware, Oink,
and Rack::Cache
@@ -271,18 +279,16 @@
MIT. See LICENSE in this directory.
Notes
-----
+The ActiveRecord panel doesn't seem to work currently. Probably something minor, but haven't had time to look into it.
+
Legacy files: would like to re-include them, but they need work
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/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/rack/insight/panels/speedtracer_panel/profiling.rb