rails_opentracer 0.1.20 → 0.1.38

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 90b20289f4fcdc5e0c033ee1101814ed215c76d0
-  data.tar.gz: a5b2d37497b67c1fbca82a7621fd7e410f62d74d
+  metadata.gz: a9cacc7a29a63d008cefb04bae669fe266a4f65a
+  data.tar.gz: 431dda27e92b753aee879fcc9aebca5c83e1b8d3
 SHA512:
-  metadata.gz: 9c6035e3c289fe9ed57ffaf660f199f5a06e94728b1899b82b6d83b053a07c0f67dadbfaa6d1aca91591258ecadfdaddc47933a5c47b9330851d5336f05d39e5
-  data.tar.gz: c1de8a6d083d0c9a4d059203211b6c63b32a6a49f2391858db255997f33557c62976439e2a2000cdb0edd3de60cbe7220e3d4df74685c37f5cce92d9337602e0
+  metadata.gz: a4915681e41a6ce227dec39fd686bdcdd06941f3a51f720b65ad93e22a3b3974236969ecf428ddf1e7b79a6cd6f0da3c912f6b333d35030bfdcb06e417f26f64
+  data.tar.gz: 513f453c113d70cca0adb7e0224b6e67ee3328f808f9e8b7835688292cdec517ae1c57a1409b853b21da353ee76d169163ac177a04074ec8177ecfdbcc1393ca

data/README.md

@@ -1,14 +1,12 @@
 # RailsOpentracer
 
-Gem is in active development. If you see this then us devs aren't quite done yet.
-
 This gem instruments an application to be used with a tracing client. At this stage it is configured to be used with Zipkin only, but
-this can be changed at a later stage.
+this can be changed at a later stage. While there are other gems that offer very similar functionality, the idea here was to instrument
+an application with OpenTracing with the absolute minimum amount of instrumentation/configuration.
 
 TODO:
-- Testz
-- Are all those generators "the way" we want to do things?
-- Adding middleware is still done in development.rb for now
+- Investigate performance impact
+- Investigate cause of lone .js spans
 
 ## Installation
 
@@ -22,20 +20,6 @@ And then execute:
 
     $ bundle
 
-Or install it yourself as:
-
-    $ gem install rails_opentracer
-
-Generate files required by gem:
-
-    $ rails g rails_opentracer:install
-
-Add the following to development.rb:
-
-```ruby
-config.middleware.use Tracer
-```
-
 ## Usage
 
 To run Zipkin locally, do:
@@ -44,7 +28,9 @@ To run Zipkin locally, do:
 
 You will need to set an environment variable with the Zipkin client URL. Locally this would be:
 
-`ENV['ZIPKIN_SERVICE_URL']='http://localhost:9411'`.
+`ENV['ZIPKIN_SERVICE_URL']='http://localhost:9411'`, and
+
+`ENV['RAILS_OPENTRACER_ENABLED']='yes'`.
 
 Whenever a request is made to another application, do:
 

data/lib/rails_opentracer.rb

@@ -1,43 +1,44 @@
 require 'rails_opentracer/active_record/rails_opentracer.rb'
+require 'rails_opentracer/zipkin_config'
 require 'rails_opentracer/span_helpers'
+require 'rails_opentracer/middleware'
 require 'rails_opentracer/version'
+require 'opentracing'
 require 'faraday'
+require 'zipkin'
 
 module RailsOpentracer
-  class << self
-    def instrument(tracer: OpenTracing.global_tracer, active_span: nil, active_record: true)
-      ActiveRecord::RailsOpentracer.instrument(tracer: tracer, active_span: active_span) if active_record
-    end
-
-    def disable
-      ActiveRecord::RailsOpentracer.disable
-    end
-  end
-
   def get(url)
     connection = Faraday.new do |con|
       con.use Faraday::Adapter::NetHttp
     end
-    carrier = {}
-    OpenTracing.inject(@span.context, OpenTracing::FORMAT_RACK, carrier)
-    connection.headers = denilize(carrier)
+    if ZipkinConfig.opentracer_enabled_and_zipkin_url_present?
+      carrier = {}
+      OpenTracing.inject(@span.context, OpenTracing::FORMAT_RACK, carrier)
+      connection.headers = denilize(carrier)
+    elsif ZipkinConfig.opentracer_enabled?
+      Rails.logger.error 'TRACER_ERROR: `ZIPKIN_SERVICE_URL` environment variable is not defined'
+    end
     connection.get(url)
   end
 
   def with_span(name)
