copperegg-apm 1.0.0.pre1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 53c18884499d7d5cb6bcbc25cf3343c60347926d
+  data.tar.gz: db57ee020032965afd5b93c00379a66faf594580
+SHA512:
+  metadata.gz: 334e0e654618769b5bf5c524c092e7585cd9ebf7700ba3e0f87c8f042876a7a614f2b2e2033f2918a9c1bf01e4b7ab857429c1f7380fdd2625e9f0c94000f10c
+  data.tar.gz: ac15445e1ec1e33cc262a58c97d133e8b2c0e854b3d0d10738e234ae12b79cc4e8db5f835c658fd5d3fe37f49560c0781b205845c91952317b95b48d060bd4e2

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 1.0.0
+
+* Initial Release

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,102 @@
+PATH
+  remote: .
+  specs:
+    copperegg-apm (1.0.0.pre1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (3.2.12)
+      activemodel (= 3.2.12)
+      activesupport (= 3.2.12)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.4)
+      rack (~> 1.4.5)
+      rack-cache (~> 1.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.2.1)
+    activemodel (3.2.12)
+      activesupport (= 3.2.12)
+      builder (~> 3.0.0)
+    activesupport (3.2.12)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    builder (3.0.4)
+    diff-lcs (1.1.3)
+    erubis (2.7.0)
+    ethon (0.5.12)
+      ffi (>= 1.3.0)
+      mime-types (~> 1.18)
+    faker (1.1.2)
+      i18n (~> 0.5)
+    ffi (1.8.1)
+    hike (1.2.2)
+    i18n (0.6.4)
+    journey (1.0.4)
+    json (1.5.5)
+    mime-types (1.23)
+    multi_json (1.7.2)
+    mysql (2.9.1)
+    mysql2 (0.3.11)
+    pg (0.15.1)
+    rack (1.4.5)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-ssl (1.3.3)
+      rack
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    railties (3.2.12)
+      actionpack (= 3.2.12)
+      activesupport (= 3.2.12)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (>= 0.14.6, < 2.0)
+    rake (10.0.4)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.3)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.3)
+    rspec-rails (2.11.4)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec (~> 2.11.0)
+    sprockets (2.2.2)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sqlite3 (1.3.7)
+    thor (0.18.1)
+    tilt (1.3.7)
+    typhoeus (0.6.3)
+      ethon (~> 0.5.11)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  actionpack (~> 3.0)
+  copperegg-apm!
+  ethon (~> 0.5)
+  faker (~> 1.1.2)
+  mysql (~> 2.9)
+  mysql2 (~> 0.2)
+  pg (~> 0.9)
+  rake (~> 10.0.0)
+  rest-client (~> 1.6)
+  rspec (~> 2.11.0)
+  rspec-rails (~> 2.0)
+  sqlite3 (~> 1.3)
+  typhoeus (~> 0.3)

data/README.md

