copperegg-apm 1.0.0.pre4 → 1.0.0.pre5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 79163ffe60c85728d0ef7395b45576b8adafe04a
-  data.tar.gz: dac7a7d0928a0b5ed9d3db1781e488a9e9e44598
+  metadata.gz: 4e143cece9e590383a13e4f8a29a5f3e6a8a39fe
+  data.tar.gz: b4fc0574c45b9dd1a838b54e515c5c79178d8b3e
 SHA512:
-  metadata.gz: 49594494683194b6838c4c5a40dac5a44addadb07cf2039232ec1b4115fe3b1dc3e684143a231b23a2d45d0bea33fd152d18b1c0e5f5fd570299ae632ceac898
-  data.tar.gz: 093ba0a311bc4c252686d63894d6faedb0fd14a255e9fecb68067d9e23a2baccbaf38c17a0c111c9e3ff6fe5e638ad4de33ba77357c7ee95ac11f9a42efed8b4
+  metadata.gz: 64aec00ee6e653dd59884633de9824fce8ee4327e2328e8580a45939e8b69aeddc1bffb5c02914028a354515243d42af849ad823a82c7ada0ab0a9b6e1442487
+  data.tar.gz: 77dc00611f2344497ed8621b3f185025cfe59faf60bd31a050128e5dcc26d883d7f8ba56c434c0471eb7d1a96c8a23daf4da2cb93397f52fab52e3ad1832ff57

data/README.md

@@ -8,9 +8,17 @@ Monitor the performance of your application with code instrumentation and except
 
 ## Getting Started
 
-### Set Up Your CopperEgg Account
+### Prerequisites
 