-    @span =
-      if $active_span.present?
-        OpenTracing.start_span(name, child_of: $active_span)
-      else
-        OpenTracing.start_span(name)
-      end
-    yield if block_given?
-    @span.finish
+    if ZipkinConfig.opentracer_enabled_and_zipkin_url_present? 
+      @span =
+        if $active_span.present?
+          OpenTracing.start_span(name, child_of: $active_span)
+        else
+          OpenTracing.start_span(name)
+        end
+      yield if block_given?
+      @span.finish
+    else
+      yield if block_given?
+    end
   end
 
   private
-
   def denilize(hash)
-    hash.each {|k,v| hash[k] = "" if hash[k].nil?}
+    hash.each { |k, _v| hash[k] = '' if hash[k].nil? }
   end
 end

data/lib/rails_opentracer/active_record/rails_opentracer.rb

@@ -24,7 +24,6 @@ module ActiveRecord
 
       def sql(tracer: OpenTracing.global_tracer, active_span: nil, args:)
         _, start, finish, _, payload = *args
-
         span = start_span(payload.fetch(:name),
                           tracer: tracer,
                           active_span: active_span,

data/lib/rails_opentracer/middleware.rb

@@ -0,0 +1,63 @@
+require 'zipkin'
+require 'rails_opentracer/zipkin_config'
+
+module RailsOpentracer
+  class Railtie < Rails::Railtie
+    initializer 'rails_opentracer.configure_rack_middleware' do
+      Rails.application.middleware.use Middleware
+    end
+    initializer 'rails_opentracer.configure_initializer' do
+      if ZipkinConfig.opentracer_enabled_and_zipkin_url_present?
+        OpenTracing.global_tracer = Zipkin::Tracer.build(url: ZipkinConfig.zipkin_url, service_name: Rails.application.class.parent_name)
+        ActiveRecord::RailsOpentracer.instrument(tracer: OpenTracing.global_tracer, active_span: -> { $active_span })
+      end
+    end
+  end
+
+  class Middleware
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      span = nil
+      if ZipkinConfig.opentracer_enabled_and_zipkin_url_present?
+        begin
+          extracted_ctx = OpenTracing.extract(OpenTracing::FORMAT_RACK, env)
+          span_name = env['REQUEST_PATH']
+          span =
+            if extracted_ctx.nil?
+              OpenTracing.start_span(span_name)
+            else
+              OpenTracing.start_span(span_name, child_of: extracted_ctx)
+            end
+          $active_span = span # yuck
+        rescue StandardError => e
+          Rails.logger.error "TRACER_ERROR: #{error_message(e)}"
+          return @app.call(env)
+        end
+
+        status, headers, response = @app.call(env)
+
+        begin
+          carrier = {}
+          OpenTracing.inject(span.context, OpenTracing::FORMAT_RACK, carrier)
+          span.finish
+          [status, headers , response]
+        rescue StandardError => e
+          Rails.logger.error "TRACER_ERROR: #{error_message(e)}"
+          [status, headers, response]
+        end
+      else
+        if ZipkinConfig.opentracer_enabled? 
+          Rails.logger.error 'TRACER_ERROR: `ZIPKIN_SERVICE_URL` environment variable is not defined'
+        end
+        return @app.call(env)
+      end
+    end
+
+    def error_message(e)
+      "#{e}\n#{e.backtrace[0, 10].join("\n\t")}"
+    end
+  end
+end

data/lib/rails_opentracer/version.rb

@@ -1,3 +1,3 @@
 module RailsOpentracer
-  VERSION = "0.1.20"
+  VERSION = "0.1.38"
 end

data/lib/rails_opentracer/zipkin_config.rb

@@ -0,0 +1,19 @@
+module RailsOpentracer
+  class ZipkinConfig
+    def self.opentracer_enabled?
+     ENV['RAILS_OPENTRACER_ENABLED'] == 'yes' 
+    end
+
+    def self.opentracer_enabled_and_zipkin_url_present?
+      ENV['RAILS_OPENTRACER_ENABLED'] == 'yes' && ENV['ZIPKIN_SERVICE_URL'].present?
+    end
+
+    def self.zipkin_url
+      if Rails.env.test? || Rails.env.development?
+        'http://localhost:9411'
+      else
+        ENV['ZIPKIN_SERVICE_URL']
+      end
+    end 
+  end
+end

data/rails_opentracer.gemspec

@@ -32,8 +32,12 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "faraday", "~> 0.13.1"
   spec.add_dependency "opentracing", "~> 0.3.1"
-  spec.add_dependency "zipkin", "~> 0.4.1"
+  spec.add_dependency "zipkin", "~> 0.4.2"
 
+  spec.add_development_dependency "rails"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency 'combustion', '~> 0.7.0'
   spec.add_development_dependency "bundler", "~> 1.15"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "minitest", "~> 5.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_opentracer
 version: !ruby/object:Gem::Version
-  version: 0.1.20
+  version: 0.1.38
 platform: ruby
 authors:
 - Nicholas Erasmus
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-10-20 00:00:00.000000000 Z
+date: 2017-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -44,14 +44,70 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.1
+        version: 0.4.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.1
+        version: 0.4.2
+- !ruby/object:Gem::Dependency
+  name: rails
+  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: pry
+  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: sqlite3
+  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: combustion
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -110,13 +166,12 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- lib/generators/rails_opentracer/install_generator.rb
-- lib/generators/templates/rails_opentracer_initializer.rb
-- lib/generators/templates/tracer.rb
 - lib/rails_opentracer.rb
 - lib/rails_opentracer/active_record/rails_opentracer.rb
+- lib/rails_opentracer/middleware.rb
 - lib/rails_opentracer/span_helpers.rb
 - lib/rails_opentracer/version.rb
+- lib/rails_opentracer/zipkin_config.rb
 - rails_opentracer.gemspec
 homepage: https://github.com/nuclearnic/rails_opentracer
 licenses:

data/lib/generators/rails_opentracer/install_generator.rb

@@ -1,20 +0,0 @@
-require 'rails/generators'
-
-module RailsOpentracer
-  module Generators
-    class InstallGenerator < Rails::Generators::Base
-      source_root File.expand_path("../../templates", __FILE__)
-      desc "Creates rails_opentracer initializer for your application"
-
-      def copy_initializer
-        template "rails_opentracer_initializer.rb", "config/initializers/rails_opentracer.rb"
-        puts "Initializer rails_opentracer added successfully"
-      end
-
-      def copy_tracer_middleware
-        template "tracer.rb", "app/middleware/tracer.rb"
-        puts "Tracer middleware added successfully"
-      end
-    end
-  end
-end

data/lib/generators/templates/rails_opentracer_initializer.rb

@@ -1,30 +0,0 @@
-require 'opentracing'
-require 'zipkin'
-
-class Zipkin::JsonClient
-  # temporary monkey patch for a HTTPS related issue,
-  # remove this once fix has been made to
-  def emit_batch(spans)
-    return if spans.empty?
-
-    http = Net::HTTP.new(@spans_uri.host, @spans_uri.port)
-    http.use_ssl = true if @spans_uri.scheme == 'https'
-    puts "@spans_uri: #{@spans_uri} request_uri #{@spans_uri.request_uri}"
-    request = Net::HTTP::Post.new(@spans_uri.request_uri, {
-      'Content-Type' => 'application/json'
-    })
-    request.body = JSON.dump(spans)
-    response = http.request(request)
-
-    if response.code != 202
-      STDERR.puts(response.body)
-    end
-  rescue => e
-    STDERR.puts("Error emitting spans batch: #{e.message}\n#{e.backtrace.join("\n")}")
-  end
-end
-
-if ENV.key?('ZIPKIN_SERVICE_URL')
-  OpenTracing.global_tracer = Zipkin::Tracer.build(url: ENV['ZIPKIN_SERVICE_URL'], service_name: Rails.application.class.parent_name)
-  ActiveRecord::RailsOpentracer.instrument(tracer: OpenTracing.global_tracer, active_span: -> { $active_span })
-end

data/lib/generators/templates/tracer.rb

@@ -1,41 +0,0 @@
-require 'zipkin'
-
-class Tracer
-  def initialize(app)
-    @app = app
-  end
-
-  def call(env)
-    span = nil
-    begin
-      extracted_ctx = OpenTracing.extract(OpenTracing::FORMAT_RACK, env)
-      span_name = env['REQUEST_PATH']
-      span =
-        if extracted_ctx.nil?
-          OpenTracing.start_span(span_name)
-        else
-          OpenTracing.start_span(span_name, child_of: extracted_ctx)
-        end
-      $active_span = span # yuck
-    rescue StandardError => e
-      Rails.logger.error "TRACER_ERROR: #{error_message(e)}"
-      return @app.call(env)
-    end
-
-    status, headers, response = @app.call(env)
-
-    begin
-      carrier = {}
-      OpenTracing.inject(span.context, OpenTracing::FORMAT_RACK, carrier)
-      span.finish
-      [status, headers , response]
-    rescue StandardError => e
-      Rails.logger.error "TRACER_ERROR: #{error_message(e)}"
-      [status, headers, response]
-    end
-  end
-
-  def error_message(e)
-    "#{e}\n#{e.backtrace[0, 10].join("\n\t")}"
-  end
-end