fiveruns-dash-ruby 0.7.0

data/README.rdoc

@@ -0,0 +1,68 @@
+= FiveRuns Dash core library for Ruby
+
+Provides a Ruby API to push metrics to the FiveRuns Dash service, http://dash.fiveruns.com, currently in beta.
+
+You'll need a Dash account before using this library.
+
+== Installation
+
+This library is released as a gem from the official repository at http://github.com/fiveruns/dash-ruby
+
+  sudo gem install fiveruns-dash-ruby --source 'http://gems.github.com'
+
+== Usage
+
+See the Ruby Language Guide http://dash.fiveruns.com/help/ruby.html for information on how to use this library. 
+
+== Authors
+
+The FiveRuns Development Team & Dash community
+
+== Dependencies
+
+* The json gem
+
+== Platforms
+
+This library has only been tested on OSX and Linux.  The `ruby' recipe (which collects metrics on the Ruby process) currently relies on `ps' -- so will not work on Windows.  We're actively looking for contributions to widen the number of platforms we support; please help!
+
+== Contributing
+
+As an open source project, we welcome community contributions!
+
+The best way to contribute is by sending pull requests via GitHub.  The official repository for this project is:
+
+  http://github.com/fiveruns/dash-ruby
+
+== Support
+
+Please join the dash-users Google group, http://groups.google.com/group/dash-users
+
+You can also contact us via Twitter, Campfire, or email; see the main help page, http://dash.fiveruns.com/help, for details.
+
+== License
+
+  # (The FiveRuns License)
+  #
+  # Copyright (c) 2006-2008 FiveRuns Corporation
+  # 
+  # 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/Rakefile

@@ -0,0 +1,39 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.verbose = true
+  t.test_files = FileList['test/*_test.rb']
+end
+
+task :default => :test
+
+begin 
+  require 'jeweler' 
+
+  Jeweler::Tasks.new do |s| 
+    s.name = "dash-ruby" 
+    s.rubyforge_project = 'fiveruns'
+    s.summary = "FiveRuns Dash core library for Ruby" 
+    s.email = "dev@fiveruns.com" 
+    s.homepage = "http://github.com/fiveruns/dash-ruby" 
+    s.description = "Provides an API to send metrics to the FiveRuns Dash service" 
+    s.authors = ["FiveRuns Development Team"] 
+    s.files =  FileList['README.rdoc', 'Rakefile', 'version.yml', "{lib,test,recipes,examples}/**/*", ] 
+    s.add_dependency 'json' 
+    s.add_development_dependency 'shoulda'
+  end 
+rescue LoadError 
+  puts "Jeweler, or one of its dependencies, is not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com" 
+end
+
+task :coverage do
+  rm_f "coverage"
+  rm_f "coverage.data"
+  rcov = "rcov --exclude gems --exclude version.rb --sort coverage --text-summary --html -o coverage"
+  system("#{rcov} test/*_test.rb")
+  if ccout = ENV['CC_BUILD_ARTIFACTS']
+    FileUtils.rm_rf '#{ccout}/coverage'
+    FileUtils.cp_r 'coverage', ccout
+  end
+  system "open coverage/index.html" if PLATFORM['darwin']
+end

data/lib/fiveruns/dash.rb