-![CopperEgg App Screenshot](https://raw.github.com/CopperEgg/apm/master/screenshot01.png)
+To get started monitoring your project's code, you'll need to complete the following steps:
+
++ Signup for a [CopperEgg Account](http://copperegg.com/copperegg-signup/)
++ Install [RevealCloud](http://copperegg.com/revealcloud-server-monitoring/), CopperEgg's server monitoring tool
++ Create an App under your CopperEgg Account, as described below
+
+### Create An App Under Your CopperEgg Account
+
+![CopperEgg App Screenshot](/screenshot01.png?raw=true "CopperEgg App Screenshot")
 
 Login to your account at [CopperEgg.com](https://app.copperegg.com/login) and click on the `Apps` tag to create a new App. An App represents your existing application. Give it a descriptive name like 'MySaaSApp.com'.
 
@@ -44,9 +52,9 @@ From your project's root directory, run `copperegg-apm-init`. This will create a
 
 Require this file below your other require directives.
 
-### Configuration
+## Configuration
 
-Instrumentation is initiated in your project by calling the `CopperEgg::APM.configure` block.
+Instrumentation is initiated in your project by calling the `CopperEgg::APM.configure` block. While your application runs, performance data is sent to the RevealCloud tool installed on your server over UDP on port 28344 in either 8 kB packets or at 15-second intervals, whichever comes first. RevealCloud in turn aggregates this data and transmits it to CopperEgg in 60-second intervals. This aggregation and transmission happens outside of your application code and has a negligible impact on your server performance.
 
 The auto-generated configuration script contains the default configuration values.
 
@@ -137,7 +145,18 @@ def generate_password(length=16)
 end
 ```
 
-### Supported Databases
+## Viewing Your Performance Data
+
+Once your application starts, it will take a few minutes before performance data appears in the CopperEgg UI. To view this data, log into your account and navigate to the `Apps` tag. You will see the name of your App listed in the sidebar to the left.
+
+![CopperEgg App Screenshot](/screenshot02.png "CopperEgg App Screenshot")
+
+## Supported Ruby Versions
+
++ 1.8.7 (with the exception of automatic method benchmarking)
++ 1.9+
+
+## Supported Databases
 
 Database query benchmarking is supported for the following engines:
 
@@ -145,7 +164,7 @@ Database query benchmarking is supported for the following engines:
 + PostgreSQL (via the pg gem)
 + SQLite (via the sqlite3 gem)
 
-### Supported Gems For Benchmarking Outbound HTTP Requests
+## Supported Gems For Benchmarking Outbound HTTP Requests
 
 Outbound HTTP requests performed within your project will be benchmarked from any of the following sources:
 

data/lib/copperegg/apm.rb

@@ -24,4 +24,4 @@ end
   version
 ).each { |file| require "copperegg/apm/#{file}" }
 
-require 'copperegg/apm/engine' if defined?(::Rails::Engine)
+require 'copperegg/apm/railtie' if defined?(::Rails::Railtie)

data/lib/copperegg/apm/benchmark.rb

@@ -15,7 +15,8 @@ module CopperEgg
 
     def configure(&block)
       Configuration.configure(&block)
-      @@payload_cache = { :version => GEM_VERSION,
+      @@payload_cache = { :ruby_version => ENV["RUBY_VERSION"],
+                          :apm_gem_version => GEM_VERSION,
                           :id => Configuration.instrument_key,
                           :sql => Configuration.benchmark_sql?,
                           :http => Configuration.benchmark_http?,
@@ -53,14 +54,8 @@ module CopperEgg
     def benchmarkable_methods
       return @@benchmarkable_methods if @@benchmarkable_methods.size > 0
 
-      if defined?(::Rails) && Rails.respond_to?(:configuration)
-        $LOAD_PATH.each do |path|
-          v, $VERBOSE = $VERBOSE, nil
-          if path.include?(Rails.configuration.root.to_s) && DO_NOT_INCLUDE_PATHS.detect {|part| path.include?("/#{part}")}.nil?
-            Dir.glob("#{path}/**/*.rb").each {|f| ActiveSupport::Dependencies::Loadable.require_dependency f, ""}
-          end
-          $VERBOSE = v
-        end
+      if defined?(::Rails) && Rails.respond_to?(:application) && Rails.application.respond_to?(:eager_load!)
+        Rails.application.eager_load!
       end
       
       ObjectSpace.each_object(Class) do |class_or_module|
@@ -211,6 +206,7 @@ module CopperEgg
         args.first.exception(args[1])
       end
       stacktrace = trim_stacktrace(caller)
+      return if stacktrace.length == 0
       parameters = {:error => "#{exception.class}|#{stacktrace.first}", :stacktrace => "#{exception.message}\n#{stacktrace.join("\n")}", :ts => Time.now.to_i}
       send_payload(parameters)
     end

data/lib/copperegg/apm/{engine.rb → railtie.rb}

@@ -1,6 +1,9 @@
+require 'copperegg-apm'
+require 'rails'
+
 module CopperEgg
   module APM
-    class Engine < ::Rails::Engine
+    class Railtie < ::Rails::Railtie
       initializer "copperegg_apm.helpers" do
         ActiveSupport.on_load_all do
           helper CopperEgg::APM::Rum

data/lib/copperegg/apm/version.rb

@@ -1,5 +1,5 @@
 module CopperEgg
   module APM
-    GEM_VERSION = '1.0.0.pre4'
+    GEM_VERSION = '1.0.0.pre5'
   end
 end

data/lib/helpers/benchmark_methods_table.rb

@@ -0,0 +1,65 @@
+module CopperEgg
+  module APM
+    class BenchmarkMethodsTable
+      def benchmarkable_methods
+        @benchmarkable_methods ||= CopperEgg::APM.benchmarkable_methods.sort_by(&:display_name)
+      end
+
+      def excluded_methods
+        benchmarkable_methods.select {|method| method.excluded?}
+      end
+
+      def method_column_width
+        benchmarkable_methods.reduce(0) do |memo, method|
+          method.display_name.size > memo ? method.display_name.size : memo
+        end + column_padding
+      end
+
+      def source_filename_column_width
+        benchmarkable_methods.reduce(0) do |memo, method|
+          method.display_filename.size > memo ? method.display_filename.size : memo
+        end + column_padding
+      end
+
+      def column_padding
+        2
+      end
+
+      def separator
+        "+" + "-"*(method_column_width+1) + "+" + "-"*(source_filename_column_width+1) + "+" + "--------------+"
+      end
+
+      def header_columns
+        "| Method" + " "*(method_column_width - 6).abs + "| Source Location" + " "*(source_filename_column_width - 15).abs + "| Benchmarked? |"
+      end
+
+      def method_columns(method)
+        "| #{method.display_name}" + " "*(method_column_width - method.display_name.size) + "| #{method.display_filename}" + " "*(source_filename_column_width - method.display_filename.size) + "| #{method.excluded? ? "NO " : "YES"}          |"
+      end
+
+      def classes_count
+        benchmarkable_methods.map(&:owner).uniq!.size
+      end
+
+      def file_count
+        benchmarkable_methods.map(&:source_filename).uniq!.size
+      end
+
+      def print_table
+        if RUBY_VERSION < "1.9"
+          puts "Method benchmarking is not available in Ruby #{RUBY_VERSION}. It is only available in Ruby 1.9 or later."
+        elsif CopperEgg::APM::Configuration.benchmark_methods_level == :disabled
+          puts "Method benchmarking is disabled. You can enable method benchmarking by setting the benchmark_methods configuration value."
+        elsif benchmarkable_methods.size == 0
+          puts "No methods benchmarked"
+        else
+          puts
+          puts "#{separator}\n#{header_columns}\n#{separator}\n#{benchmarkable_methods.map {|method| method_columns(method)}.join("\n")}\n#{separator}"
+          puts "#{benchmarkable_methods.size} methods defined in #{classes_count} classes across #{file_count} files. #{benchmarkable_methods.size - excluded_methods.size == 1 ? "1 method" : "#{benchmarkable_methods.size - excluded_methods.size} methods"} benchmarked."
+          puts
+        end
+      end
+
+    end
+  end
+end

data/lib/helpers/reveal_cloud.rb

@@ -0,0 +1,19 @@
+module CopperEgg
+  module APM
+    class RevealCloud
+
+      def self.installed?
+      end
+
+      def self.api_url
+      end
+
+      def self.api_key
+      end
+
+      def self.supports_instrumentation?
+      end
+
+    end
+  end
+end

data/spec/apm_spec.rb

@@ -26,7 +26,8 @@ describe CopperEgg::APM do
     it "should send a payload with version and configuration settings" do
       Socket.any_instance.should_receive(:send) do |payload_cache, flag|
         hash = JSON.parse(payload_cache)
-        expect(hash["version"]).to eq CopperEgg::APM::GEM_VERSION
+        expect(hash.has_key?("ruby_version")).to be_true
+        expect(hash["apm_gem_version"]).to eq CopperEgg::APM::GEM_VERSION
         expect(hash["id"]).to match(/\A[0-1a-z]{16}\z/i)
         expect(hash["sql"]).to eq true
         expect(hash["http"]).to eq true

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: copperegg-apm
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre4
+  version: 1.0.0.pre5
 platform: ruby
 authors:
 - Mike Bradford
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-31 00:00:00.000000000 Z
+date: 2013-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -198,7 +198,6 @@ files:
 - ./lib/copperegg/apm/benchmark.rb
 - ./lib/copperegg/apm/benchmark_methods_table.rb
 - ./lib/copperegg/apm/configuration.rb
-- ./lib/copperegg/apm/engine.rb
 - ./lib/copperegg/apm/errors.rb
 - ./lib/copperegg/apm/ethon/easy/operations.rb
 - ./lib/copperegg/apm/kernel.rb
@@ -206,6 +205,7 @@ files:
 - ./lib/copperegg/apm/mysql2/client.rb
 - ./lib/copperegg/apm/net/http.rb
 - ./lib/copperegg/apm/pg/connection.rb
+- ./lib/copperegg/apm/railtie.rb
 - ./lib/copperegg/apm/restclient/request.rb
 - ./lib/copperegg/apm/rum.rb
 - ./lib/copperegg/apm/sqlite3/database.rb
@@ -217,10 +217,13 @@ files:
 - ./lib/copperegg-apm.rb
 - ./lib/generators/copperegg/apm/init_generator.rb
 - ./lib/generators/copperegg/apm/templates/config.rb
+- ./lib/helpers/benchmark_methods_table.rb
+- ./lib/helpers/reveal_cloud.rb
 - ./performance/mysql2.rb
 - ./Rakefile
 - ./README.md
 - ./screenshot01.png
+- ./screenshot02.png
 - ./spec/action_controller_spec.rb
 - ./spec/apm_spec.rb
 - ./spec/ethon_spec.rb
@@ -291,7 +294,7 @@ rubyforge_project:
 rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
-summary: copperegg-apm-1.0.0.pre4
+summary: copperegg-apm-1.0.0.pre5
 test_files:
 - spec/action_controller_spec.rb
 - spec/apm_spec.rb