Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

update readme with rails 3 steps

  • Loading branch information...
commit 7da79d6d19b1da4772d302a326ee999098a23f72 1 parent 047c5e6
@igrigorik authored
Showing with 12 additions and 3 deletions.
  1. +10 −1 README.md
  2. +1 −1  VERSION
  3. +1 −1  rack-speedtracer.gemspec
View
11 README.md
@@ -26,7 +26,7 @@ How it works
Rack::SpeedTracer provides a Tracer class which you can use to instrument your code. From there, the trace details are stored as a JSON blob, and a special X-TraceUrl header is sent back to the client. If the user clicks on the network resource that corresponds to a request which returned a X-TraceUrl header, then SpeedTracer will make a request to our app to load the server side trace. Rack::SpeedTracer responds to this request and returns the full trace - aka, the data is provided on demand.
-### Quickstart Guide ###
+### Quickstart Guide with Rack ###
gem install rack-speedtracer
@@ -40,6 +40,15 @@ Rack::SpeedTracer provides a Tracer class which you can use to instrument your c
Check out a full sample rack app: examples/runner.rb
+### Instrumenting Rails 3 application ###
+Rails 3 provides new [Notifications API](http://edgeapi.rubyonrails.org/classes/ActiveSupport/Notifications.html), which we can use to automatically instrument your Rails applications! It's as easy as:
+
+ # in your Gemfile
+ gem 'rack-speedtracer', :require => 'rack/speedtracer'
+
+ # in development.rb environment
+ config.middleware.use Rack::SpeedTracer
+
### Manually instrumenting Rails ###
To produce a server-side trace equivalent to one in the screenshot above:
View
2  VERSION
@@ -1 +1 @@
-0.1.0
+0.1.1
View
2  rack-speedtracer.gemspec
@@ -5,7 +5,7 @@
Gem::Specification.new do |s|
s.name = %q{rack-speedtracer}
- s.version = "0.1.0"
+ s.version = "0.1.1"
s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
s.authors = ["Ilya Grigorik"]
Please sign in to comment.
Something went wrong with that request. Please try again.