restclient-instrumentation 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c1c1baceda857fdf3902ec7abb4b00e91726b4db
+  data.tar.gz: 2a8ba43119fa5942c725d766895ea8e0bbb82fe2
+SHA512:
+  metadata.gz: a647b5687ec934895860d477f47beb29b99deae79bae16ca483b0c8f1e9659f69c84d83dcec33c27b5c4913510effaf09605786d85d86cc17c24937c47655493
+  data.tar.gz: a85da359bf7e87bbee66d31418feb108ca90b84a0ba8a33bbef932e825cf72167f54cb60cb4cc06d0c890b5a3c9655d14593bec7fec9d51e6b73c9d46a6f1532

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Appraisals

@@ -0,0 +1,8 @@
+appraise 'rest-client-latest' do
+  gem 'rest-client'
+end
+
+appraise 'rest-client-2.0.0' do
+  gem 'rest-client', '2.0.0'
+end
+

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in restclient-instrumentation.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Ashwin Chandrasekar
+
+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,56 @@
+# Restclient::Instrumentation
+
+This gem provides instrumentation for RestClient requests.
+
+## Supported versions:
+
+- MRI 2.0 and newer
+- rest-client 2.0.0 and newer
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'restclient-instrumentation'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install restclient-instrumentation
+
+## Usage
+
+To enable the instrumentation and patch RestClient:
+
+```ruby
+require 'restclient/instrumentation'
+
+RestClient::Instrumentation.instrument
+```
+
+`instrument` takes two parameters:
+- `propagate`: Enable propagating span contexts through request headers.
+  A value must be provided for this keyword argument
+- `tracer`: (Optional) Set an OpenTracing tracer to use.
+  Defaults to `OpenTracing.global_tracer`.
+
+In the case of an error, the span will be finished and tagged with the error code and message. However, the exception will still be passed up to the caller, and the caller must handle it or at least wait as long as the exporter's flush interval to ensure that the span gets exported.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/signalfx/ruby-restclient-instrumentation.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "restclient/instrumentation"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/gemfiles/rest_client_2.0.0.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rest-client", "2.0.0"
+
+gemspec path: "../"

data/gemfiles/rest_client_2.0.0.gemfile.lock

@@ -0,0 +1,74 @@
+PATH
+  remote: ..
+  specs:
+    restclient-instrumentation (0.1.0)
+      opentracing (~> 0.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    appraisal (2.2.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    domain_name (0.5.20180417)
+      unf (>= 0.0.5, < 1.0.0)
+    hashdiff (0.3.7)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    mime-types (3.2.2)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2018.0812)
+    netrc (0.11.0)
+    opentracing (0.4.3)
+    opentracing_test_tracer (0.1.1)
+      opentracing
+    public_suffix (3.0.3)
+    rake (10.5.0)
+    rest-client (2.0.0)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    safe_yaml (1.0.4)
+    thor (0.20.3)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.5)
+    webmock (3.4.2)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  appraisal (~> 2.2)
+  bundler (~> 1.16)
+  opentracing_test_tracer (~> 0.1)
+  rake (~> 10.0)
+  rest-client (= 2.0.0)
+  restclient-instrumentation!
+  rspec (~> 3.0)
+  webmock (~> 3.4.2)
+
+BUNDLED WITH
+   1.16.5

data/gemfiles/rest_client_latest.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rest-client"
+
+gemspec path: "../"

data/gemfiles/rest_client_latest.gemfile.lock

@@ -0,0 +1,74 @@
+PATH
+  remote: ..
+  specs:
+    restclient-instrumentation (0.1.0)
+      opentracing (~> 0.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    appraisal (2.2.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    domain_name (0.5.20180417)
+      unf (>= 0.0.5, < 1.0.0)
+    hashdiff (0.3.7)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    mime-types (3.2.2)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2018.0812)
+    netrc (0.11.0)
+    opentracing (0.4.3)
+    opentracing_test_tracer (0.1.1)
+      opentracing
+    public_suffix (3.0.3)
+    rake (10.5.0)
+    rest-client (2.0.2)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    safe_yaml (1.0.4)
+    thor (0.20.3)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.5)
+    webmock (3.4.2)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  appraisal (~> 2.2)
+  bundler (~> 1.16)
+  opentracing_test_tracer (~> 0.1)
+  rake (~> 10.0)
+  rest-client
+  restclient-instrumentation!
+  rspec (~> 3.0)
+  webmock (~> 3.4.2)
+
+BUNDLED WITH
+   1.16.5