@@ -0,0 +1,181 @@
+# CopperEgg APM
+
+Monitor the performance of your application with code instrumentation and exception aggregation.
+
+**Code instrumentation** measures the elapsed time used to execute a SQL statement, outbound HTTP request, or method call.
+
+**Exception aggregation** monitors the number and type of exceptions occurring in your code.
+
+## Getting Started
+
+### Set Up Your CopperEgg Account
+
+![CopperEgg App Screenshot](https://raw.github.com/CopperEgg/apm/master/screenshot01.png)
+
+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'.
+
+You must add Code Instrumentation to your App. Each component of your application can be represented by an Instrument. Benchmarks from your app will be separated by Instrument. For example, you may want to create a separate Instrument for each daemon process in your application.
+
+Copy your Instrument key. You will need to add it to your gem configuration as described below.
+
+### Installation
+
+You can install the `copperegg-apm` directly or use Bunder:
+
+Install the gem directly
+
+    gem install copperegg-apm
+
+Using Bunder, add to your Gemfile
+
+    gem 'copperegg-apm' 
+
+#### Ruby on Rails 3+
+
+Once the gem is bundled, you will need to generate a configuration file. Under your project's root directory, run:
+
+    rails g copperegg:apm:init
+
+This will create a configuration file at `config/initializers/copperegg_apm_config.rb`. You will be prompted to enter your Instrument key.
+
+#### Sinatra and Other Ruby Environments
+
+From your project's root directory, run `copperegg-apm-init`. This will create a configuration file named `copperegg_apm_config.rb`. You will be prompted to enter your Instrument key.
+
+Require this file below your other require directives.
+
+### Configuration
+
+Instrumentation is initiated in your project by calling the `CopperEgg::APM.configure` block.
+
+The auto-generated configuration script contains the default configuration values.
+
+```ruby
+CopperEgg::APM.configure do |config|
+  config.instrument_key       = "your_instrument_key"
+  config.benchmark_sql        = true                  # Benchmark database queries
+  config.benchmark_exceptions = true
+  config.benchmark_http       = true                  # Benchmark outgoing HTTP requests
+  config.benchmark_methods(:disabled)
+end
+```
+
+### Automatic Method Benchmarking
+
+For performance reasons, automatic method benchmarking is disabled by default. When enabled, *CopperEgg::APM* intelligently adds benchmarking to public and protected methods defined within your codebase. By default, methods whose names begin with an underscore (_) or end with a question mark (?) are not benchmarked.
+
+#### Configuring Automatic Method Benchmarking
+
+Automatic method benchmarking is enabled by calling `config.benchmark_methods` within the configuration block. It expects a level which is represented by a symbol whose value is either :disabled, :basic, :moderate, :full, or :custom.
+
+The levls *basic* and *moderate* are Rails-specific. With the *basic* level only controller methods are automatically benchmarked. The *moderate* level benchmarks all controller methods as well as methods of classes that descend from *ActiveRecord::Base*. Note that for controller actions, benchmarks also include rendering time.
+
+A level *full* benchmarks all methods within your project. For non-Rails projects, the *basic* and *moderate* levels will behave like the *full* level.
+
+The *custom* level allows you to explicitly set which methods to benchmark. When setting `benchmark_methods` to :custom a second argument is expected which is an array of strings representing the methods to benchmark. The format of these strings is explained in the following section.
+
+#### Inclusions and Exclusions
+
+With automatic method benchmarking enabled, you can fine-tune the list of methods by passing either a hash (for values :basic, :moderate, or :full) or an array of strings (for :custom).
+
+The hash must have keys named either :include or :exclude which are set to an array of strings.
+
+Each string in these arrays must follow the pattern *Class.class_method*, *Class#instance_method*, *Class*, or *method_name*.
+
+The following is an example configuration that only benchmarks a discreet set of methods:
+
+```ruby
+config.benchmark_methods :custom, %w(User.authenticate! run)
+```
+
+In the example above, the only methods benchmarked will be the method 'authenticate!' in class 'User' and any method named 'run' in any instance or class defined in your project.
+
+By contrast, you can benchmark all methods defined in your project except for a discreet set:
+
+```ruby
+config.benchmark_methods :full, :exclude => %w(User#full_name User#last_name Widget.expired MyLogger perform)
+```
+
+In the example above, the methods 'full_name' and 'last_name' in any instance of class 'User', the class method 'expired' in class 'Widget', any instance or class method in 'MyLogger' and any method named 'perform' in any instance or class will not be benchmarked.
+
+Similarly, any method in your project not benchmarked by default can be included:
+
+```ruby
+config.benchmark_methods :basic, :include => %w(BackgroundJob#running? User#_callback_after_1135 User#_callback_after_1136)
+```
+
+These options can be used in conjunction:
+
+```ruby
+config.benchmark_methods :moderate, :include => %w(MyCustomLibrary), :exclude => %w(ReportsController User#generate_password)
+```
+
+In the case where a method is named in both *include* and *exclude* lists, the *exclude* list takes precendence.
+
+For a Rails project, run `rake copperegg:apm:methods` on the command line in your application root directory to print a list of all methods defined in your project and whether or not they are benchmarked.
+
+For non-Rails projects, this can be acheived by running `copperegg-apm-methods` on the command line in your application root directory.
+
+Automatic method benchmarking is only available for Ruby 1.9+ and REE.
+
+**Because benchmarking is added to your methods using reflection and metaprogramming, you should use this directive with discretion to avoid performance degredation.**
+
+#### Block-based Method Benchmarking
+
+Even with method benchmarking disabled, you can still benchmark blocks of code with the `CopperEgg::APM.benchmark` method.
+
+```ruby
+def generate_password(length=16)
+  CopperEgg::APM.benchmark(self) do
+    chars = ("a".."z").to_a + ("0".."9").to_a + %w($ * - _)          
+    password = Array.new(length).map { chars[rand(chars.length)].send([:upcase,:downcase][rand(2)]) }.join
+    while !PASSWORD_PATTERN.match(password) do
+      password = generate_password(length, include_special)
+    end
+  end
+  password
+end
+```
+
+### Supported Databases
+
+Database query benchmarking is supported for the following engines:
+
++ MySQL (via the mysql and mysql2 gems)
++ PostgreSQL (via the pg gem)
++ SQLite (via the sqlite3 gem)
+
+### Supported Gems For Benchmarking Outbound HTTP Requests
+
+Outbound HTTP requests performed within your project will be benchmarked from any of the following sources:
+
++ Net/HTTP
++ Ethon
++ Typhoeus::Hydra
++ RestClient
+
+## Exception Aggregation
+
+When exception benchmarking is enabled, any exception raised in your project will be aggregated by class, source location, and system.
+
+## Disable Gem Functionality
+
+To temporarily disable all functionality of this gem, set all `config.benchmark_` values to false in the configuration file and then restart your application:
+
+```ruby
+CopperEgg::APM.configure do |config|
+  config.instrument_key = "IOFiZ4cslRiV5SXl"
+  config.benchmark_sql        = false
+  config.benchmark_http       = false
+  config.benchmark_exceptions = false
+  config.benchmark_methods    = false
+end
+```
+
+## Support
+
+Questions or problems? Contact [CopperEgg Support](https://copperegg.zendesk.com/home)
+
+## License
+
+CopperEgg::APM is released under the [MIT license](http://www.opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,4 @@
+require 'rake'
+require 'bundler'
+Bundler.setup
+Bundler::GemHelper.install_tasks

data/bin/copperegg-apm-init

@@ -0,0 +1,45 @@
+#!/usr/bin/env ruby
+
+begin
+  require 'copperegg-apm'
+rescue LoadError
+  require 'rubygems'
+  require 'copperegg-apm'
+end
+
+require 'optparse'
+require 'erb'
+
+template = File.read File.join(File.dirname(__FILE__), '../lib/generators/copperegg/apm/templates/config.rb')
+
+options = OptionParser.new do |opts|
+  opts.banner = "Usage: #{File.basename(__FILE__)}"
+
+  opts.on("-h") do
+    puts opts.banner
+  end
+end.parse!
+
+template_path = if File.exists?(File.join(Dir.pwd, "config", "initializers"))
+                  File.join(Dir.pwd, "config", "initializers", "copperegg_apm_config.rb")
+                else
+                  File.join(Dir.pwd, "copperegg_apm_config.rb")
+                end
+
+if File.exists?(template_path)
+  print "Override existing file #{template_path}? (Y/n): "
+  if gets =~ /n/i
+    puts "Configuration file creation abandoned."
+    exit
+  end
+end
+
+print "Enter your instrument key: "
+
+instrument_key = gets.strip
+
+File.open(template_path, File::WRONLY|File::CREAT|File::TRUNC) do |file|
+  file.write "require 'copperegg-apm'\n" + ERB.new(template).result(binding)
+end
+
+puts "Configuration file written to #{template_path}."

data/bin/copperegg-apm-methods

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+
+begin
+  require 'copperegg-apm'
+rescue LoadError
+  require 'rubygems'
+  require 'copperegg-apm'
+end
+
+require File.join(File.dirname(__FILE__), '../lib/copperegg/apm/benchmark_methods_table')
+
+usage = "Usage: #{File.basename(__FILE__)} /path/to/startup_file"
+
+if ARGV[0].to_s.empty?
+  puts usage
+  exit
+elsif ARGV[0].strip == "-h" || ARGV[0].strip == "--help"
+  puts usage
+  exit
+elsif File.exists?(ARGV[0])
+  require ARGV[0]
+else
+  puts "No startup file found at #{ARGV[0]}. #{usage}"
+  exit
+end
+
+CopperEgg::APM::BenchmarkMethodsTable.new.print_table

data/copperegg-apm.gemspec

@@ -0,0 +1,34 @@
+require './lib/copperegg/apm/version'
+
+Gem::Specification.new do |s|
+  s.name    = 'copperegg-apm'
+  s.version = CopperEgg::APM::GEM_VERSION
+  s.authors = ['Mike Bradford']
+  s.email   = 'mbradford@copperegg.com'
+  s.date    = Time.now.utc.strftime("%Y-%m-%d")
+
+  s.homepage    = 'http://github.com/copperegg/apm'
+  s.summary     = "copperegg-apm-#{CopperEgg::APM::GEM_VERSION}"
+  s.description = 'CopperEgg Application Performance Monitoring'
+  s.license     = 'MIT'
+
+  s.platform      = Gem::Platform::RUBY
+  s.require_path  = 'lib'
+  s.files         = Dir["#{File.dirname(__FILE__)}/**/*"] + %w(README.md Rakefile copperegg-apm.gemspec)
+  s.test_files    = Dir.glob("spec/**/*.rb")
+  s.rdoc_options  = ['--line-numbers', '--inline-source', '--title', 'copperegg-apm', '--main', 'README.md']
+  s.executables   = ['copperegg-apm-init', 'copperegg-apm-methods']
+
+  s.add_development_dependency 'rake', '~> 10.0.0'
+  s.add_development_dependency 'rspec', '~> 2.11.0'
+  s.add_development_dependency 'rspec-rails', '~> 2.0'
+  s.add_development_dependency 'actionpack', '~> 3.0'
+  s.add_development_dependency 'faker', '~> 1.1.2'
+  s.add_development_dependency 'mysql', '~> 2.9'
+  s.add_development_dependency 'mysql2', '~> 0.2'
+  s.add_development_dependency 'sqlite3', '~> 1.3'
+  s.add_development_dependency 'pg', '~> 0.9'
+  s.add_development_dependency 'ethon', '~> 0.5'
+  s.add_development_dependency 'typhoeus', '~> 0.3'
+  s.add_development_dependency 'rest-client', '~> 1.6'
+end

data/ext/mkrf_conf.rb

@@ -0,0 +1,19 @@
+require 'rubygems'
+require 'rubygems/command.rb'
+require 'rubygems/dependency_installer.rb' 
+begin
+  Gem::Command.build_args = ARGV
+  rescue NoMethodError
+end 
+inst = Gem::DependencyInstaller.new
+begin
+  if RUBY_VERSION < "1.9"
+    inst.install "json"
+  end
+  rescue
+    exit(1)
+end 
+
+f = File.open(File.join(File.dirname(__FILE__), "Rakefile"), "w")   # create dummy rakefile to indicate success
+f.write("task :default\n")
+f.close

data/lib/copperegg-apm.rb

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__), "copperegg", "apm")