healthyr 0.5

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MTIzOWNmZTllNTRjYmZmNGRhODAyNDIwZWIyNDE5MGM2OWEzOTgyMw==
+  data.tar.gz: !binary |-
+    YWU1NGI2NDBiZTExMDNhN2I2MzI3ZGYxMGViMjE3ZjFmMTc0NGZhYQ==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    NDBiNTE0ZGNhMGZlY2E3OGY0MTQ2ZDQ0MWU0NzY0MDk1Nzc5ZmE4NjhhYTdi
+    M2RmNmVhNjFmNjVhMTA4M2E0YTg4ZjU2MTRlYWNmYTQwNTI2YjlmZTBjNGRk
+    OGQ3MDRhMWIzMzIxMTc5NzVhNzRiOGJlYjJjMGFlNWE5ZTUzYzU=
+  data.tar.gz: !binary |-
+    Mzk1NDhkODBlNDI0OGJjNjhjNmRiNWFiYjExOTBiZDM5ZDI5ZDhhYTM2MjFj
+    MGNjMTExZDgyZTcxZmNjY2FiY2MwMDQ5NGUzNzgwNmZiZDUxZmFhODczZmYw
+    OWY5N2QwZWFjMjM1MzIxYTFmMzBlYjJkNjM2MmY4OWUzNjNhMjg=

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/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 elvio
+
+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,32 @@
+# Healthyr
+Healthyr is a performance monitor for Ruby on Rails applications. It takes advantage of [ActiveSupport::Notifications](http://api.rubyonrails.org/classes/ActiveSupport/Notifications.html) instruments to help you find slow parts of your app.
+
+## Installation
+
+* Add healthyr to your Rails Gemfile:
+
+   gem 'healthyr'
+
+* Clone the application monitor
+
+   git clone https://github.com/elvio/healthyr\_monitor
+
+* Start the monitor
+
+   $ rackup config.ru --port=[PORT]
+
+* Start your Rails app with HEALTHYR\_MONITOR\_URL environment variable pointing to the monitor you have started
+
+   $ HEALTHYR\_MONITOR\_URL="http://[SERVER]:[PORT]" rails s
+
+## Usage
+
+* Access the monitor URL to have access to charts and data about the slowest parts of your application (database, view and controller)
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+#!/usr/bin/env rake
+
+require 'rubygems'
+require "bundler/gem_tasks"
+require 'rake'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)

