newrelic-httpclient 0.1.0

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+log/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,7 @@
+script: "bundle exec ruby test/test_newrelic_httpclient.rb"
+
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - ruby-head

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in newrelic_httpclient.gemspec
+gemspec

data/LICENSE.md

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Yuki Nishijima
+
+MIT License
+
+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/README.md

@@ -0,0 +1,35 @@
+# NewRelic instrumentation for HTTPClient
+
+**`newrelic-httpclient`** allows transactions to show time spent inside httpclient requests.
+
+[![Build Status](https://travis-ci.org/yuki24/newrelic-httpclient.png?branch=master)](https://travis-ci.org/yuki24/newrelic-httpclient)
+[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/yuki24/newrelic-httpclient)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'newrelic-httpclient'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install newrelic-httpclient
+
+## Todo
+
+ * Allow to show time spent inside asynchronous requests
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Copyright
+Copyright (c) 2012 Yuki Nishijima. See LICENSE.md for further details.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/newrelic/httpclient.rb

@@ -0,0 +1,2 @@
+require 'newrelic_httpclient/instrumentation'
+require 'newrelic_httpclient/version'

data/lib/newrelic_httpclient/instrumentation.rb

@@ -0,0 +1,35 @@
+require 'new_relic/agent/method_tracer'
+
+DependencyDetection.defer do
+  @name = :httpclient
+
+  depends_on do
+    defined?(::HTTPClient) &&
+    !NewRelic::Control.instance['disable_httpclient'] &&
+    ENV['NEWRELIC_ENABLE'].to_s !~ /false|off|no/i
+  end
+
+  executes do
+    NewRelic::Agent.logger.debug 'Installing HTTPClient Instrumentation'
+  end
+
+  executes do
+    ::HTTPClient.class_eval do
+      def do_get_block_with_newrelic_trace(req, proxy, conn, &block)
+        host   = req.http_header.request_uri.host
+        method = req.http_header.request_method
+        metrics = ["External/#{host}/HTTPClient/#{method}", "External/#{host}/all", "External/all"]
+        if NewRelic::Agent::Instrumentation::MetricFrame.recording_web_transaction?
+          metrics << "External/allWeb"
+        else
+          metrics << "External/allOther"
+        end
+        self.class.trace_execution_scoped metrics do
+          do_get_block_without_newrelic_trace(req, proxy, conn, &block)
+        end
+      end
+      alias do_get_block_without_newrelic_trace do_get_block
+      alias do_get_block do_get_block_with_newrelic_trace
+    end
+  end
+end

data/lib/newrelic_httpclient/version.rb

@@ -0,0 +1,3 @@
+module NewrelicHttpclient
+  VERSION = "0.1.0"
+end

data/newrelic-httpclient.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'newrelic_httpclient/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "newrelic-httpclient"
+  gem.version       = NewrelicHttpclient::VERSION
+  gem.authors       = ["Yuki Nishijima"]
+  gem.email         = ["mail@yukinishijima.net"]
+  gem.description   = %q{newrelic-httpclient allows transactions to show time spent inside httpclient requests}
+  gem.summary       = %q{NewRelic instrumentation for HttpClient}
+  gem.homepage      = "https://github.com/yuki24/newrelic-httpclient"
+
+  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.require_paths = ["lib"]
+
+  gem.add_dependency "newrelic_rpm"
+  gem.add_development_dependency "httpclient"
+end

data/test/test_newrelic_httpclient.rb

@@ -0,0 +1,48 @@
+require 'test/unit'
+require 'httpclient'
+require 'newrelic/httpclient'
+
+class TestNewRelicHttpclient < Test::Unit::TestCase
+  include NewRelic::Agent::Instrumentation::ControllerInstrumentation
+
+  def setup
+    NewRelic::Agent.manual_start
+    @engine = NewRelic::Agent.instance.stats_engine
+    @engine.clear_stats
+
+    @client = HTTPClient.new
+  end
+
+  def assert_metrics(*m)
+    m.each do |x|
+      assert @engine.metrics.include?(x), "#{x} not in metrics"
+    end
+  end
+
+  def test_get
+    response = @client.get("http://www.google.com/index.html")
+
+    assert_match /<head>/i, response.body
+    assert_metrics "External/all",
+                   "External/www.google.com/HTTPClient/GET",
+                   "External/allOther",
+                   "External/www.google.com/all"
+  end
+
+  def test_post
+    response = @client.post("http://www.google.com/index.html")
+
+    assert_metrics "External/all",
+                   "External/www.google.com/HTTPClient/POST",
+                   "External/allOther",
+                   "External/www.google.com/all"
+  end
+
+  def test_ignore
+    NewRelic::Agent.disable_all_tracing do
+      @client.get("http://www.google.com/index.html")
+    end
+
+    assert_equal 0, @engine.metrics.size
+  end
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: newrelic-httpclient
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Yuki Nishijima
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: newrelic_rpm
+  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: httpclient
+  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-httpclient allows transactions to show time spent inside httpclient
+  requests
+email:
+- mail@yukinishijima.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- lib/newrelic/httpclient.rb
+- lib/newrelic_httpclient/instrumentation.rb
+- lib/newrelic_httpclient/version.rb
+- newrelic-httpclient.gemspec
+- test/test_newrelic_httpclient.rb
+homepage: https://github.com/yuki24/newrelic-httpclient
+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.24
+signing_key: 
+specification_version: 3
+summary: NewRelic instrumentation for HttpClient
+test_files:
+- test/test_newrelic_httpclient.rb