oink 0.1.2 → 0.9.1

data/README.rdoc

@@ -26,47 +26,33 @@ Currently oink can only parse logs in the Hodel3000Logger format
 
 When used as a gem, this is automatically brought in as a dependency.
 
-=== Installation and configuration
+=== Installation
 
-To begin, you'll want to install it:
+Add oink to your Gemfile
 
-  gem install oink
+gem "oink"
 
-Next, you'll need to update your config/environment.rb to include oink as a dependency, and to configure Rails to use the hodel_3000_compliant_logger: 
+In most rails environments this is sufficient and oink will be required for you via bundler. If not, add a require statement "require 'oink'" in your app.
 
-  Rails::Initializer.run do |config|
-    # your other config here
-    config.gem 'oink'
-    begin
-      require 'hodel_3000_compliant_logger'
-      config.logger = Hodel3000CompliantLogger.new(config.log_path)
-    rescue LoadError => e
-      $stderr.puts "Hodel3000CompliantLogger unavailable, oink will be disabled"
-    end
-  end
-   
+=== Configuration
 
-Oink allows you to add two type of statistics to your log output: memory usage and number of ActiveRecord objects instantiated. Here's an example for the output you can get:
+Oink is middleware for instrumentation during the runtime of your application as well as log parsers for offline crunching of the logs generated by
+the middleware.
 
-  Feb 08 11:39:54 ey33-s00302 rails[9076]: Memory usage: 316516 | PID: 9076
-  Feb 27 13:21:04 ey04-s00295 rails[11862]: Instantiation Breakdown: Total: 73 | User: 34 | Group: 20 | Medium: 20 | Sport: 10 | Post: 4 | Discussion: 2
-
-For memory usage, add this to app/controllers/application_controller.rb: 
+The middleware class to include into your stack is "Oink::Middleware". In rails this can be included by adding the following to your
+application.rb or environment.rb file:
 
-  class ApplicationController
-    include Oink::MemoryUsageLogger
-  end
+config.middleware.use "Oink::Middleware"
 
-For ActiveRecord objects instantiated, add this to your app/controllers/application_controller.rb:
+or in an initializer, you can also include it:
 
-  class ApplicationController
-    include Oink::InstanceTypeCounter
-  end
+YouApplication::Application.middleware.use Oink::Middleware
 
+Note that the previous way of configuring oink, as a set of modules to include into rails controllers, is deprecated and is set to be removed shortly.
 
-== Analyizing logs
+== Analyzing logs
 
-After installing the plugin and aggregating some enhanced logs, run the 'oink' executable against your server logs. 
+After installing the plugin and aggregating some enhanced logs, run the 'oink' executable against your server logs.
 
   Usage: oink [options] files
       -t, --threshold [INTEGER]        Memory threshold in MB

data/Rakefile

@@ -1,14 +1,12 @@
-require 'rubygems'
 require "rake/gempackagetask"
 require "rake/clean"
-require "spec/rake/spectask"
-require './lib/oink/base.rb'
+require "rspec/core/rake_task"
 
 begin
   require 'jeweler'
   Jeweler::Tasks.new do |s|
     s.name         = "oink"
-    s.version      = Oink::Base::VERSION
+    s.version      = "0.9.1"
     s.author       = "Noah Davis"
     s.email        = "noahd1" + "@" + "yahoo.com"
     s.homepage     = "http://github.com/noahd1/oink"
@@ -23,8 +21,8 @@ rescue LoadError
   puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
 end
 
-Spec::Rake::SpecTask.new do |t|
-  t.spec_opts == ["--color"]
+RSpec::Core::RakeTask.new do |t|
+  t.rspec_opts == ["--color"]
 end
 
 desc "Run the specs"

data/bin/oink

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
 
-require File.dirname(__FILE__) + "/../lib/oink.rb"
-Cli.new(ARGV.dup).process
+require File.dirname(__FILE__) + "/../lib/oink/cli.rb"
+Oink::Cli.new(ARGV.dup).process
 

data/lib/oink.rb

@@ -1,9 +1 @@
-$:.unshift(File.dirname(__FILE__ + '.rb') + '/../lib') unless $:.include?(File.dirname(__FILE__ + '.rb') + '/../lib')
-
-require "oink/memory_usage_reporter"
-require "oink/active_record_instantiation_reporter"
-require "oink/cli"
-
-if defined?(Rails)
-  require 'oink/rails'
-end
+require 'oink/middleware'

data/lib/oink/cli.rb

@@ -1,97 +1,101 @@
 require 'optparse'
+require 'oink/reports/base'
+require 'oink/reports/active_record_instantiation_report'
+require 'oink/reports/memory_usage_report'
 
