newrelic_rpm 3.6.5.130 → 3.6.6.147

data/test/performance/lib/performance.rb

@@ -0,0 +1,28 @@
+# encoding: utf-8
+# This file is distributed under New Relic's license terms.
+# See https://github.com/newrelic/rpm/blob/master/LICENSE for complete details.
+
+require 'logger'
+
+$: << File.expand_path(File.dirname(__FILE__))
+
+require 'performance/result'
+require 'performance/runner'
+require 'performance/test_case'
+require 'performance/timer'
+require 'performance/instrumentor'
+require 'performance/console_reporter'
+require 'performance/json_reporter'
+require 'performance/hako_client'
+require 'performance/hako_reporter'
+
+module Performance
+  def self.logger
+    log_path = ENV['LOG'] || $stderr
+    @logger ||= Logger.new(log_path)
+  end
+
+  def self.log_path=(path)
+    @logger = Logger.new(path)
+  end
+end

data/test/performance/lib/performance/console_reporter.rb

@@ -0,0 +1,51 @@
+# encoding: utf-8
+# This file is distributed under New Relic's license terms.
+# See https://github.com/newrelic/rpm/blob/master/LICENSE for complete details.
+
+module Performance
+  class ConsoleReporter
+    def initialize(results, elapsed, options={})
+      @results = results
+      @elapsed = elapsed
+      @options = options
+    end
+
+    def report
+      failures = @results.select { |result| result.failure? }
+      successes = @results - failures
+      puts "#{@results.size} tests, #{failures.size} failures, #{@elapsed} s total"
+      report_successful_results(successes) if successes.any?
+      report_failed_results(failures) if failures.any?
+    end
+
+    def report_successful_results(results)
+      puts ''
+      results.each do |result|
+        puts "#{result.identifier}: #{result.elapsed} s"
+        unless @options[:brief]
+          result.measurements.each do |key, value|
+            puts "  #{key}: #{value}"
+          end
+        end
+        unless result.artifacts.empty?
+          puts "  artifacts:"
+          result.artifacts.each do |artifact|
+            puts "    #{artifact}"
+          end
+        end
+        puts '' if !@options[:brief] || !result.artifacts.empty?
+      end
+    end
+
+    def report_failed_results(results)
+      puts ''
+      results.each do |failure|
+        puts "FAILED: #{failure.identifier}"
+        e = failure.exception
+        puts "#{e['class']}: #{e['message']}"
+        puts failure.exception['backtrace'].map { |l| "    #{l}" }.join("\n")
+      end
+      puts ''
+    end
+  end
+end

data/test/performance/lib/performance/hako_client.rb

@@ -0,0 +1,31 @@
+# encoding: utf-8
+# This file is distributed under New Relic's license terms.
+# See https://github.com/newrelic/rpm/blob/master/LICENSE for complete details.
+
+require 'json'
+require 'net/http'
+require 'uri'
+
+module Performance
+  class HakoClient
+    BASE_URI = 'http://hako.pdx.vm.datanerd.us'
+
+    def initialize(token)
+      @token = token
+    end
+
+    def submit(result)
+      body = JSON.dump('result' => result.to_h)
+
+      uri = URI(BASE_URI + "/api/results")
+      req = Net::HTTP::Post.new(uri.to_s)
+      req.body = body
+      req.content_type = 'application/json'
+      req['Authorization'] = "Token token=\"#{@token}\""
+
+      Net::HTTP.start(uri.host, uri.port) do |conn|
+        conn.request(req)
+      end
+    end
+  end
+end

data/test/performance/lib/performance/hako_reporter.rb

@@ -0,0 +1,26 @@
+# encoding: utf-8
+# This file is distributed under New Relic's license terms.
+# See https://github.com/newrelic/rpm/blob/master/LICENSE for complete details.
+
+module Performance
+  class HakoReporter
+    def initialize(results, elapsed, options={})
+      @results = results
+      @token = ENV['HAKO_TOKEN'] || options[:hako_token]
+    end
+
+    def report
+      Performance.logger.info("Uploading #{@results.size} results to Hako")
+      client = HakoClient.new(@token)
+      @results.each do |result|
+        rsp = client.submit(result)
+        case rsp
+        when Net::HTTPSuccess
+          Performance.logger.debug("Successfully posted result to Hako")
+        else
+          Performance.logger.error("Failed to post results to Hako: #{rsp.inspect}")
+        end
+      end
+    end
+  end
+end

data/test/performance/lib/performance/instrumentation/cpu_usage.rb

