signalfx-rack-tracer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1649cbc11f954620b4dbcc34fd53f98d20f4c264e4f8366e4af340015a29411a
+  data.tar.gz: a92cf8e410b91990a7cc6b56d66f965087ab132ece0ed5892f97dd0010d7c0ba
+SHA512:
+  metadata.gz: f815c94a86608445230488c60535ccde7ba9dd9c94bd93af0d622512dda1606da3136724d92a3bfb3b2b5cdccc9855f95c2cfc0c7983d61355a357f61a4d1684
+  data.tar.gz: b21f5f3b0214987c52478e5f2434edb2d869ef217c1b7dd2557a09283e9af9f4c44eaaef6af35b756fbaa182836068dcf2debc30bc8e5227faa804014b2d2dae

data/.gitignore

@@ -0,0 +1,14 @@
+*.gem
+/vendor/
+/.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,28 @@
+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
+
+Style/FrozenStringLiteralComment:
+  Enabled: yes
+  EnforcedStyle: always
+  Include:
+    - 'lib/**/*'

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 sfx-rack-tracer.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Indrek Juhkam
+
+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,52 @@
+# Rack::Tracer
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sfx-rack-tracer'
+```
+
+## Usage
+
+```ruby
+require 'opentracing'
+OpenTracing.global_tracer = TracerImplementation.new
+
+require 'rack/tracer'
+use Rack::Tracer
+```
+
+You can access the created span using
+```ruby
+env['rack.span']
+```
+
+or you can use
+```ruby
+OpenTracing.active_span
+```
+See [opentracing-ruby](https://github.com/opentracing/opentracing-ruby) for more information how active_span works and what are its limitations.
+
+You can also add start and finish span callbacks
+```ruby
+use Rack::Tracer,
+    on_start_span: ->(span) { do_something(span) },
+    on_finish_span: ->(_span) { do_something(span) }
+```
+
+## 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-rack-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 'rack/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/lib/rack/tracer.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+require 'opentracing'
+
+module Rack
+  class Tracer
+    REQUEST_URI = 'REQUEST_URI'.freeze
+    REQUEST_METHOD = 'REQUEST_METHOD'.freeze
+
+    # Create a new Rack Tracer middleware.
+    #
+    # @param app The Rack application/middlewares stack.
+    # @param tracer [OpenTracing::Tracer] A tracer to be used when start_span, and extract
+    #        is called.
+    # @param on_start_span [Proc, nil] A callback evaluated after a new span is created.
+    # @param on_finish_span [Proc, nil] A callback evaluated after a span is finished.
+    # @param errors [Array<Class>] An array of error classes to be captured by the tracer
+    #        as errors. Errors are **not** muted by the middleware, they're re-raised afterwards.
+    def initialize(app, # rubocop:disable Metrics/ParameterLists
+                   tracer: OpenTracing.global_tracer,
+                   on_start_span: nil,
+                   on_finish_span: nil,
+                   trust_incoming_span: true,
+                   errors: [StandardError])
+      @app = app
+      @tracer = tracer
+      @on_start_span = on_start_span
+      @on_finish_span = on_finish_span
+      @trust_incoming_span = trust_incoming_span
+      @errors = errors
+    end
+
+    def call(env)
+      method = env[REQUEST_METHOD]
+
+      context = @tracer.extract(OpenTracing::FORMAT_RACK, env) if @trust_incoming_span
+      scope = @tracer.start_active_span(
+        method,
+        child_of: context,
+        tags: {
+          'component' => 'rack',
+          'span.kind' => 'server',
+          'http.method' => method,
+          'http.url' => env[REQUEST_URI]
+        }
+      )
+      span = scope.span
+
+      @on_start_span.call(span) if @on_start_span
+
+      env['rack.span'] = span
+
+      @app.call(env).tap do |status_code, _headers, _body|
+        span.set_tag('http.status_code', status_code)
+
+        route = route_from_env(env)
+        span.operation_name = route if route
+      end
+    rescue *@errors => e
+      route = route_from_env(env)
+      span.operation_name = route if route
+      span.record_exception(e)
+      raise
+    ensure
+      begin
+        scope.close
+      ensure
+        @on_finish_span.call(span) if @on_finish_span
+      end
+    end
+
+    private
+
+    def route_from_env(env)
+      if (sinatra_route = env['sinatra.route'])
+        sinatra_route
+      elsif (rails_controller = env['action_controller.instance'])
+        "#{env[REQUEST_METHOD]} #{rails_controller.controller_name}/#{rails_controller.action_name}"
+      elsif (grape_route_args = env['grape.routing_args'] || env['rack.routing_args'])
+        grape_route_from_args(grape_route_args)
+      end
+    end
+
+    def grape_route_from_args(route_args)
+      route_info = route_args[:route_info]
+      if route_info.respond_to?(:path)
+        route_info.path
+      elsif (rack_route_options = route_info.instance_variable_get(:@options))
+        rack_route_options[:path]
+      end
+    end
+  end
+end

data/rack-tracer.gemspec

@@ -0,0 +1,29 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = 'signalfx-rack-tracer'
+  spec.version       = '0.1.0'
+  spec.authors       = ['SignalFx Engineers']
+  spec.email         = ['eng@signalfx.com']
+
+  spec.summary       = 'Rack OpenTracing middleware'
+  spec.description   = ''
+  spec.homepage      = 'https://github.com/signalfx/ruby-rack-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', '~> 0.4'
+
+  spec.add_development_dependency 'bundler', '~> 2.1'
+  spec.add_development_dependency 'signalfx_test_tracer', '~> 0.1.3'
+  spec.add_development_dependency 'rack', '~> 2.0'
+  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'
+end

metadata

@@ -0,0 +1,167 @@
+--- !ruby/object:Gem::Specification
+name: signalfx-rack-tracer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- SignalFx Engineers
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-12-04 00:00:00.000000000 Z
+dependencies:
+- !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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: signalfx_test_tracer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.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
+description: ''
+email:
+- eng@signalfx.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rack/tracer.rb
+- rack-tracer.gemspec
+homepage: https://github.com/signalfx/ruby-rack-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: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: Rack OpenTracing middleware
+test_files: []