-class Cli
-  
-  def initialize(args)
-    @args = args
-  end
-  
-  def process
-    options = { :format => :short_summary, :type => :memory }
+module Oink
+  class Cli
 
-    op = OptionParser.new do |opts|
-      opts.banner = "Usage: oink [options] files"
+    def initialize(args)
+      @args = args
+    end
 
-      opts.on("-t", "--threshold [INTEGER]", Integer,
-              "Memory threshold in MB") do |threshold|
-        options[:threshold] = threshold
-      end
+    def process
+      options = { :format => :short_summary, :type => :memory }
 
-      opts.on("-f", "--file filepath", "Output to file") do |filename|
-        options[:output_file] = filename
-      end
+      op = OptionParser.new do |opts|
+        opts.banner = "Usage: oink [options] files"
 
-      format_list = (Oink::MemoryUsageReporter::FORMAT_ALIASES.keys + Oink::MemoryUsageReporter::FORMATS).join(',')
-      opts.on("--format FORMAT", Oink::MemoryUsageReporter::FORMATS, Oink::MemoryUsageReporter::FORMAT_ALIASES, "Select format",
-              "  (#{format_list})") do |format|
-        options[:format] = format.to_sym
-      end
+        opts.on("-t", "--threshold [INTEGER]", Integer,
+                "Memory threshold in MB") do |threshold|
+          options[:threshold] = threshold
+        end
 
-      opts.on("-m", "--memory", "Check for Memory Threshold (default)") do |v|
-         options[:type] = :memory
-      end
+        opts.on("-f", "--file filepath", "Output to file") do |filename|
+          options[:output_file] = filename
+        end
+
+        format_list = (Oink::Reports::Base::FORMAT_ALIASES.keys + Oink::Reports::Base::FORMATS).join(',')
+        opts.on("--format FORMAT", Oink::Reports::Base::FORMATS, Oink::Reports::Base::FORMAT_ALIASES, "Select format",
+                "  (#{format_list})") do |format|
+          options[:format] = format.to_sym
+        end
+
+        opts.on("-m", "--memory", "Check for Memory Threshold (default)") do |v|
+           options[:type] = :memory
+        end
+
+        opts.on("-r", "--active-record", "Check for Active Record Threshold") do |v|
+           options[:type] = :active_record
+        end
 
-      opts.on("-r", "--active-record", "Check for Active Record Threshold") do |v|
-         options[:type] = :active_record
       end
 
-    end
+      op.parse!(@args)
 
-    op.parse!(@args)
+      if @args.empty?
+        puts op
+        exit
+      end
 
-    if @args.empty?
-      puts op
-      exit
-    end
+      output = nil
 
-    output = nil
+      if options[:output_file]
+        output = File.open(options[:output_file], 'w')
+      else
+        output = STDOUT
+      end
 
-    if options[:output_file]
-      output = File.open(options[:output_file], 'w')
-    else
-      output = STDOUT
-    end
+      files = get_file_listing(@args)
 
-    files = get_file_listing(@args)
+      handles = files.map { |f| File.open(f) }
 
-    handles = files.map { |f| File.open(f) }
+      if options[:type] == :memory
 
-    if options[:type] == :memory
+        options[:threshold] ||= 75
+        options[:threshold] *= 1024
 
-      options[:threshold] ||= 75
-      options[:threshold] *= 1024
+        Oink::Reports::MemoryUsageReport.new(handles, options[:threshold], :format => options[:format]).print(output)
 
-      Oink::MemoryUsageReporter.new(handles, options[:threshold], :format => options[:format]).print(output)
+      elsif options[:type] == :active_record
 
-    elsif options[:type] == :active_record
+        options[:threshold] ||= 500
 
-      options[:threshold] ||= 500
+        Oink::Reports::ActiveRecordInstantiationReport.new(handles, options[:threshold], :format => options[:format]).print(output)
 
-      Oink::ActiveRecordInstantiationReporter.new(handles, options[:threshold], :format => options[:format]).print(output)
+      end
 
+      output.close
+      handles.each { |h| h.close }
     end
 
-    output.close
-    handles.each { |h| h.close }    
-  end
-  
-protected
-
-  def get_file_listing(args)
-    listing = []
-    args.each do |file|
-      unless File.exist?(file)
-        raise "Could not find \"#{file}\""
-      end
-      if File.directory?(file)
-        listing += Dir.glob("#{file}/**")
-      else
-        listing << file
+  protected
+
+    def get_file_listing(args)
+      listing = []
+      args.each do |file|
+        unless File.exist?(file)
+          raise "Could not find \"#{file}\""
+        end
+        if File.directory?(file)
+          listing += Dir.glob("#{file}/**")
+        else
+          listing << file
+        end
       end