@@ -0,0 +1,26 @@
+# encoding: utf-8
+# This file is distributed under New Relic's license terms.
+# See https://github.com/newrelic/rpm/blob/master/LICENSE for complete details.
+
+module Performance
+  module Instrumentation
+    class CpuUsage < Instrumentor
+      on_by_default
+
+      def before(*)
+        @times_before = Process.times
+      end
+
+      def after(*)
+        @times_after = Process.times
+      end
+
+      def results
+        {
+          :cpu_time_user   => @times_after.utime - @times_before.utime,
+          :cpu_time_system => @times_after.stime - @times_before.stime
+        }
+      end
+    end
+  end
+end

data/test/performance/lib/performance/instrumentation/gc_stats.rb

@@ -0,0 +1,53 @@
+# encoding: utf-8
+# This file is distributed under New Relic's license terms.
+# See https://github.com/newrelic/rpm/blob/master/LICENSE for complete details.
+
+module Performance
+  module Instrumentation
+    class MRIGCStats < Instrumentor
+      platforms :mri_193, :mri_20
+      on_by_default
+
+      def before(*)
+        @stats_before = GC.stat
+      end
+
+      def after(*)
+        @stats_after = GC.stat
+      end
+
+      def results
+        res = {
+          :gc_runs => @stats_after[:count] - @stats_before[:count],
+          :live_objects => @stats_after[:heap_live_num] - @stats_before[:heap_live_num]
+        }
+        if RUBY_VERSION >= "2.0.0"
+          res[:allocations] = @stats_after[:total_allocated_object] - @stats_before[:total_allocated_object]
+        end
+        res
+      end
+    end
+
+    class REEGCStats < Instrumentor
+      platforms :ree
+      on_by_default
+
+      def before(*)
+        @allocations_before = ObjectSpace.allocated_objects
+        @live_objects_before = ObjectSpace.live_objects
+      end
+
+      def after(*)
+        @allocations_after = ObjectSpace.allocated_objects
+        @live_objects_after = ObjectSpace.live_objects
+      end
+
+      def results
+        {
+          :allocations => @allocations_after - @allocations_before,
+          :live_objects => @live_objects_after - @live_objects_before,
+        }
+      end
+    end
+  end
+end

data/test/performance/lib/performance/instrumentation/perf_tools.rb

@@ -0,0 +1,30 @@
+# encoding: utf-8
+# This file is distributed under New Relic's license terms.
+# See https://github.com/newrelic/rpm/blob/master/LICENSE for complete details.
+
+module Performance
+  module Instrumentation
+    class PerfToolsProfile < Instrumentor
+      platforms :mri_19, :mri_20
+
+      def self.setup
+        require 'tmpdir'
+        require 'perftools'
+      end
+
+      def before(test, test_name)
+        @profile_dir = Dir.mktmpdir('profile')
+        @profile_path = File.join(@profile_dir, "profile")
+        PerfTools::CpuProfiler.start(@profile_path)
+      end
+
+      def after(test, test_name)
+        PerfTools::CpuProfiler.stop
+        output_profile_path = artifact_path(test, test_name, "dot")
+        system("pprof.rb --dot #{@profile_path} >#{output_profile_path}")
+        @artifacts << output_profile_path
+        FileUtils.remove_entry_secure(@profile_dir)
+      end
+    end
+  end
+end

data/test/performance/lib/performance/instrumentor.rb