data/lib/restclient/instrumentation.rb

@@ -0,0 +1,70 @@
+require "opentracing"
+require "restclient"
+require "restclient/instrumentation/version"
+
+module RestClient
+  module Instrumentation
+    class << self
+
+      attr_accessor :tracer
+
+      def instrument(tracer: OpenTracing.global_tracer, propagate:)
+        @tracer = tracer
+
+        patch_request
+        patch_transmit if propagate
+      end
+
+      def patch_request
+
+        ::RestClient::Request.class_eval do
+          alias_method :execute_original, :execute if !self.method_defined? :execute_original
+
+          def execute(&block)
+            tags = {
+              'span.kind' => 'client',
+              'http.method' => method,
+              'http.url' => url,
+            }
+
+            result = nil
+
+            span = ::RestClient::Instrumentation.tracer.start_span("restclient.execute", tags: tags)
+            begin
+              # make this available to the transmit method to inject the context
+              @span_context = span.context
+
+              result = execute_original(&block)
+
+              span.set_tag("http.status_code", result.code)
+            rescue => error
+              span.set_tag("http.status_code", error.http_code)
+              span.set_tag("error", true)
+              span.log_kv(key: "message", value: error.message)
+
+              # pass this along for the original caller to handle
+              raise error
+            ensure
+              span.finish()
+            end
+
+            result
+          end # execute
+        end # module_eval
+      end # patch_request
+
+      def patch_transmit
+        ::RestClient::Request.class_eval do
+
+          alias_method :transmit_original, :transmit if !self.method_defined? :transmit_original
+
+          def transmit(uri, req, payload, &block)
+            ::RestClient::Instrumentation.tracer.inject(@span_context, OpenTracing::FORMAT_RACK, req) if @span_context
+
+            transmit_original(uri, req, payload, &block)
+          end # transmit
+        end # class_eval
+      end # patch_transmit
+    end # class << self
+  end # module Instrumentation
+end # module RestClient

data/lib/restclient/instrumentation/version.rb

@@ -0,0 +1,5 @@
+module Restclient
+  module Instrumentation
+    VERSION = "0.1.0"
+  end
+end

data/restclient-instrumentation.gemspec

@@ -0,0 +1,34 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "restclient/instrumentation/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "restclient-instrumentation"
+  spec.version       = Restclient::Instrumentation::VERSION
+  spec.authors       = ["Ashwin Chandrasekar"]
+  spec.email         = ["achandrasekar@signalfx.com"]
+
+  spec.summary       = %q{Instrumentation for RestClient}
+  spec.description   = %q{OpenTracing auto-instrumentation for RestClient.}
+  spec.homepage      = "http://github.com/signalfx/ruby-restclient-instrumentation"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "opentracing", "~> 0.3"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "opentracing_test_tracer", "~> 0.1"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "webmock", "~> 3.4.2"
+  spec.add_development_dependency "appraisal", "~> 2.2"
+end

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: restclient-instrumentation
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ashwin Chandrasekar
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-12-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: opentracing
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: opentracing_test_tracer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.2
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+description: OpenTracing auto-instrumentation for RestClient.
+email:
+- achandrasekar@signalfx.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Appraisals
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- gemfiles/rest_client_2.0.0.gemfile
+- gemfiles/rest_client_2.0.0.gemfile.lock
+- gemfiles/rest_client_latest.gemfile
+- gemfiles/rest_client_latest.gemfile.lock
+- lib/restclient/instrumentation.rb
+- lib/restclient/instrumentation/version.rb
+- restclient-instrumentation.gemspec
+homepage: http://github.com/signalfx/ruby-restclient-instrumentation
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Instrumentation for RestClient
+test_files: []