newrelic_riak 0.0.3

data/.gitignore

@@ -0,0 +1,5 @@
+*.swp
+coverage
+log
+config/newrelic.yml
+

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'ruby-prof'
+  gem 'simplecov'
+  gem 'debugger'
+  gem 'riak-client', '~> 1.1.1'
+  gem 'ripple', :git => 'git://github.com/basho/ripple.git'
+  gem 'ripple-encryption', '~> 0.0.4'
+end

data/Gemfile.lock

@@ -0,0 +1,72 @@
+GIT
+  remote: git://github.com/basho/ripple.git
+  revision: 20c7dba18448437930136f3a6da57d8d091a63a5
+  specs:
+    ripple (1.0.0.beta2)
+      activemodel (>= 3.0.0, < 3.3.0)
+      activesupport (>= 3.0.0, < 3.3.0)
+      riak-client (~> 1.1.0)
+      tzinfo
+
+PATH
+  remote: .
+  specs:
+    newrelic_riak (0.0.3)
+      newrelic_rpm (~> 3.0)
+      rake
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (3.2.12)
+      activesupport (= 3.2.12)
+      builder (~> 3.0.0)
+    activesupport (3.2.12)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    beefcake (0.3.7)
+    builder (3.0.4)
+    columnize (0.3.6)
+    debugger (1.6.0)
+      columnize (>= 0.3.1)
+      debugger-linecache (~> 1.2.0)
+      debugger-ruby_core_source (~> 1.2.1)
+    debugger-linecache (1.2.0)
+    debugger-ruby_core_source (1.2.3)
+    i18n (0.6.4)
+    innertube (1.0.2)
+    mini_shoulda (0.5.0)
+      minitest (> 2.1.0)
+    minitest (3.3.0)
+    multi_json (1.7.7)
+    newrelic_rpm (3.6.5.130)
+    rake (10.0.3)
+    riak-client (1.1.1)
+      beefcake (~> 0.3.7)
+      builder (>= 2.1.2)
+      i18n (>= 0.4.0)
+      innertube (~> 1.0.2)
+      multi_json (~> 1.0)
+    ripple-encryption (0.0.4)
+      rake
+      riak-client
+      ripple
+    ruby-prof (0.13.0)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
+    tzinfo (1.0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  debugger
+  mini_shoulda
+  newrelic_riak!
+  riak-client (~> 1.1.1)
+  ripple!
+  ripple-encryption (~> 0.0.4)
+  ruby-prof
+  simplecov

data/README.md

@@ -0,0 +1,31 @@
+## The NewRelic Riak gem
+NewRelic instrumentation for [riak-ruby-client](https://github.com/basho/riak-ruby-client), [ripple](https://github.com/basho/ripple), and [ripple-encryption](https://github.com/basho/ripple-encryption).
+
+## Dependencies
+`newrelic-riak` requires:
+- Ruby 1.9.3 or later
+- [newrelic](https://github.com/newrelic/rpm)
+- [riak-ruby-client](https://github.com/basho/riak-ruby-client)
+
+While the following are optional:
+- [ripple](https://github.com/basho/ripple)
+- [ripple-encryption](https://github.com/basho/ripple-encryption)
+
+## Installation
+Add the gem file reference to the Gemfile:
+
+``` ruby
+gem 'newrelic_riak', '~> 0.0.3'
+```
+
+## Usage
+Just require the gem where you need it:
+
+``` ruby
+require 'newrelic_riak'
+```
+
+## Running the Tests
+The tests currently assume you have riak running locally on port 8098.
+
+    bundle exec rake

data/Rakefile

@@ -0,0 +1,18 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rake'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/**/test_*.rb']
+  t.verbose = true
+end
+
+namespace :test do
+  desc "Test everything"
+  task :all => [:test]
+end
+
+task :default => :test

data/config/newrelic.yml.example

@@ -0,0 +1,21 @@
+test:
+  app_name: NewRelic Riak - local (test)
+  monitor_mode: true
+  developer_mode: true
+  log_level: debug
+  ssl: true
+  apdex_t: 0.5
+  capture_params: false
+  transaction_tracer:
+    enabled: true
+    transaction_threshold: apdex_f
+    record_sql: obfuscated
+    stack_trace_threshold: 0.500
+  error_collector:
+    enabled: true
+    capture_source: true
+    ignore_errors: ActionController::RoutingError
+  #disable_riak: true
+  #disable_ripple: true
+  #disable_ripple_encryption: true
+  #riak_impersonate_activerecord: true

data/lib/newrelic_riak.rb

@@ -0,0 +1,5 @@
+require 'newrelic_riak/instrumentation'
+require 'newrelic_riak/riak_client'
+require 'newrelic_riak/ripple'
+require 'newrelic_riak/ripple_encryption'
+

data/lib/newrelic_riak/instrumentation.rb

@@ -0,0 +1,35 @@
+def add_riak_tracer(metric_prefix, operation)
+  op = operation
+  define_method("#{op}_with_newrelic_trace") do |*args, &blk|
+    if NewRelic::Agent::Instrumentation::MetricFrame.recording_web_transaction?
+      total_metric = "#{metric_prefix}/allWeb"
+    else
+      total_metric = "#{metric_prefix}/allOther"
+    end
+
+    bucket = case args[0]
+    when Riak::Bucket
+      args[0].name
+    when Riak::RObject
+      args[0].bucket.name
+    when String
+      args[0]
+    end unless self.class.to_s.match /^Ripple::Encryption/ # don't load ripple here
+
+    metrics = bucket ? ["#{metric_prefix}/#{bucket}##{op}", total_metric] : ["#{metric_prefix}/#{op}", total_metric]
+
+    self.class.trace_execution_scoped(metrics) do
+      start = Time.now
+
+      begin
+        method_name = "#{op}_without_newrelic_trace"
+        send(method_name, *args, &blk)
+      ensure
+        s = NewRelic::Agent.instance.transaction_sampler
+        s.notice_nosql(args.inspect, (Time.now - start).to_f) rescue nil
+      end
+    end
+  end
+  alias_method "#{op}_without_newrelic_trace".to_sym, op.to_sym
+  alias_method op.to_sym, "#{op}_with_newrelic_trace".to_sym
+end

data/lib/newrelic_riak/riak_client.rb

@@ -0,0 +1,48 @@
+require 'new_relic/agent/method_tracer'
+
+DependencyDetection.defer do
+  @name = :riak
+
+  depends_on do
+    defined?(::Riak) &&
+    !NewRelic::Control.instance['disable_riak'] &&
+    ENV['NEWRELIC_ENABLE'].to_s !~ /false|off|no/i
+  end
+
+  executes do
+    NewRelic::Agent.logger.debug 'Installing Riak Instrumentation'
+  end
+
+  riak_metric_prefix = NewRelic::Control.instance['riak_impersonate_activerecord'] ? 'ActiveRecord' : 'Database/Riak'
+
+  executes do
+    ::Riak::Client.class_eval do
+      operations = [:bucket, :ping, :list_buckets, :get_bucket_props, :set_bucket_props,
+        :mapred, :list_keys, :get_object, :reload_object, :store_object, :delete_object]
+
+      operations.each do |key|
+        add_riak_tracer(riak_metric_prefix, key.to_s)
+      end
+    end
+
+    ::Riak::Client::BeefcakeProtobuffsBackend.class_eval do
+      operations = [:server_info, :get_client_id, :set_client_id]
+
+      operations.each do |key|
+        add_riak_tracer(riak_metric_prefix, key.to_s)
+      end
+    end
+
+    ::Riak::Client::HTTPBackend.class_eval do
+      operations = [:stats, :link_walk, :get_index, :search, :update_search_index]
+      
+      operations.each do |key|
+        add_riak_tracer(riak_metric_prefix, key.to_s)
+      end
+    end
+
+    ::Riak::RObject.class_eval do
+      add_riak_tracer riak_metric_prefix, :serialize.to_s
+    end
+  end
+end

data/lib/newrelic_riak/ripple.rb

@@ -0,0 +1,49 @@
+require 'new_relic/agent/method_tracer'
+
+DependencyDetection.defer do
+  @name = :ripple
+
+  depends_on do
+    defined?(::Ripple) and not
+      NewRelic::Control.instance['disable_ripple']
+  end
+
+  executes do
+    NewRelic::Agent.logger.debug 'Installing Ripple Instrumentation'
+  end
+
+  riak_metric_prefix = NewRelic::Control.instance['riak_impersonate_activerecord'] ? 'ActiveRecord' : 'Database/Ripple'
+
+  executes do
+    ::Ripple::Callbacks.class_eval do
+      add_riak_tracer riak_metric_prefix, :valid?.to_s
+    end
+
+    ::Ripple::Document::Persistence::ClassMethods.class_eval do
+      # operations = [:create, :destroy, :destroy_all]
+      operations = [:create, :destroy_all]
+
+      operations.each do |key|
+        add_riak_tracer(riak_metric_prefix, key.to_s)
+      end
+    end
+
+
+    (defined?(::Ripple::Document::Persistence::InstanceMethods) ? 
+      ::Ripple::Document::Persistence::InstanceMethods : ::Ripple::Document::Persistence).class_eval do
+      operations = [:really_save, :reload, :destroy!, :update_attribute, :update_attributes]
+
+      operations.each do |key|
+        add_riak_tracer(riak_metric_prefix, key.to_s)
+      end
+    end
+
+    ::Ripple::Document::Finders::ClassMethods.class_eval do
+      operations = [:find, :list]
+
+      operations.each do |key|
+        add_riak_tracer(riak_metric_prefix, key.to_s)
+      end
+    end
+  end
+end

data/lib/newrelic_riak/ripple_encryption.rb

@@ -0,0 +1,33 @@
+require 'new_relic/agent/method_tracer'
+
+DependencyDetection.defer do
+  @name = :ripple_encryption
+
+  depends_on do
+    defined?(::Ripple::Encryption) and not NewRelic::Control.instance['disable_ripple_encryption']
+  end
+
+  executes do
+    NewRelic::Agent.logger.debug 'Installing Ripple Encryption Instrumentation'
+  end
+
+  riak_metric_prefix = NewRelic::Control.instance['riak_impersonate_activerecord'] ? 'ActiveRecord' : 'Database/RippleEncryption'
+
+  executes do
+    ::Ripple::Encryption::JsonSerializer.class_eval do
+      operations = [:dump, :load]
+
+      operations.each do |key|
+        add_riak_tracer(riak_metric_prefix, key.to_s)
+      end
+    end
+
+    ::Ripple::Encryption::Encryptor.class_eval do
+      operations = [:encrypt, :decrypt]
+
+      operations.each do |key|
+        add_riak_tracer(riak_metric_prefix, key.to_s)
+      end
+    end
+  end
+end

data/lib/newrelic_riak/version.rb

@@ -0,0 +1,5 @@
+module Basho
+  module NewRelic
+    VERSION = "0.0.3"
+  end
+end

data/newrelic_riak.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/newrelic_riak/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Randy Secrist"]
+  gem.email         = ["rsecrist@basho.com"]
+  gem.description   = %q{NewRelic instrumentation for Riak.}
+  gem.summary       = %q{Sends performance metrics related to Riak to NewRelic}
+  gem.homepage      = "http://github.com/basho/newrelic-riak"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name = "newrelic_riak"
+  gem.require_paths = ['lib']
+  gem.version       = Basho::NewRelic::VERSION
+
+  gem.add_dependency 'rake'
+
+  gem.add_runtime_dependency(%q<newrelic_rpm>, ["~> 3.0"])
+
+  # Test Dependencies
+  gem.add_development_dependency 'simplecov'
+  gem.add_development_dependency 'mini_shoulda'
+  gem.add_development_dependency 'ruby-prof'
+  gem.add_development_dependency 'debugger'
+  gem.add_development_dependency 'riak-client'
+end
+

data/test/fixtures/encryption.yml

@@ -0,0 +1,5 @@
+test:
+  cipher: AES-256-CBC
+  key: fantasticobscurekeygoesherenowty
+  iv: !binary |
+    ABYLnUHWE/fIwE2gKYC6hg==

data/test/fixtures/ripple.yml

@@ -0,0 +1,4 @@
+test:
+  host: 127.0.0.1
+  http_port: 8098
+  namespace: test_ns~

data/test/helper.rb

@@ -0,0 +1,35 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'rake'
+
+require 'simplecov'
+SimpleCov.start do
+  project_name "Basho - NewRelic Instrumentation"
+  add_filter "/test/"
+end
+
+require 'minitest/autorun'
+require 'mini_shoulda'
+
+require 'riak'
+require 'ripple'
+require 'ripple-encryption'
+require 'newrelic_riak'
+
+ENV['RACK_ENV']   = 'test'
+ENV['RIPPLE']     = File.expand_path(File.join('..','fixtures','ripple.yml'),__FILE__)
+ENV['ENCRYPTION'] = File.expand_path(File.join('..','fixtures','encryption.yml'),__FILE__)
+
+Ripple::Encryption.activate ENV['ENCRYPTION']
+class TestDocument
+  include Ripple::Document
+  include Ripple::Encryption
+  property :message, String
+
+  def self.bucket_name
+    "#{Ripple.config[:namespace]}#{super}"
+  end
+end
+
+TestDocument.bucket.get_index('$bucket', '_').each {|k| TestDocument.bucket.delete(k)}

data/test/test_newrelic_riak.rb

@@ -0,0 +1,63 @@
+require 'helper'
+
+class TestNewRelicRiak < MiniTest::Spec
+  include NewRelic::Agent::Instrumentation::ControllerInstrumentation
+
+  PORT = 8098
+  OPTIONS = {}
+  
+  def assert_metrics(*m)
+    m.each do |x|
+      assert @engine.metrics.include?(x), "#{x} not in metrics: #{@engine.metrics}"
+    end
+  end
+
+  context 'test metrics' do
+    setup do
+      NewRelic::Agent.manual_start
+      @engine = NewRelic::Agent.instance.stats_engine
+      @engine.clear_stats
+
+      @sampler = NewRelic::Agent.instance.transaction_sampler
+      @sampler.reset!
+      @sampler.start_builder
+
+      @client = ::Riak::Client.new OPTIONS
+    end
+
+    teardown do
+      @sampler.clear_builder
+    end
+
+    should 'record riak metrics' do
+      bucket = @client.bucket "random_bucket"
+      object = bucket.get_or_new("index.html")
+      object.raw_data = "<html><body>Hello, world!</body></html>"
+      object.content_type = "text/html"
+      object.store
+      assert_metrics(
+        "Database/Riak/#{bucket.name}#bucket",
+        "Database/Riak/#{bucket.name}#get_object",
+        "Database/Riak/#{bucket.name}#store_object",
+        "Database/Riak/allOther")
+    end
+
+    should 'record ripple metrics' do
+      doc = TestDocument.create({:message => 'this is a test message'})
+      doc.save!
+      assert_metrics(
+        "Database/Ripple/allOther",
+        "Database/Ripple/valid?",
+        "Database/Riak/allOther",
+        "Database/Riak/test_documents#bucket",
+        "Database/RippleEncryption/allOther",
+        "Database/RippleEncryption/encrypt",
+        "Database/RippleEncryption/dump",
+        "Database/RippleEncryption/decrypt",
+        "Database/RippleEncryption/load",
+        "Database/Riak/test_documents#store_object",
+        "Database/Ripple/really_save",
+        "Database/Ripple/create")
+    end
+  end
+end

metadata

@@ -0,0 +1,178 @@
+--- !ruby/object:Gem::Specification
+name: newrelic_riak
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+  prerelease: 
+platform: ruby
+authors:
+- Randy Secrist
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: newrelic_rpm
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mini_shoulda
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ruby-prof
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: debugger
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: riak-client
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: NewRelic instrumentation for Riak.
+email:
+- rsecrist@basho.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- config/newrelic.yml.example
+- lib/newrelic_riak.rb
+- lib/newrelic_riak/instrumentation.rb
+- lib/newrelic_riak/riak_client.rb
+- lib/newrelic_riak/ripple.rb
+- lib/newrelic_riak/ripple_encryption.rb
+- lib/newrelic_riak/version.rb
+- newrelic_riak.gemspec
+- test/fixtures/encryption.yml
+- test/fixtures/ripple.yml
+- test/helper.rb
+- test/test_newrelic_riak.rb
+homepage: http://github.com/basho/newrelic-riak
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Sends performance metrics related to Riak to NewRelic
+test_files:
+- test/fixtures/encryption.yml
+- test/fixtures/ripple.yml
+- test/helper.rb
+- test/test_newrelic_riak.rb