@@ -0,0 +1,144 @@
+require 'rubygems'
+# TODO remove ActiveSupport dependency
+require 'activesupport'
+require 'json'
+
+require 'thread'
+require 'logger'
+
+$:.unshift(File.dirname(__FILE__))
+
+# NB: Pre-load ALL Dash files here so we do not accidentally
+# use ActiveSupport's autoloading.
+
+module Fiveruns; end
+
+require 'dash/version'
+require 'dash/configuration'
+require 'dash/typable'
+require 'dash/metric'
+require 'dash/session'
+require 'dash/reporter'
+require 'dash/update'
+require 'dash/host'
+require 'dash/scm'
+require 'dash/exception_recorder'
+require 'dash/recipe'
+require 'dash/instrument'
+require 'dash/threads'
+require 'dash/trace'
+require 'dash/store/http'
+require 'dash/store/file'
+
+module Fiveruns::Dash
+    
+  include Threads
+  
+  START_TIME = Time.now.utc
+  
+  def self.process_age
+    Time.now.utc - START_TIME
+  end
+          
+  def self.logger
+    @logger ||= begin
+      if defined?(RAILS_DEFAULT_LOGGER)
+        RAILS_DEFAULT_LOGGER
+      else
+        Logger.new(STDOUT)
+      end
+    end
+  end
+  
+  def self.logger=(logger)
+    @logger = logger
+  end
+
+  def self.configure(options = {})
+    handle_pwd_is_root(caller[0]) if Dir.pwd == '/'      
+    configuration.options.update(options)
+    yield configuration if block_given?
+  end
+  
+  def self.start(options = {}, &block)
+    configure(options, &block) if block_given?
+    session.start
+  end
+  
+  def self.host
+    @host ||= Host.new
+  end
+  
+  def self.scm
+    @scm ||= unless configuration.options[:scm] == false
+      SCM.matching(configuration.options[:scm_repo])
+    end
+  end
+
+  class << self
+    attr_accessor :trace_contexts
+  end
+  
+  def self.register_recipe(name, options = {}, &block)
+    recipes[name] ||= []
+    recipe = Recipe.new(name, options, &block)
+    if recipes[name].include?(recipe)
+      logger.info "Skipping re-registration of recipe :#{name} #{options.inspect}"
+    else
+      recipes[name] << recipe
+    end
+  end
+
+  def self.recipes
+    @recipes ||= {}
+  end
+  
+  def self.trace_contexts
+    @trace_contexts ||= []
+  end
+      
+  #######
+  private
+  #######
+      
+  def self.handle_pwd_is_root(last_method)
+    # We are in a Daemon and don't have a valid PWD.  Change the
+    # default SCM repo location based on the caller stack.
+    if last_method =~ /([^:]+):\d+/
+      file = File.dirname($1)
+      configuration.options[:scm_repo] = file
+    end
+  end
+
+  def self.session
+    @session ||= Session.new(configuration)
+  end
+  
+  def self.configuration
+    @configuration ||= begin
+      load_recipes
+      Configuration.new
+    end
+  end
+  
+  def self.load_recipes
+    Dir[File.join(File.dirname(__FILE__), '..', '..', 'recipes', '**', '*.rb')].each do |core_recipe|
+      require core_recipe
+    end
+  end
+  
+  module Context
+    def self.set(value)
+      Thread.current[:fiveruns_dash_context] = value
+    end
+  
+    def self.reset
+      Thread.current[:fiveruns_dash_context] = []
+    end
+  
+    def self.context
+      Thread.current[:fiveruns_dash_context] ||= []
+    end
+  end
+
+end

data/lib/fiveruns/dash/configuration.rb

@@ -0,0 +1,116 @@
+module Fiveruns::Dash
+  
+  class Configuration
+    
+    class ConflictError < ::ArgumentError; end
+    
+    delegate :each, :to => :metrics
+    
+    def self.default_options
+      ::Fiveruns::Dash.logger.info "CWD::#{Dir.pwd.inspect}"
+      {:scm_repo => Dir.pwd}
+    end
+    
+    attr_reader :options
+    def initialize(options = {})
+      @options = self.class.default_options.merge(options)
+      yield self if block_given?
+    end
+    
+    def ready?
+      options[:app]
+    end
+
+    # Optionally add to a recipe if the given version meets
+    # a requirement
+    # Note: Requires RubyGems-compatible version scheme (ie, MAJOR.MINOR.PATCH)
+    #
+    # call-seq:
+    #   for_version Rails::Version::CURRENT, ['>=', '2.1.0'] do
+    #     # ... code to execute
+    #   end
+    def for_version(source, requirement)
+      unless source
+        ::Fiveruns::Dash.logger.warn "No version given (to check against #{requirement.inspect}), skipping block"
+        return false
+      end
+      source_version = ::Gem::Version.new(source.to_s)
+      requirement = Array(requirement)
+      requirement_version = ::Gem::Version.new(requirement.pop)
+      comparator = normalize_version_comparator(requirement.shift || :==)
+      yield if source_version.__send__(comparator, requirement_version)
+    end
+    
+    def metrics #:nodoc:
+      @metrics ||= []
+    end
+    
+    def recipes
+      @recipes ||= []
+    end
+    
+    def ignore_exceptions(&rule)
+      Fiveruns::Dash::ExceptionRecorder.add_ignore_rule(&rule)
+    end
+
+    def add_exceptions_from(*meths, &block)
+      block = block ? block : lambda { }
+      meths.push :exceptions => true
+      Instrument.add(*meths, &block)
+    end
+    
+    # Merge in an existing recipe
+    # call-seq:
+    #   add_recipe :ruby
+    def add_recipe(name, options = {})
+      if Fiveruns::Dash.recipes[name]
+        Fiveruns::Dash.recipes[name].each do |recipe|
+          if !recipes.include?(recipe) && recipe.matches?(options)
+            recipes << recipe
+            recipe.add_to(self) 
+          end
+        end
+      else
+        raise ArgumentError, "No such recipe: #{name}"
+      end
+    end
+    
+    # Lookup metrics for modification by subsequent recipes
+    def modify(criteria = {})
+      metrics.each do |metric|
+        if criteria.all? { |k, v| metric.key[k].to_s == v.to_s }
+          yield metric
+        end
+      end        
+    end
+    
+    # Optionally fired by recipes when included
+    def added
+      yield
+    end
+    
+    #######
+    private
+    #######
+    
+    def normalize_version_comparator(comparator)
+      comparator.to_s == '=' ? '==' : comparator
+    end
+    
+    def method_missing(meth, *args, &block)
+      if (klass = Metric.types[meth])
+        metric = klass.new(*args, &block)
+        metric.recipe = Recipe.current
+        if metrics.include?(metric)
+          Fiveruns::Dash.logger.info "Skipping previously defined metric `#{metric.name}'"
+        else
+          metrics << metric
+        end
+      else
+        super
+      end
+    end
+              
+  end 
+      
+end