data/healthyr.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "healthyr"
+  spec.version       = "0.5"
+  spec.authors       = ["elvio"]
+  spec.email         = ["elvio@elviovicosa.com"]
+  spec.description   = %q{Healthyr is a simple Ruby on Rails app performance monitor. It takes advantage of ActiveSupport::Notifications instruments to help you find slow portions of your app.}
+  spec.summary       = %q{Healthyr is a simple Ruby on Rails app performance monitor.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/healthyr.rb

@@ -0,0 +1,36 @@
+require 'rails'
+require 'net/http'
+require 'healthyr/event'
+require 'healthyr/event_handler'
+require 'healthyr/event_agent'
+require 'healthyr/event_pool'
+
+module Healthyr
+  def self.boot(app)
+    start_event_handler
+    start_event_agent
+  end
+
+  def self.start_event_handler
+    EventHandler.new
+  end
+
+  def self.start_event_agent
+    EventAgent.new(monitor_url, update_interval)
+  end
+
+  def self.monitor_url
+    if ENV['HEALTHYR_MONITOR_URL']
+      URI.parse(ENV['HEALTHYR_MONITOR_URL'] + "/events")
+    else
+      raise ArgumentError.new "Healthyr could not find environment variable: HEALTHYR_MONITOR_URL"
+    end
+  end
+
+  def self.update_interval
+    interval = ENV['HEALTHYR_UPDATE_INTERVAL'].to_i
+    interval < 5 ? 5 : interval
+  end
+end
+
+require 'healthyr/railtie'

data/lib/healthyr/event.rb

@@ -0,0 +1,43 @@
+module Healthyr
+  class Event
+    attr_accessor :event
+
+    def initialize(*args)
+      @event = ActiveSupport::Notifications::Event.new(*args)
+    end
+
+    def to_hash
+      {reported_at: Time.at(event.time), time: {total: event.duration}}.tap do |hash|
+        if database?
+          hash[:name] = 'database'
+          hash[:value] = payload[:sql]
+        elsif view?
+          hash[:name] = 'view'
+          hash[:value] = payload[:virtual_path]
+        elsif controller?
+          hash[:name] = 'controller'
+          hash[:value] = "#{payload[:controller]}##{payload[:action]}"
+          hash[:time][:view] = payload[:view_runtime]
+          hash[:time][:db] = payload[:db_runtime]
+        end
+      end
+    end
+
+    private
+    def payload
+      @payload ||= event.payload
+    end
+
+    def database?
+      event.name == 'sql.active_record'
+    end
+
+    def view?
+      event.name == '!render_template.action_view'
+    end
+
+    def controller?
+      event.name == 'process_action.action_controller'
+    end
+  end
+end

data/lib/healthyr/event_agent.rb

@@ -0,0 +1,49 @@
+module Healthyr
+  class EventAgent
+
+    def initialize(monitor_url, update_interval)
+      AgentThread.new(update_interval) do
+        events = EventPool.flush
+        envelope = Envelope.new(events)
+
+        begin
+          response = Net::HTTP.post_form(monitor_url, {data: envelope.content})
+          if response.code != 200
+            Rails.logger.error "Healthyr failed to send data to monitor"
+          end
+        rescue Errno::ECONNREFUSED
+          Rails.logger.error "Healthyr could not connect to '#{monitor_url}'"
+        end
+      end
+    end
+
+    private
+
+    class Envelope
+      def initialize(events)
+        @events = events
+      end
+
+      def content
+        Hash[from: instance_id, events: @events.map(&:to_hash)].to_json
+      end
+
+      def instance_id
+        "#{Socket.gethostname}-#{$$}"
+      end
+    end
+
+    class AgentThread
+      def initialize(duration, &block)
+        Thread.abort_on_exception = true
+        Thread.new do
+          while true
+            sleep duration
+            block.call
+          end
+        end
+      end
+    end
+
+  end
+end

data/lib/healthyr/event_handler.rb

@@ -0,0 +1,15 @@
+module Healthyr
+  class EventHandler
+    EVENT_NAMES = /sql\.active_record|!render_template\.action_view|process_action\.action_controller/
+
+    def initialize
+      ActiveSupport::Notifications.subscribe(EVENT_NAMES) do |*args|
+        event_received(Event.new(*args))
+      end
+    end
+
+    def event_received(event)
+      EventPool.add(event)
+    end
+  end
+end

data/lib/healthyr/event_pool.rb

@@ -0,0 +1,26 @@
+module Healthyr
+  class EventPool
+    @@elements = []
+    @@mutex = Mutex.new
+
+    def self.add(element)
+      @@mutex.synchronize do
+        @@elements << element
+      end
+    end
+
+    def self.flush
+      _elements = []
+      @@mutex.synchronize do
+        _elements = @@elements.dup
+        @@elements = []
+      end
+
+      _elements
+    end
+
+    def self.elements
+      @@elements
+    end
+  end
+end

data/lib/healthyr/railtie.rb

@@ -0,0 +1,7 @@
+module Healthyr
+   class Railtie < Rails::Railtie
+     initializer 'healthyr.configure' do |app|
+       Healthyr.boot(app)
+     end
+   end
+end

data/spec/event_agent_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+require 'json'
+
+module Healthyr
+  describe EventAgent do
+    class EventAgent::AgentThread
+      def initialize(duration, &block)
+        block.call
+      end
+    end
+
+    class EventAgent::Envelope
+      def instance_id
+        "test-10"
+      end
+    end
+
+    let(:monitor_url) { "http://monitor-url" }
+    let(:update_interval) { 10 }
+
+
+    describe "#initialize" do
+      let(:event1) { stub("Event1", to_hash: Hash[name: "event1"]) }
+      let(:event2) { stub("Event2", to_hash: Hash[name: "event2"]) }
+      let(:data) { {from: 'test-10', events: [event1.to_hash, event2.to_hash]}.to_json }
+      let(:response) { stub("Response", code: 200) }
+
+      before do
+        EventPool.add(event1)
+        EventPool.add(event2)
+      end
+
+      it "sends the events data to monitor" do
+        Net::HTTP.should_receive(:post_form).with(monitor_url, {data: data}).and_return(response)
+        EventAgent.new(monitor_url, update_interval)
+      end
+    end
+  end
+end

data/spec/event_handler_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+module Healthyr
+  describe EventHandler do
+    describe ".start" do
+      it "subscribes to ActiveSupport::Notifications" do
+        ActiveSupport::Notifications.should_receive(:subscribe).with(EventHandler::EVENT_NAMES)
+        described_class.new
+      end
+    end
+
+    describe ".event_received" do
+      let(:event) { stub("Event") }
+
+      before do
+        ActiveSupport::Notifications.stub(:subscribe)
+      end
+
+      subject do
+        described_class.new
+      end
+
+      it "adds a new event to the event pool" do
+        EventPool.should_receive(:add).with(event)
+        subject.event_received(event)
+      end
+    end
+  end
+end

data/spec/event_pool_spec.rb

@@ -0,0 +1,26 @@
+module Healthyr
+  describe EventPool do
+    let(:event1) { stub("Event1") }
+    let(:event2) { stub("Event2") }
+
+    before do
+      EventPool.flush
+      EventPool.add(event1)
+      EventPool.add(event2)
+    end
+
+    describe '.add' do
+      it 'adds a new element to the pool' do
+        EventPool.elements.should == [event1, event2]
+      end
+    end
+
+    describe '.flush' do
+      it 'cleans the pool and return the elements' do
+        flushed = EventPool.flush
+        flushed.should == [event1, event2]
+        EventPool.elements.should == []
+      end
+    end
+  end
+end

data/spec/event_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+module Healthyr
+  describe Event do
+    let(:transaction_id) { "38bb3fae1c76bbfb5c1c" }
+    let(:starts) { 1363158057 }
+    let(:ends) { 1363158067 }
+    let(:event_time) { Time.at(starts) }
+    let(:args) { [event_type, starts, ends, transaction_id, payload] }
+    let(:duration) { 10000.0 }
+
+    subject { Event.new(*args).to_hash }
+
+    context 'database event' do
+      let(:sql_query) { %q{SELECT "users".* FROM "users"} }
+      let(:event_type) { "sql.active_record" }
+      let(:payload) { Hash[sql: sql_query] }
+
+      it { should == Hash[name: 'database', value: sql_query, time: {total: duration}, reported_at: event_time]}
+    end
+
+    context 'view event' do
+      let(:event_type) { '!render_template.action_view' }
+      let(:view_path) { 'users/index' }
+      let(:payload) { Hash[virtual_path: view_path] }
+
+      it { should == Hash[name: 'view', value: view_path, time: {total: duration}, reported_at: event_time]}
+    end
+
+    context 'controller event' do
+      let(:event_type) { 'process_action.action_controller' }
+      let(:view_runtime) { 10.4 }
+      let(:db_runtime) { 1.98 }
+      let(:payload) { Hash[controller: 'UsersController', action: 'index', view_runtime: view_runtime, db_runtime: db_runtime] }
+
+      it { should == Hash[name: 'controller', value: 'UsersController#index', time: {total: duration, view: view_runtime, db: db_runtime}, reported_at: event_time] }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'healthyr'

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: healthyr
+version: !ruby/object:Gem::Version
+  version: '0.5'
+platform: ruby
+authors:
+- elvio
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Healthyr is a simple Ruby on Rails app performance monitor. It takes
+  advantage of ActiveSupport::Notifications instruments to help you find slow portions
+  of your app.
+email:
+- elvio@elviovicosa.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- healthyr.gemspec
+- lib/healthyr.rb
+- lib/healthyr/event.rb
+- lib/healthyr/event_agent.rb
+- lib/healthyr/event_handler.rb
+- lib/healthyr/event_pool.rb
+- lib/healthyr/railtie.rb
+- spec/event_agent_spec.rb
+- spec/event_handler_spec.rb
+- spec/event_pool_spec.rb
+- spec/event_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.0
+signing_key: 
+specification_version: 4
+summary: Healthyr is a simple Ruby on Rails app performance monitor.
+test_files:
+- spec/event_agent_spec.rb
+- spec/event_handler_spec.rb
+- spec/event_pool_spec.rb
+- spec/event_spec.rb
+- spec/spec_helper.rb