rack-instrumentation 0.1.0.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f316ead3113e6157837293e94c50dc528466f27ee8983b8911f8630ce71f783d
+  data.tar.gz: 5a47543c79961dc0b2ef7af9f6ec7b3b7e390a160f34308898fdcf2f14a748cc
+SHA512:
+  metadata.gz: b9c23714e2f2444d4c005f272ecff7a3bb2b3f927aa3dcc54a8ac17c1266baccdae89d5fd29e2adc9adcde11f58b9543c8a7cb7f70a2d72548bfa51ddc537a26
+  data.tar.gz: 8c122474d7dc0e302ce4a2190496eabdaf55dbd54bf10e4aba79cfc9c4f579050bccfc5076030cfb88af081e52618490907d5a4895f26beafb11ea0f804656c6

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 2.0.2

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+Changelog
+=========
+
+## 0.1.0 11/07/2019
+  * Instrumention for OpenTracing using the rack middleware

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,42 @@
+PATH
+  remote: .
+  specs:
+    rack-instrumentation (0.1.0.pre)
+      opentracing (~> 0.5.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    opentracing (0.5.0)
+    opentracing_test_tracer (0.1.1)
+      opentracing
+    rack (2.0.7)
+    rake (10.5.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  opentracing_test_tracer (~> 0.1)
+  rack (~> 2.0)
+  rack-instrumentation!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Josh Lauer
+
+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-instrumentation
+
+Open Tracing instrumentation for [rack](https://github.com/rack/rack). By default it starts a new span for every request and follows the open tracing tagging [semantic conventions](https://opentracing.io/specification/conventions). This is inspired by the [rack-tracer](https://github.com/opentracing-contrib/ruby-rack-tracer) gem, and sections of the code here are taken from there.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "rack-instrumentation"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rack-instrumentation
+
+## Usage
+
+Require the gem (Note: this won't automatically instrument rack)
+```ruby
+require "rack/instrumentation"
+```
+
+If you have set up `OpenTracing.global_tracer` you can turn on spans for all requests in your `config.ru` thusly:
+```ruby
+use Rack::OpenTracing::Tracer
+```
+
+Similarly, this works for rails applications:
+```ruby
+Rails.application.configure do
+  config.middleware.use Rack::Instrumentation::Tracer
+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/[USERNAME]/rack-instrumentation-ruby.
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rack/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/lib/rack/instrumentation.rb

@@ -0,0 +1,7 @@
+require "rack/instrumentation/version"
+require "rack/instrumentation/tracer"
+
+module Rack
+  module Instrumentation
+  end
+end

data/lib/rack/instrumentation/tracer.rb

@@ -0,0 +1,70 @@
+require "rack/instrumentation/version"
+require "opentracing"
+
+module Rack
+  module Instrumentation
+    class Tracer
+      attr_reader :app, :tracer
+
+      # 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.
+      def initialize(app, tracer: OpenTracing.global_tracer)
+        @app = app
+        @tracer = tracer
+      end
+
+      def call(env)
+        tracer.start_active_span(*span_args(env)) do |scope|
+          span = scope.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 StandardError => e
+          span.set_tag('error', true)
+          span.log_kv(
+            event: 'error',
+            :'error.kind' => e.class.to_s,
+            :'error.object' => e,
+            message: e.message,
+            stack: e.backtrace.join("\n")
+          )
+          raise
+        end
+      end
+
+      private
+
+      def span_args(env)
+        method = env["REQUEST_METHOD"]
+        context = tracer.extract(OpenTracing::FORMAT_RACK, env)
+
+        [
+          method,
+          child_of: context,
+          tags: {
+            'component' => 'rack',
+            'span.kind' => 'server',
+            'http.method' => method,
+            'http.url' => env["REQUEST_URI"]
+          }
+        ]
+      end
+
+      def route_from_env(env)
+        rails_controller = env['action_controller.instance']
+
+        if rails_controller
+          "#{env["REQUEST_METHOD"]} #{rails_controller.controller_name}/#{rails_controller.action_name}"
+        end
+      end
+    end
+  end
+end

data/lib/rack/instrumentation/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  module Instrumentation
+    VERSION = "0.1.0.pre"
+  end
+end

data/rack-instrumentation-ruby.gemspec

@@ -0,0 +1,38 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "rack/instrumentation/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rack-instrumentation"
+  spec.version       = Rack::Instrumentation::VERSION
+  spec.authors       = ["Josh Lauer"]
+  spec.email         = ["me@joshlauer.com"]
+
+  spec.summary       = "OpenTracing instrumentation for rack"
+  spec.description   = "OpenTracing instrumentation for rack"
+  spec.homepage      = "https://github.com/josh-lauer/rack-instrumentation-ruby"
+  spec.license       = "MIT"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/josh-lauer/rack-instrumentation-ruby"
+  spec.metadata["changelog_uri"] = "https://github.com/josh-lauer/rack-instrumentation-ruby/master/CHANGELOG"
+
+  # 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.5.0"
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rack", "~> 2.0"
+  spec.add_development_dependency "opentracing_test_tracer", "~> 0.1"
+end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: rack-instrumentation
+version: !ruby/object:Gem::Version
+  version: 0.1.0.pre
+platform: ruby
+authors:
+- Josh Lauer
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-11-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: opentracing
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: 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: 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'
+description: OpenTracing instrumentation for rack
+email:
+- me@joshlauer.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rack/instrumentation.rb
+- lib/rack/instrumentation/tracer.rb
+- lib/rack/instrumentation/version.rb
+- rack-instrumentation-ruby.gemspec
+homepage: https://github.com/josh-lauer/rack-instrumentation-ruby
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/josh-lauer/rack-instrumentation-ruby
+  source_code_uri: https://github.com/josh-lauer/rack-instrumentation-ruby
+  changelog_uri: https://github.com/josh-lauer/rack-instrumentation-ruby/master/CHANGELOG
+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: OpenTracing instrumentation for rack
+test_files: []