librato-rails 0.3.0

data/lib/librato/rails/counter_cache.rb

@@ -0,0 +1,41 @@
+module Librato
+  module Rails
+    
+    class CounterCache
+      extend Forwardable
+    
+      def_delegators :@cache, :empty?
+    
+      def initialize
+        @cache = {}
+        @lock = Mutex.new
+      end
+    
+      def [](key)
+        @lock.synchronize { @cache[key.to_s] }
+      end
+      
+      def delete_all
+        @lock.synchronize { @cache.clear }
+      end
+      
+      def flush_to(queue)
+        @lock.synchronize do
+          @cache.each do |key, value| 
+            queue.add key => {:type => :counter, :value => value}
+          end
+        end
+      end
+    
+      def increment(counter, by=1)
+        counter = counter.to_s
+        @lock.synchronize do
+          @cache[counter] ||= 0
+          @cache[counter] += by
+        end
+      end
+    
+    end
+    
+  end
+end

data/lib/librato/rails/group.rb

@@ -0,0 +1,27 @@
+module Librato
+  module Rails
+    class Group
+      
+      def initialize(prefix)
+        @prefix = "#{prefix}."
+      end
+      
+      def group(prefix)
+        prefix = "#{@prefix}#{prefix}"
+        yield self.class.new(prefix)
+      end
+      
+      def increment(counter, by=1)
+        counter = "#{@prefix}#{counter}"
+        Librato::Rails.increment counter, by
+      end
+      
+      def measure(event, duration)
+        event = "#{@prefix}#{event}"
+        Librato::Rails.measure event, duration
+      end
+      alias :timing :measure
+      
+    end
+  end
+end

data/lib/librato/rails/helpers.rb

@@ -0,0 +1,19 @@
+# Helpers included into controllers and models.
+
+module Librato
+  module Rails
+    module Helpers
+      
+      # convenience accessor
+      def metrics
+        Librato::Rails
+      end
+      
+    end
+    
+    # ::ActionController::Base.send(:include, Helpers)
+    # 
+    # ::ActiveRecord::Base.send(:include, Helpers)
+    # ::ActiveRecord::Base.send(:extend, Helpers)
+  end
+end

data/lib/librato/rails/railtie.rb

@@ -0,0 +1,18 @@
+module Librato
+  module Rails
+    class Railtie < ::Rails::Railtie
+
+      # make configuration proxy for config inside Rails
+      config.librato_rails = Librato::Rails
+
+      initializer 'librato_rails.setup' do |app|
+        # don't start in test mode or in the console
+        unless ::Rails.env.test? || defined?(::Rails::Console)
+          Librato::Rails.setup
+
+          app.middleware.use Librato::Rack::Middleware
+        end
+      end
+    end
+  end
+end

data/lib/librato/rails/subscribers.rb

@@ -0,0 +1,77 @@
+module Librato
+  module Rails
+  
+    # controllers
+    
+    ActiveSupport::Notifications.subscribe /process_action.action_controller/ do |*args|
+  
+      event = ActiveSupport::Notifications::Event.new(*args)
+      controller = event.payload[:controller]
+      action = event.payload[:action]
+  
+      format = event.payload[:format] || "all"
+      format = "all" if format == "*/*"
+      status = event.payload[:status]
+      exception = event.payload[:exception]
+      # page_key = "request.#{controller}.#{action}_#{format}."
+  
+      group "#{Librato::Rails.prefix}.request" do |r|
+   
+        r.increment 'total'
+        r.timing    'time', event.duration
+      
+        if exception
+          r.increment 'exceptions'
+        else
+          r.timing 'time.db', event.payload[:db_runtime] || 0
+          r.timing 'time.view', event.payload[:view_runtime] || 0
+        end
+      
+        unless status.blank?
+          r.group 'status' do |s|
+            s.increment status
+            s.increment "#{status.to_s[0]}xx"
+            s.timing "#{status}.time", event.duration
+            s.timing "#{status.to_s[0]}xx.time", event.duration
+          end
+        end
+      
+        r.increment 'slow' if event.duration > 200.0
+      end # end group
+      
+    end # end subscribe
+  
+    # SQL
+    
+    ActiveSupport::Notifications.subscribe 'sql.active_record' do |*args|
+      payload = args.last
+  
+      group "#{Librato::Rails.prefix}.sql" do |s|
+        # puts (event.payload[:name] || 'nil') + ":" + event.payload[:sql] + "\n"
+        s.increment 'queries'
+        
+        sql = payload[:sql].strip
+        s.increment 'selects' if sql.starts_with?('SELECT')
+        s.increment 'inserts' if sql.starts_with?('INSERT')
+        s.increment 'updates' if sql.starts_with?('UPDATE')
+        s.increment 'deletes' if sql.starts_with?('DELETE')
+      end
+    end
+    
+    # ActionMailer
+    
+    ActiveSupport::Notifications.subscribe 'deliver.action_mailer' do |*args|
+      # payload[:mailer] => 'UserMailer'
+      group "#{Librato::Rails.prefix}.mail" do |m|
+        m.increment 'sent'
+      end
+    end
+    
+    ActiveSupport::Notifications.subscribe 'receive.action_mailer' do |*args|
+      group "#{Librato::Rails.prefix}.mail" do |m|
+        m.increment 'received'
+      end
+    end
+  
+  end
+end

data/lib/librato/rails/version.rb

@@ -0,0 +1,5 @@
+module Librato
+  module Rails
+    VERSION = "0.3.0"
+  end
+end

data/lib/librato/rails/worker.rb

@@ -0,0 +1,58 @@
+module Librato
+  module Rails
+    
+    # This class manages the background thread which submits all data
+    # to the Librato Metrics service.
+    class Worker
+      
+      def initialize
+        @interrupt = false
+      end
+      
+      # do the assigned work, catching some special cases
+      #
+      def execute(obj)
+        obj.call
+      end
+      
+      def logger
+        Librato::Rails.logger
+      end
+      
+      # run the given block every <period> seconds, looping
+      # infinitely unless @interrupt becomes true.
+      #
+      def run_periodically(period, &block)
+        next_run = start_time(period)
+        until @interrupt do
+          now = Time.now
+          if now >= next_run
+            execute(block) # runs given block
+            while next_run <= now
+              next_run += period
+            end
+          else
+            sleep (next_run - now)
+          end
+        end
+      end
+      
+      # Give some structure to worker start times so when possible
+      # they will be in sync.
+      def start_time(period)
+        earliest = Time.now + period
+        # already on a whole minute
+        return earliest if earliest.sec == 0 
+        if period > 30
+          # bump to whole minute
+          earliest + (60-earliest.sec)
+        else
+          # ensure sync to whole minute if minute is evenly divisible
+          earliest + (period-(earliest.sec%period))
+        end
+      end
+      
+    end
+    
+  end
+end

data/lib/tasks/metrics-rails_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :librato-rails do
+#   # Task goes here
+# end

data/test/dummy/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |       |-- images
+  |       |-- javascripts
+  |       `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   |-- cache
+  |   |-- pids
+  |   |-- sessions
+  |   `-- sockets
+  `-- vendor
+      |-- assets
+          `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.