restclient-opentracing 0.1.0.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a1dff7609b8def9d6b2f5a15d583499cd214d52a300a039791402fc2f56db0c1
+  data.tar.gz: 4a7801b4bc93d10f9eb6ba91eb6d0d97f62f5b707192f663bbd33810ae319c8b
+SHA512:
+  metadata.gz: 8ae6750c391f9e5ed60127fd72c38613a16410e999ce5fabea8823c9579368a2797c940e49cda3c9ebf2d9aef79a6cbe5be63c56f82222df27700f8d9a628057
+  data.tar.gz: 6f30b71a8c56b68583876536b49d853b43695b796997be347dc9829328a1d9110e83383825e3989fe8485a975a24780d98e40041dacbb64f30bd0559c0c03ac6

data/README.md

@@ -0,0 +1,65 @@
+
+[![Build Status](https://travis-ci.com/foodiefm/restclient-opentracing.svg?branch=master)](https://travis-ci.com/foodiefm/restclient-opentracing)
+[![Coverage Status](https://coveralls.io/repos/github/foodiefm/restclient-opentracing/badge.svg?branch=master)](https://coveralls.io/github/foodiefm/restclient-opentracing?branch=master)
+
+# RestClient::Opentracing
+
+
+Opentracing instrumentation for RestClient
+
+
+TODO: publish the gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'restclient-opentracing'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install restclient-opentracing
+
+## Usage
+
+
+```
+require 'restclient/opentracing'
+
+RestClient::OpenTracing.instrument
+```
+
+disable passing traces down the wire:
+
+```
+require 'restclient/opentracing'
+
+RestClient::OpenTracing.instrument do |config|
+  config.distributed_tracing = false
+end
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 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/foodiefm/restclient-opentracing. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Redis::Opentracing project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/foodiefm/restclient-opentracing/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/restclient/opentracing/instrument.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module RestClient
+  module OpenTracing
+    module Instrument
+      def execute(&block)
+        uri = URI.parse(url)
+        scope = ::OpenTracing.start_active_span([method.to_s.upcase, uri.host].join(' '),
+                                                tags: tags(uri))
+        span = scope.span
+
+        if RestClient::OpenTracing.config.distributed_tracing
+          ::OpenTracing.inject(span.context, ::OpenTracing::FORMAT_RACK,
+                               processed_headers)
+        end
+
+        response = super(&block)
+
+        if response.is_a?(::RestClient::Response)
+          span.set_tag('status', response.code)
+        end
+
+        response
+      rescue ::RestClient::ExceptionWithResponse => e
+        span.set_tag('error', true)
+        span.log_kv(key: 'error', value: e.to_s)
+        span.set_tag('status', e.http_code)
+
+        raise e
+      rescue Exception => e
+        span.set_tag('error', true)
+        span.log_kv(key: 'error', value: e.to_s)
+        raise e
+      ensure
+        scope.close
+      end
+
+      private
+
+      def tags(uri)
+        {
+          'path' => uri.path,
+          'host' => uri.host,
+          'port' => uri.port
+        }
+      end
+    end
+  end
+end

data/lib/restclient/opentracing/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module RestClient
+  module OpenTracing
+    VERSION = '0.1.0'
+  end
+end

data/lib/restclient/opentracing.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'restclient/opentracing/version'
+require 'restclient/opentracing/instrument'
+
+module RestClient
+  module OpenTracing
+    def self.instrument
+      @config ||= OpenStruct.new(distributed_tracing: true)
+      yield(@config) if block_given?
+      require 'rest-client'
+      ::RestClient::Request.send(:prepend, Instrument)
+      self
+    end
+
+    def self.config
+      @config
+    end
+  end
+end

metadata

@@ -0,0 +1,191 @@
+--- !ruby/object:Gem::Specification
+name: restclient-opentracing
+version: !ruby/object:Gem::Version
+  version: 0.1.0.pre
+platform: ruby
+authors:
+- larte
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-08-30 00:00:00.000000000 Z
+dependencies:
+- !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: 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: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.71.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.71.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.33.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.33.0
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: opentracing
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+description: Enable distributed tracing and intrumentation for restclient
+email:
+- larte@foodie.fm
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- lib/restclient/opentracing.rb
+- lib/restclient/opentracing/instrument.rb
+- lib/restclient/opentracing/version.rb
+homepage: https://github.com/foodie.fm/restclient-opentracing
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/foodiefm/redisrb-opentracing/issues
+  homepage_uri: https://github.com/foodiefm/redisrb-opentracing
+  source_code_uri: https://github.com/foodiefm/redisrb-opentracing
+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: 1.3.1
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Enable distributed tracing and intrumentation for restclient
+test_files: []