+      listing
     end
-    listing
-  end
 
+  end
 end
 
-

data/lib/oink/instrumentation.rb

@@ -0,0 +1,2 @@
+require 'oink/instrumentation/active_record'
+require 'oink/instrumentation/memory_snapshot'

data/lib/oink/instrumentation/active_record.rb

@@ -0,0 +1,63 @@
+module Oink
+
+  def self.extended_active_record?
+    @oink_extended_active_record
+  end
+
+  def self.extended_active_record!
+    @oink_extended_active_record = true
+  end
+
+  module Instrumentation
+    module ActiveRecord
+
+      def self.included(klass)
+        klass.class_eval do
+
+          @@instantiated = {}
+          @@total = nil
+
+          def self.reset_instance_type_count
+            @@instantiated = {}
+            @@total = nil
+          end
+
+          def self.increment_instance_type_count
+            @@instantiated[base_class.name] ||= 0
+            @@instantiated[base_class.name] += 1
+          end
+
+          def self.instantiated_hash
+            @@instantiated
+          end
+
+          def self.total_objects_instantiated
+            @@total ||= @@instantiated.values.sum
+          end
+
+          unless Oink.extended_active_record?
+            class << self
+              alias_method :allocate_before_oink, :allocate
+
+              def allocate
+                value = allocate_before_oink
+                increment_instance_type_count
+                value
+              end
+            end
+
+            alias_method :initialize_before_oink, :initialize
+
+            def initialize(*args, &block)
+              value = initialize_before_oink(*args, &block)
+              self.class.increment_instance_type_count
+              value
+            end
+
+            Oink.extended_active_record!
+          end
+        end
+      end
+    end
+  end
+end

data/lib/oink/instrumentation/memory_snapshot.rb

@@ -0,0 +1,119 @@
+module Oink
+
+  module Instrumentation
+
+    class MemorySnapshot
+      def self.memory
+        memory_snapshot_class.new.memory
+      end
+
+      def self.memory_snapshot_class
+        @@memory_snapshot_class ||= begin
+          [WindowsMemorySnapshot,
+           StatmMemorySnapshot,
+           SmapsMemorySnapshot,
+           ProcessStatusMemorySnapshot].find { |snapshot_class| snapshot_class.available? }
+        end
+
+        raise MemoryDataUnavailableError if @@memory_snapshot_class.nil?
+        @@memory_snapshot_class
+      end
+    end
+
+    class WindowsMemorySnapshot
+
+      begin
+        require 'win32ole'
+      rescue LoadError
+      end
+
+      def memory
+        wmi = WIN32OLE.connect("winmgmts:root/cimv2")
+        mem = 0
+        query = "select * from Win32_Process where ProcessID = #{$$}"
+        wmi.ExecQuery(query).each do |wproc|
+          mem = wproc.WorkingSetSize
+        end
+        mem.to_i / 1000
+      end
+
+      def self.available?
+        defined? WIN32OLE
+      end
+    end
+
+    class StatmMemorySnapshot
+      def memory
+        pages = File.read("/proc/self/statm")
+        pages.to_i * self.class.statm_page_size
+      end
+
+      # try to get and cache memory page size. falls back to 4096.
+      def self.statm_page_size
+        @statm_page_size ||= begin
+          sys_call = SystemCall.execute("getconf PAGESIZE")
+          if sys_call.success?
+            sys_call.stdout.strip.to_i / 1024
+          else
+            4
+          end
+        end
+      end
+
+      def self.unset_statm_page_size
+        @statm_page_size = nil
+      end
+
+      def self.available?
+        File.exist?("/proc/self/statm")
+      end
+    end
+
+    class SmapsMemorySnapshot
+      def memory
+        proc_file = File.new("/proc/#{$$}/smaps")
+        proc_file.map do |line|
+          size = line[/Size: *(\d+)/, 1] and size.to_i
+        end.compact.sum
+      end
+
+      def self.available?
+        File.exist?("/proc/#{$$}/smaps")
+      end
+    end
+
+    class ProcessStatusMemorySnapshot
+      def memory
+        SystemCall.execute("ps -o vsz= -p #{$$}").stdout.to_i
+      end
+
+      def self.available?
+        SystemCall.execute("ps -o vsz= -p #{$$}").success?
+      end
+    end
+
+    class SystemCall
+
+      def initialize(cmd)
+        @stdout = `#{cmd}`
+      end
+
+      def self.execute(cmd)
+        new(cmd)
+      end
+
+      def stdout
+        @stdout
+      end
+
+      def success?
+        $?.success?
+      end
+
+    end
+
+    class MemoryDataUnavailableError < StandardError; end
+
+  end
+
+end