signalfx-faraday-instrumentation 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 07fddec0f3dc229c51f1fdf038fac47ae8224013dd6a72aa744c9443dc1ac6c0
+  data.tar.gz: 2af14a3aabec25f66e57a0fe9838f0dee14e89320ac8e9082f518a3c1a94ed1a
+SHA512:
+  metadata.gz: 787573b4955ace043d9299bf063fbcf93f3cc53a07064f938475021eb29d237c8733a54cccfdf00dd2d912308ca7a39ad2f79ac15e5211d23a4ab0d3d583925c
+  data.tar.gz: ad7d6b6b4e35acabaa14b4ccedb441ef4ee66cf15f060c0645d648d797ca5103bbae3c479aa88faa9b9fed1b8c5ed2a001bd736f6b3da6fef281109aebc2f6d6

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,34 @@
+require: rubocop-rspec
+
+Metrics/AbcSize:
+  Enabled: no
+
+Metrics/BlockLength:
+  Enabled: no
+
+Metrics/LineLength:
+  Max: 120
+
+Metrics/MethodLength:
+  Enabled: no
+
+Style/Documentation:
+  Enabled: no
+
+RSpec/ExampleLength:
+  Enabled: no
+
+RSpec/MultipleExpectations:
+  Enabled: no
+
+RSpec/MessageSpies:
+  Enabled: no
+
+Style/FrozenStringLiteralComment:
+  Enabled: yes
+  EnforcedStyle: always
+  Include:
+    - 'lib/**/*'
+
+Naming/FileName:
+  Enabled: no

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+before_install: gem install bundler -v 1.14.6

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 SaleMove
+
+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,91 @@
+# Faraday::Tracer
+
+OpenTracing compatible Faraday middleware:
+
+* It wraps all outgoing requests in spans
+* It adds the trace context to outgoing requests
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'faraday-tracer'
+```
+
+## Usage
+
+### Using request context
+
+```ruby
+require 'opentracing'
+OpenTracing.global_tracer = TracerImplementation.new
+
+require 'faraday'
+require 'faraday/tracer'
+
+conn = Faraday.new(url: 'http://localhost:3000/') do |faraday|
+  # Add tracing support
+  faraday.use Faraday::Tracer
+
+  # default Faraday stack
+  faraday.request :url_encoded
+  faraday.adapter Faraday.default_adapter
+end
+
+span = request.env['rack.span'] # when using rack-tracer gem
+
+conn.post('/test') do |request|
+  # Leave undefined or set span to nil if there's no existing span
+  request.options.context = {span: span}
+end
+```
+
+
+### Defining span in the connection builder
+
+```ruby
+require 'opentracing'
+OpenTracing.global_tracer = TracerImplementation.new
+
+require 'faraday'
+require 'faraday/tracer'
+
+# Use already existing span to use it as as a parent span. In case there is no
+# existing span leave it nil to start a new trace.
+span = request.env['rack.span'] # when using rack-tracer gem
+
+conn = Faraday.new(url: 'http://localhost:3000/') do |faraday|
+  faraday.use Faraday::Tracer, span: span
+
+  # default Faraday stack
+  faraday.request :url_encoded
+  faraday.adapter Faraday.default_adapter
+end
+```
+
+### Span name
+
+By default, all spans are given a default name. You may also override this by
+passing a `:span_name` in the middleware options hash and/or the request
+options.
+
+### Service name
+
+It's possible to define the remote service name by using `:service_name` option.
+
+## 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/opentracing-contrib/ruby-faraday-tracer.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+RuboCop::RakeTask.new(:rubocop)
+
+task default: %i[rubocop spec]

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'faraday/tracer'
+
+# 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/faraday-tracer.gemspec

@@ -0,0 +1,31 @@
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = 'signalfx-faraday-instrumentation'
+  spec.version       = '0.1.0'
+  spec.authors       = ['SaleMove TechMovers']
+  spec.email         = ['techmovers@salemove.com']
+
+  spec.summary       = 'Fork of Faraday::Tracer'
+  spec.description   = ''
+  spec.homepage      = 'https://github.com/signalfx/ruby-faraday-tracer'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'opentracing'
+
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'faraday'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.54.0'
+  spec.add_development_dependency 'rubocop-rspec', '~> 1.24.0'
+  spec.add_development_dependency 'test-tracer', '~> 1.0'
+  spec.add_development_dependency 'tracing-matchers', '~> 1.0'
+end

data/lib/faraday/tracer.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+require 'faraday'
+require 'opentracing'
+
+module Faraday
+  class Tracer < Faraday::Middleware
+    # Create a new Faraday Tracer middleware.
+    #
+    # @param app The faraday application/middlewares stack.
+    # @param span [Span, SpanContext, Proc, nil] SpanContext that acts as a parent to
+    #        the newly-started by the middleware Span. If a Proc is provided, its
+    #        evaluated during the call method invocation.
+    # @param span_name [String, nil] The name of the span to create.
+    # @param service_name [String, nil] Remote service name (for some
+    #        unspecified definition of "service")
+    # @param tracer [OpenTracing::Tracer] A tracer to be used when start_span, and inject
+    #        is called.
+    # @param errors [Array<Class>] An array of error classes to be captured by the tracer
+    #        as errors. Errors are **not** muted by the middleware.
+    def initialize( # rubocop:disable Metrics/ParameterLists
+        app,
+        span: nil,
+        span_name: nil,
+        service_name: nil,
+        tracer: OpenTracing.global_tracer,
+        errors: [StandardError]
+    )
+      super(app)
+      @tracer = tracer
+      @parent_span = span
+      @span_name = span_name
+      @service_name = service_name
+      @errors = errors
+    end
+
+    def call(env)
+      span = @tracer.start_span(span_name(env),
+                                child_of: parent_span(env),
+                                tags: prepare_tags(env))
+      @tracer.inject(span.context, OpenTracing::FORMAT_RACK, env[:request_headers])
+      @app.call(env).on_complete do |response|
+        span.set_tag('http.status_code', response.status)
+
+        if response.status >= 500
+          span.set_tag('error', true)
+          span.log_kv(event: 'error', message: response.body.to_s)
+        end
+      end
+    rescue *@errors => e
+      span.set_tag('error', true)
+      span.log_kv(event: 'error', :'error.object' => e)
+      raise
+    ensure
+      span.finish if span
+    end
+
+    private
+
+    def span_name(env)
+      context = env.request.context
+      context.is_a?(Hash) && context[:span_name] || @span_name || env[:method].to_s.upcase
+    end
+
+    def parent_span(env)
+      context = env.request.context
+      span = context.is_a?(Hash) && context[:span] || @parent_span
+      return unless span
+
+      span.respond_to?(:call) ? span.call : span
+    end
+
+    def prepare_tags(env)
+      tags = {
+        'component' => 'faraday',
+        'span.kind' => 'client',
+        'http.method' => env[:method],
+        'http.url' => env[:url].to_s
+      }
+
+      if (service_name = peer_service(env))
+        tags['peer.service'] = service_name
+      end
+
+      tags
+    end
+
+    def peer_service(env)
+      context = env.request.context
+      context.is_a?(Hash) && context[:service_name] || @service_name
+    end
+  end
+end

data/lib/faraday/tracer/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Faraday
+  module Tracer
+    VERSION = '0.1.0'.freeze
+  end
+end

metadata

@@ -0,0 +1,183 @@
+--- !ruby/object:Gem::Specification
+name: signalfx-faraday-instrumentation
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- SaleMove TechMovers
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-01-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: opentracing
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  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: 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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.54.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.54.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.24.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.24.0
+- !ruby/object:Gem::Dependency
+  name: test-tracer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: tracing-matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: ''
+email:
+- techmovers@salemove.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- faraday-tracer.gemspec
+- lib/faraday/tracer.rb
+- lib/faraday/tracer/version.rb
+homepage: https://github.com/signalfx/ruby-faraday-tracer
+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.7.3
+signing_key: 
+specification_version: 4
+summary: Fork of Faraday::Tracer
+test_files: []