@@ -0,0 +1,110 @@
+# encoding: utf-8
+# This file is distributed under New Relic's license terms.
+# See https://github.com/newrelic/rpm/blob/master/LICENSE for complete details.
+
+module Performance
+  module Instrumentation
+    def self.current_platform_matches?(p)
+      is_jruby = defined?(JRUBY_VERSION)
+      is_ree   = defined?(RUBY_DESCRIPTION) && RUBY_DESCRIPTION =~ /MBARI/
+      case p
+      when :jruby   then is_jruby
+      when :mri     then !is_jruby
+      when :ree     then !is_jruby && is_ree
+      when :mri_18  then !is_jruby && RUBY_VERSION =~ /^1\.8\./
+      when :mri_19  then !is_jruby && RUBY_VERSION =~ /^1\.9\./
+      when :mri_193 then !is_jruby && RUBY_VERSION =~ /^1\.9\.3/
+      when :mri_20  then !is_jruby && RUBY_VERSION =~ /^2\.0\./
+      end
+    end
+
+    def self.load_instrumentors
+      dir = File.expand_path(File.join(File.dirname(__FILE__), 'instrumentation'))
+      Dir.glob(File.join(dir, "*.rb")).each do |filename|
+        require filename
+      end
+    end
+
+    def self.default_instrumentors
+      Instrumentor.subclasses.select do |cls|
+        cls.on_by_default? && cls.supported?
+      end
+    end
+
+    def self.instrumentor_class_by_name(name)
+      begin
+        cls = self.const_get(name)
+        if cls.supported?
+          cls
+        else
+          Performance.logger.warn("Instrumentor '#{name}' is unsupported on this platform")
+          nil
+        end
+      rescue NameError => e
+        Performance.logger.error("Failed to load instrumentor '#{name}': #{e.inspect}")
+        nil
+      end
+    end
+
+    class Instrumentor
+      def self.inherited(cls)
+        @subclasses ||= []
+        @subclasses << cls
+      end
+
+      def self.subclasses
+        @subclasses || []
+      end
+
+      def self.platforms(*args)
+        @supported_platforms = args
+      end
+
+      def self.supported?
+        (
+          @supported_platforms.nil? ||
+          @supported_platforms.any? { |p| Instrumentation.current_platform_matches?(p) }
+        )
+      end
+
+      def self.on_by_default
+        @on_by_default = true
+      end
+
+      def self.on_by_default?
+        @on_by_default
+      end
+
+      attr_reader :artifacts
+
+      def initialize(artifacts_dir)
+        @artifacts_dir = artifacts_dir
+        reset
+      end
+
+      def reset
+        @artifacts = []
+      end
+
+      def pretty_name
+        self.class.name.split("::").last
+      end
+
+      def artifacts_dir_for(test_case, test_name)
+        path = File.join(@artifacts_dir, test_case.class.name, test_name)
+        FileUtils.mkdir_p(path)
+        path
+      end
+
+      def artifact_path(test_case, test_name, extension)
+        File.join(artifacts_dir_for(test_case, test_name), "#{pretty_name}.#{extension}")
+      end
+
+      def before(*); end
+      def after(*); end
+      def results; {}; end
+    end
+  end
+end
+
+Performance::Instrumentation.load_instrumentors

data/test/performance/lib/performance/json_reporter.rb

@@ -0,0 +1,15 @@
+# encoding: utf-8
+# This file is distributed under New Relic's license terms.
+# See https://github.com/newrelic/rpm/blob/master/LICENSE for complete details.
+
+module Performance
+  class JSONReporter
+    def initialize(results, elapsed, options={})
+      @results = results
+    end
+
+    def report
+      puts JSON.dump(@results.map { |result| result.to_h })
+    end
+  end
+end

data/test/performance/lib/performance/result.rb

@@ -0,0 +1,80 @@
+# encoding: utf-8
+# This file is distributed under New Relic's license terms.
+# See https://github.com/newrelic/rpm/blob/master/LICENSE for complete details.
+
+module Performance
+  class Result
+    attr_reader :test_name, :measurements, :tags, :timer, :artifacts
+    attr_accessor :exception
+
+    def initialize(test_case, test_name)
+      @test_case = test_case
+      @test_name = test_name
+      @measurements   = {}
+      @tags           = {}
+      @timer = Timer.new
+      @artifacts = []
+    end
+
+    def exception=(e)
+      if e.is_a?(Exception)
+        @exception = {
+          'class'     => e.class.name,
+          'message'   => e.message,
+          'backtrace' => e.backtrace
+        }
+      else
+        @exception = e
+      end
+    end
+
+    def elapsed=(elapsed)
+      @elapsed = elapsed
+    end
+
+    def elapsed
+      @elapsed || @timer.elapsed
+    end
+
+    def failure?
+      elapsed.nil? || !@exception.nil?
+    end
+
+    def suite_name
+      @test_case.is_a?(String) ? @test_case : @test_case.name
+    end
+
+    def identifier
+      "#{suite_name}##{@test_name}"
+    end
+
+    def measurements_hash
+      @measurements.merge(:elapsed => elapsed)
+    end
+
+    def to_h
+      {
+        "suite"     => suite_name,
+        "name"      => @test_name,
+        "measurements" => measurements_hash,
+        "tags"         => @tags,
+        "exception"    => @exception,
+        "artifacts"    => @artifacts
+      }
+    end
+
+    def self.from_hash(hash)
+      elapsed = hash['measurements'].delete('elapsed')
+      result = self.new(hash['suite'], hash['name'])
+      result.measurements.merge! hash['measurements']
+      result.tags.merge! hash['tags']
+      result.exception = hash['exception']
+      result.elapsed = elapsed
+      result
+    end
+
+    def inspect
+      "<Performance::Result #{identifier}: #{elapsed} s, results=#{@results.inspect}>"
+    end
+  end
+end