pulse-meter-rails 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rbenv-version

@@ -0,0 +1 @@
+1.9.2-p290

data/.rspec

@@ -0,0 +1 @@
+--color -fd

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in pulse-meter-rails.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 s.averyanov
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,93 @@
+[![Build Status](https://secure.travis-ci.org/averyanov/pulse-meter-rails.png)](http://travis-ci.org/averyanov/pulse-meter-rails)
+
+# PulseToolbox
+Pulse toolbox provides various metrics for your Rails application out of box.
+It is based on [pulse-meter](https://github.com/savonarola/pulse-meter) gem.
+
+Beeing added to Gemfile Pulse Toolbox allows you to mount monitoring page in 
+your <tt>routes.rb</tt> file.
+
+Requests processing times will be displayed there. You can also add custom
+sensors to configuration to be displayed.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'pulse-meter-rails'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pulse-meter-rails
+
+## Usage
+
+Create an initializer with the following config
+
+    PulseToolbox.redis = Redis.new :host => "localhost", :port => 6379, :db => 2
+    PulseToolbox::Server::Monitoring.use Rack::Auth::Basic do |username, password|
+      username == 'admin'
+    end
+
+And mount monitoring server in your <tt>routes.rb</tt>
+
+    mount PulseToolbox::Server::Monitoring, :at => "/monitoring"
+
+Or you can use generator to create initializer and add route:
+    
+    $ bundle exec rails g pulse_toolbox:install
+
+You can add your own groups of sensors to page in initializer:
+    
+    group = PulseToolbox::Sensor::Manager.add_group(:min)
+    PulseToolbox::Sensor::Manager.add_sensor(group, :user_age, {
+        :sensor_type => 'timelined/min',
+        :color => '#0000FF',
+        :args => {
+          :ttl => 10.days,
+          :interval => 10.minutes,
+          :raw_data_ttl => 10.hours,
+          :reduce_delay => 2.minutes,
+          :annotation => "User ages"
+        }
+      }
+    })
+    
+Default layout can be easily exteneded in initializer by standart pulse-meter [DSL](https://github.com/savonarola/pulse-meter#full-example-with-dsl-explanation)
+    
+    PulseMeter::Sensor::Timelined::Counter.new(:custom_sensor,
+      :ttl => 1.hour,
+      :interval => 1.minute,
+      :raw_data_ttl => 10.minutes,
+      :reduce_delay => 2.minutes
+    )
+
+    PulseToolbox::Sensor::Manager.layout do |l|
+      l.page "Custom" do |p|
+        p.spline "Custom sensor" do |w|
+          w.sensor :custom_sensor, :color => "#0000FF"
+
+          w.timespan 60 * 60 * 3
+          w.redraw_interval 10
+
+          w.show_last_point true
+          w.values_label "Time"
+          w.width 10
+        end
+      end
+    end
+
+Launch your application and visit <tt>/monitoring</tt>
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,20 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "yard"
+require "yard/rake/yardoc_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+YARD::Rake::YardocTask.new(:yard)
+
+ROOT = File.dirname(__FILE__)
+
+task :default => :spec
+
+namespace :yard do
+  desc "Open doc index in a browser"
+  task :open do
+    system 'open', "#{ROOT}/doc/index.html"
+  end
+end

data/lib/generators/pulse_toolbox/install_generator.rb

@@ -0,0 +1,20 @@
+require 'rails/generators'
+
+module PulseToolbox
+  class InstallGenerator < ::Rails::Generators::Base
+    def create_initalizer
+      initializer("pulse_toolbox.rb") do
+        data = ""
+        data << "PulseToolbox.redis = Redis.new\n"
+        data << "PulseToolbox::Server::Monitoring.use Rack::Auth::Basic do |username, password|\n"
+        data << "  username == 'admin' && password == 'secret'\n"
+        data << "end\n"
+        data
+      end
+    end
+
+    def add_route
+      route "mount PulseToolbox::Server::Monitoring, :at => '/monitoring'"
+    end
+  end
+end

data/lib/pulse-meter-rails.rb

@@ -0,0 +1,38 @@
+require "active_support"
+require "active_support/all"
+require "pulse-meter"
+
+require "pulse_toolbox/sensor/initializer"
+
+module PulseToolbox
+  extend ActiveSupport::Autoload
+
+  autoload :VERSION, 'pulse_toolbox/version'
+
+  module Generators
+    extend ActiveSupport::Autoload
+    autoload :InstallGenerator
+  end
+
+  module Server
+    extend ActiveSupport::Autoload
+    autoload :Monitoring
+  end
+
+  module Sensor
+    extend ActiveSupport::Autoload
+    autoload :Manager
+    module Mixins
+      extend ActiveSupport::Autoload
+      autoload :Iterators
+    end
+  end
+
+  def self.redis=(redis)
+    PulseMeter.redis = redis
+  end
+
+  def self.redis
+    PulseMeter.redis
+  end
+end

data/lib/pulse_toolbox/sensor/initializer.rb

@@ -0,0 +1,23 @@
+require 'rails'
+
+module PulseToolbox
+  module Sensor
+    # Registeres an initializer which creates sensors and subscribes to
+    # process_action.action_controller notification
+    class Initializer < ::Rails::Railtie
+      initializer "register_request_sensors", :after => :load_config_initializers do
+        if PulseToolbox.redis
+          PulseToolbox::Sensor::Manager.create_sensors
+          ActiveSupport::Notifications.subscribe "process_action.action_controller" do |name, start, finish, id, payload|
+            total_time = (finish - start) * 1000
+            view_time = payload[:view_runtime]
+            db_time = payload[:db_runtime]
+            PulseToolbox::Sensor::Manager.log_request(total_time, view_time, db_time)
+          end
+        else
+          Rails.logger.error("PulseToolbox.redis is not defined. Sensors cannot be created")
+        end
+      end
+    end
+  end
+end

data/lib/pulse_toolbox/sensor/manager.rb

@@ -0,0 +1,181 @@
+module PulseMeter
+  module Sensor
+    class Base
+      attr_accessor :color
+    end
+  end
+end
+
+require 'pulse-meter/visualizer'
+
+module PulseToolbox
+  module Sensor
+    class Manager
+      extend PulseToolbox::Sensor::Mixins::Iterators
+      # @!attribute [rw] default_options
+      #   @return [Hash] default sensor options 
+      class_attribute :default_options
+      # @!attribute [rw] sensors_config
+      #   @return [Hash] sensors config
+      class_attribute :sensors_config
+      # @!attribute [rw] configurator
+      #   @return [PulseMeter::Sensor::Configuration] configurator instance
+      class_attribute :configurator
+      # @!attribute [rw] monitoring_layout
+      #   @return [PulseMeter::Visualize::DSL::Layout] layout for monitoring page
+      class_attribute :monitoring_layout
+
+      self.monitoring_layout = PulseMeter::Visualize::DSL::Layout.new
+
+      self.default_options = {
+        :ttl => 1.day,
+        :interval => 1.minute,
+        :raw_data_ttl => 1.hour,
+        :reduce_delay => 2.minutes
+      }.freeze
+
+      self.sensors_config = {
+        :max => {
+          :title => "Max times",
+          :sensors => {
+            :db_time => {
+              :sensor_type => 'timelined/max',
+              :color => '#0000FF',
+              :args => {
+                :annotation => "DB"
+              }
+            },
+            :view_time => {
+              :sensor_type => 'timelined/max',
+              :color => '#00FF00',
+              :args => {
+                :annotation => "View"
+              }
+            },
+            :total_time => {
+              :sensor_type => 'timelined/max',
+              :color => '#FF0000',
+              :args => {
+                :annotation => "Total"
+              }
+            }
+          }
+        },
+        :p95 => {
+          :title => "95% percentile times",
+          :sensors => {
+            :db_time => {
+              :sensor_type => 'timelined/percentile',
+              :color => '#0000FF',
+              :args => {
+                :annotation => "DB",
+                :p => 0.95
+              }
+            },
+            :view_time => {
+              :sensor_type => 'timelined/percentile',
+              :color => '#00FF00',
+              :args => {
+                :annotation => "View",
+                :p => 0.95
+              }
+            },
+            :total_time => {
+              :sensor_type => 'timelined/percentile',
+              :color => '#FF0000',
+              :args => {
+                :annotation => "Total",
+                :p => 0.95
+              }
+            }
+          }
+        }
+      }
+
+      # Creates all sensors from sensors_config
+      def self.create_sensors
+        config = cfg
+        self.configurator = PulseMeter::Sensor::Configuration.new(cfg)
+        each_sensor do |s|
+          s.color = config[s.name.to_sym][:color]
+        end
+      end
+
+      class << self
+        # Logs rails request timing to various sensors
+        # @param total_time [Float] total request time
+        # @param view_time [Float] view time of request
+        # @param db_time [Float] db time of request
+        def log_request(total_time, view_time, db_time)
+          [
+            [:max_db_time, db_time],
+            [:p95_db_time, db_time],
+            [:max_view_time, view_time],
+            [:p95_view_time, view_time],
+            [:max_total_time, total_time],
+            [:p95_total_time, total_time]
+          ].each {|name, value = e| event(name, value)}
+        end
+        
+        # Sends value to sensor by name
+        # @param sensor [Symbol] sensor name
+        # @param value [Float] event value
+        def event(sensor, value)
+          configurator.sensor(sensor).event(value.to_i)
+        end
+
+        # Adds group to config
+        # @param name [Symbol] group name
+        # @param title [String] group title
+        def add_group(name, title = nil)
+          name = name.to_sym
+          sensors_config[name] ||= {}
+          sensors_config[name][:title] = title if title
+          sensors_config[name][:sensors] ||= {}
+          return name
+        end
+        
+        # Adds sensor to group in config
+        # @param group [Symbol] group name
+        # @param name [Symbol] sensor name
+        # @param options [Hash] sensor options
+        def add_sensor(group, name, options)
+          name = name.to_sym
+          g = add_group(group)
+          sensors_config[g][:sensors][name] = options
+          return name_in_group(group, name)
+        end
+
+        # Returns monitoring page layout
+        def layout
+          yield(monitoring_layout)
+          monitoring_layout
+        end
+        
+      private
+
+        def cfg
+          cfg = {}
+          each_group do |group|
+            sensors_config[group][:sensors].each_pair do |key, params|
+              name = name_in_group(group, key)
+              full_args = default_options.merge(params[:args])
+              params[:args] = default_options.merge(params[:args])
+              cfg[name] = params
+            end
+          end
+          cfg
+        end
+
+        def name_in_group(group, sensor_name)
+          "#{group}_#{sensor_name}".to_sym
+        end
+
+        def get_sensor(group, name)
+          configurator.sensor(name_in_group(group, name))
+        end
+
+      end
+    end
+  end
+end

data/lib/pulse_toolbox/sensor/mixins/iterators.rb

@@ -0,0 +1,54 @@
+module PulseToolbox
+  module Sensor
+    module Mixins
+      module Iterators
+
+        # Executes block for each group
+        # @yieldparam group [Symbol] group name
+        def each_group
+          sensors_config.each_key do |group|
+            yield(group)
+          end
+        end
+
+        # Executes block for each group
+        # @yieldparam group [Symbol] group name
+        # @yieldparam title [String] group title
+        def each_group_with_title
+          sensors_config.each_key do |group|
+            yield(group, sensors_config[group][:title] || group)
+          end
+        end
+
+        # Executes block for each sensor in group
+        # @param group [Symbol] group name
+        # @yieldparam sensor [Symbol] sensor name
+        def each_sensor_in_group(group)
+          sensors_config[group][:sensors].each_key do |name|
+            sensor = get_sensor(group, name)
+            yield(sensor)
+          end
+        end
+
+        # Executes block for each sensor
+        # @yieldparam sensor [Symbol] sensor name
+        def each_sensor
+          each_group do |group|
+            each_sensor_in_group(group) do |sensor|
+              yield(sensor)
+            end
+          end
+        end
+        
+        # Returns all sensors from config
+        # @return [Array<Symbol>] sensors list
+        def sensors
+          list = []
+          each_sensor {|s| list << s}
+          list
+        end
+
+      end
+    end
+  end
+end

data/lib/pulse_toolbox/server/monitoring.rb

@@ -0,0 +1,48 @@
+require 'pulse-meter/visualizer'
+
+module PulseToolbox::Server
+  class Monitoring < PulseMeter::Visualize::App
+    def initialize
+      super(layout)
+    end
+
+    def layout
+      PulseToolbox::Sensor::Manager.layout do |l|
+        l.use_utc false
+
+        l.outlier_color '#FF0000'
+
+        l.highchart_options({
+          x_axis: {
+            min_padding: 0,
+            max_padding: 0
+          }
+        })
+
+        l.page "Requests" do |p|
+          
+          PulseToolbox::Sensor::Manager.each_group_with_title do |group, title|
+            p.spline title do |w|
+              PulseToolbox::Sensor::Manager.each_sensor_in_group(group) do |s|
+                w.sensor s.name, :color => s.color
+              end
+
+              w.timespan 60 * 60 * 3
+              w.redraw_interval 10
+
+              w.show_last_point true
+              w.values_label "Time"
+              w.width 10
+            end
+          end
+
+          p.highchart_options({
+            tooltip: {
+              value_decimals: 0
+            }
+          })
+        end
+      end.to_layout
+    end
+  end
+end

data/lib/pulse_toolbox/version.rb

@@ -0,0 +1,3 @@
+module PulseToolbox
+  VERSION = "0.0.1"
+end

data/pulse-meter-rails.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/pulse_toolbox/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Sergey Averyanov"]
+  gem.email         = ["averyanov@gmail.com"]
+  gem.description   = %q{Pulse meter toolbox}
+  gem.summary       = %q{Contains rails-oriented sensors and mountable visualisation server}
+  gem.homepage      = "https://github.com/averyanov/pulse-meter-rails"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "pulse-meter-rails"
+  gem.require_paths = ["lib"]
+  gem.version       = PulseToolbox::VERSION
+
+  gem.add_runtime_dependency('pulse-meter')
+  gem.add_runtime_dependency('activesupport', '>= 3.0')
+  gem.add_runtime_dependency('rails', '>= 3.0')
+
+  gem.add_development_dependency('capybara')
+  gem.add_development_dependency('rack-test')
+  gem.add_development_dependency('rails')
+  gem.add_development_dependency('rake')
+  gem.add_development_dependency('redcarpet')
+  gem.add_development_dependency('rspec')
+  gem.add_development_dependency('rspec-rails')
+  gem.add_development_dependency('simplecov')
+  gem.add_development_dependency('yard')
+end

data/spec/dummy/.gitignore

@@ -0,0 +1,15 @@
+# See http://help.github.com/ignore-files/ for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile ~/.gitignore_global
+
+# Ignore bundler config
+/.bundle
+
+# Ignore the default SQLite database.
+/db/*.sqlite3
+
+# Ignore all logfiles and tempfiles.
+/log/*.log
+/tmp

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    "application", :media => "all" %>
+  <%= javascript_include_tag "application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/spec/dummy/config/application.rb

@@ -0,0 +1,58 @@
+require File.expand_path('../boot', __FILE__)
+
+require "active_model/railtie"
+require "action_controller/railtie"
+require "action_view/railtie"
+require "action_mailer/railtie"
+
+Bundler.require
+require "pulse-meter-rails"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Custom directories with classes and modules you want to be autoloadable.
+    # config.autoload_paths += %W(#{config.root}/extras)
+
+    # Only load the plugins named here, in the order given (default is alphabetical).
+    # :all can be used as a placeholder for all plugins not explicitly named.
+    # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
+
+    # Activate observers that should always be running.
+    # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # Configure the default encoding used in templates for Ruby 1.9.
+    config.encoding = "utf-8"
+
+    # Configure sensitive parameters which will be filtered from the log file.
+    config.filter_parameters += [:password]
+
+    # Use SQL instead of Active Record's schema dumper when creating the database.
+    # This is necessary if your schema can't be completely dumped by the schema dumper,
+    # like if you have constraints or database-specific column types
+    # config.active_record.schema_format = :sql
+
+    # Enforce whitelist mode for mass assignment.
+    # This will create an empty whitelist of attributes available for mass-assignment for all models
+    # in your app. As such, your models will need to explicitly whitelist or blacklist accessible
+    # parameters by using an attr_accessible or attr_protected declaration.
+    # config.active_record.whitelist_attributes = true
+
+    # Enable the asset pipeline
+    config.assets.enabled = true
+
+    # Version of your assets, change this if you want to expire all your assets
+    config.assets.version = '1.0'
+  end
+end