data/lib/fiveruns/dash/exception_recorder.rb

@@ -0,0 +1,135 @@
+require 'yaml'
+
+module Fiveruns
+  module Dash
+  
+  class ExceptionRecorder
+
+    RULES = []
+    
+    class << self
+      def replacements
+        @replacements ||= begin
+          paths = {
+            :system => /^(#{esc(path_prefixes(system_paths))})/,
+            :gems   => /^(#{esc(path_prefixes(system_gempaths, '/gems'))})/
+          }
+          %w(RAILS_ROOT MERB_ROOT).each do |root|
+            const = nil
+            const = Object.const_get(root) if Object.const_defined?(root)
+            paths.merge({ :app => regexp_for_path(const) }) if const
+          end
+          paths
+        end
+      end
+
+      def system_gempaths
+        `gem environment gempath`
+      end
+    
+      def system_paths
+        `ruby -e 'puts $:.reject{|p|p=="."}.join(":")'`
+      end
+
+      def regexp_for_path(path)
+        /^(#{Regexp.escape(Pathname.new(path).cleanpath.to_s)})/
+      end
+    
+      def path_prefixes(syspaths, suffix='')
+        syspaths.strip.split(":").collect { |path| Pathname.new(path+suffix).cleanpath.to_s }
+      end
+    
+      def esc(path_prefixes)
+        path_prefixes.collect{|path|Regexp.escape(path)}.join('|')
+      end
+
+      def add_ignore_rule(&rule)
+        RULES << rule
+      end
+    end
+
+    def initialize(session)
+      @session = session
+    end
+    
+    def ignore_exception?(exception)
+      RULES.any? do |rule|
+        rule.call(exception)
+      end
+    end
+
+    def record(exception, sample=nil)
+      return if ignore_exception? exception
+
+      data = extract_data_from_exception(exception)
+      # Allow the sample data to override the exception's display name.
+      data[:name] = sample.delete(:name) if sample and sample[:name]
+
+      if (matching = existing_exception_for(data))
+        matching[:total] += 1
+        matching
+      else
+        data[:total] = 1
+        data[:sample] = flatten_sample sample
+        exceptions << data
+        data
+      end
+    end
+    
+    def data
+      returning exceptions.dup do
+        reset
+      end
+    end
+
+    def reset
+      exceptions.clear
+    end
+
+    #######
+    private
+    #######
+    
+    def flatten_sample(sample)
+      case sample
+      when Hash
+        Hash[*sample.to_a.flatten.map { |v| v.to_s }]
+      when nil
+        {}
+      else
+        raise ArgumentError, "Exception sample must be a Hash instance"
+      end
+    end
+
+    def existing_exception_for(data)
+      # We detect exception dupes based on the same class name and backtrace.
+      exceptions.detect { |e| data[:name] == e[:name] && data[:backtrace] == e[:backtrace] }
+    end
+
+    def extract_data_from_exception(e)
+      {
+        :name => e.class.name,
+        :message => e.message,
+        :backtrace => sanitize(e.backtrace)
+      }
+    end
+
+    def exceptions
+      @exceptions ||= []
+    end
+
+    def sanitize(backtrace)
+      backtrace.map do |line|
+        line = line.strip
+        line.gsub!('in `', "")
+        line.gsub!("'", "")
+        self.class.replacements.each do |name, pattern|
+          line.gsub!(pattern,  "[#{name.to_s.upcase}]")
+        end
+        Pathname.new(line).cleanpath.to_s
+      end.join("\n")
+    end
+    
+  end
+end
+end