signalfx-rails-instrumentation 0.1.4 → 0.2.0

data/.rspec

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

data/.ruby-version

@@ -1 +0,0 @@
-2.4.2

data/.travis.yml

@@ -1,25 +0,0 @@
-sudo: true
-language: ruby
-rvm:
-  - 2.2
-  - 2.3
-  - 2.4
-gemfile:
-  - gemfiles/rails_32.gemfile
-  - gemfiles/rails_40.gemfile
-  - gemfiles/rails_41.gemfile
-  - gemfiles/rails_42.gemfile
-  - gemfiles/rails_50.gemfile
-  - gemfiles/rails_51.gemfile
-matrix:
-  exclude:
-    - rvm: 2.4
-      gemfile: gemfiles/rails_32.gemfile
-    - rvm: 2.4
-      gemfile: gemfiles/rails_40.gemfile
-    - rvm: 2.4
-      gemfile: gemfiles/rails_41.gemfile
-before_install: 
-  - gem install bundler -v 1.15.3
-services:
-  - memcached

data/CHANGELOG.md

@@ -1,47 +0,0 @@
-## v0.5.0
-
-* Expose global Rails::Tracer which instruments all sub-modules [#26](https://github.com/iaintshine/ruby-rails-tracer/pull/26)
-* Allow to disable sub-tracers [#25](https://github.com/iaintshine/ruby-rails-tracer/pull/25)
-* Support Evented and Timed subscribers in cache instrumentation [#24](https://github.com/iaintshine/ruby-rails-tracer/pull/24)
-* Test and add support for multiple Rails versions - 3.2+ [#23](https://github.com/iaintshine/ruby-rails-tracer/pull/23)
-* Development instructions update [#27](https://github.com/iaintshine/ruby-rails-tracer/pull/27)
-
-## v0.4.3
-
-* Handle instrumentation exceptions and mark spans as failed [#21](https://github.com/iaintshine/ruby-rails-tracer/pull/21)
-
-## v0.4.2
-
-* Test the gem with multiple Ruby versions 2.2+ [#20](https://github.com/iaintshine/ruby-rails-tracer/pull/20)
-* Set explicit Ruby version requirement in gemspec.
-
-## v0.4.1
-
-* Use tracing matchers in tests [#19](https://github.com/iaintshine/ruby-rails-tracer/pull/19)
-
-## v0.4.0
-
-* Start maintaining CHANGELOG.md [#18](https://github.com/iaintshine/ruby-rails-tracer/pull/18)
-* Auto enable tracing-logger when Dalli is auto-instrumented [#17](https://github.com/iaintshine/ruby-rails-tracer/pull/17)
-* Introduce Dalli and ActiveSupport::Cache::DalliStore auto-instrumentation [#9](https://github.com/iaintshine/ruby-rails-tracer/pull/9)
-* Introduce docker-compose with all required external dependencies. 
-
-## v0.3.0
-
-* Introduce ActiveSupport::Cache auto-instrumentation [#4](https://github.com/iaintshine/ruby-rails-tracer/pull/4)
-* Add ActiveRecord::Tracer tests for active span propagation
-
-## v0.2.0
-
-* Introduce ActiveRecord auto-instrumentation [#3](https://github.com/iaintshine/ruby-rails-tracer/pull/3)
-* Add Rails test application to be used in specs
-
-## v0.1.1
-
-* Replace RecordingTracer with Test::Tracer [#6](https://github.com/iaintshine/ruby-rails-tracer/pull/6)
-* README typo fix [#2](https://github.com/iaintshine/ruby-rails-tracer/pull/2) 
-
-## v0.1.0
-
-* Initial release
-* Introduced a rack middleware, to generate more informative operation names based on information supplied by ActionDispatch. [#1](https://github.com/iaintshine/ruby-rails-tracer/pull/1)

data/docker-compose.yml

@@ -1,4 +0,0 @@
-memcached:
-  image: memcached
-  ports:
-    - 11211:11211

data/gemfiles/.bundle/config

@@ -1,2 +0,0 @@
----
-BUNDLE_RETRY: "1"

data/gemfiles/rails_32.gemfile

@@ -1,11 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "pry"
-gem "pry-stack_explorer"
-gem "pry-byebug"
-gem "rails", "~> 3.2.0"
-gem "test-unit", "~> 3.0"
-
-gemspec path: "../"

data/gemfiles/rails_4.gemfile

@@ -1,10 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "pry"
-gem "pry-stack_explorer"
-gem "pry-byebug"
-gem "rails", "~> 5.1.3"
-
-gemspec path: "../"

data/gemfiles/rails_40.gemfile

@@ -1,10 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "pry"
-gem "pry-stack_explorer"
-gem "pry-byebug"
-gem "rails", "~> 4.0.0"
-
-gemspec path: "../"

data/gemfiles/rails_41.gemfile

@@ -1,10 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "pry"
-gem "pry-stack_explorer"
-gem "pry-byebug"
-gem "rails", "~> 4.1.0"
-
-gemspec path: "../"

data/gemfiles/rails_42.gemfile

@@ -1,10 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "pry"
-gem "pry-stack_explorer"
-gem "pry-byebug"
-gem "rails", "~> 4.2.0"
-
-gemspec path: "../"

data/gemfiles/rails_5.gemfile

@@ -1,10 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "pry"
-gem "pry-stack_explorer"
-gem "pry-byebug"
-gem "rails", "~> 5.1.3"
-
-gemspec path: "../"

data/gemfiles/rails_50.gemfile

@@ -1,10 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "pry"
-gem "pry-stack_explorer"
-gem "pry-byebug"
-gem "rails", "~> 5.0.0"
-
-gemspec path: "../"

data/gemfiles/rails_51.gemfile

@@ -1,10 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "pry"
-gem "pry-stack_explorer"
-gem "pry-byebug"
-gem "rails", "~> 5.1.0"
-
-gemspec path: "../"

data/lib/rails-tracer.rb

@@ -1 +0,0 @@
-require 'rails/tracer'

data/lib/rails/action_controller/tracer.rb

@@ -1,100 +0,0 @@
-
-module ActionController
-  module Tracer
-    COMPONENT = "ActionController".freeze
-
-    class << self
-      def instrument(tracer: OpenTracing.global_tracer, active_span: nil)
-        @subscribers = []
-        @subscribers << ::ActiveSupport::Notifications.subscribe('start_processing.action_controller') do |*args|
-          ActionController::Tracer.start_processing(tracer: tracer, active_span: active_span, args: args)
-        end
-        @subscribers << ::ActiveSupport::Notifications.subscribe('process_action.action_controller') do |*args|
-          ActionController::Tracer.process_action(tracer: tracer, active_span: active_span, args: args)
-        end
-      end
-
-      def disable
-        @subscribers.each do |subscriber|
-          ::ActiveSupport::Notifications.unsubscribe(subscriber)
-        end
-        @subscribers.clear
-        self
-      end
-
-      def start_processing(tracer: OpenTracing.global_tracer, active_span: nil, args: {})
-        event, start, finish, id, payload = *args
-
-        # extract the rack context, if it exists
-        # it seems like this might be the earliest place env is available
-        rack_span = Rails::Tracer::SpanHelpers.rack_span(payload)
-        Rails::Tracer::Defer.add_parent(id, rack_span)
-
-        path = payload.fetch(:path, 'unknown')
-        name = "#{payload.fetch(:controller, 'unknown')}##{payload.fetch(:action, 'unknown')} #{event} #{path}"
-        tags = {
-          'component' => COMPONENT,
-          'span.kind' => 'client',
-          'http.method' => payload.fetch(:method, 'unknown'),
-          'http.path' => path,
-        }
-
-        if !Rails::Tracer::Defer.enabled
-          span = tracer.start_span(name,
-                                   child_of: active_span.respond_to?(:call) ? active_span.call : active_span,
-                                   start_time: start,
-                                   tags: tags)
-
-          span.finish(end_time: finish) if span
-        else
-          spaninfo = {
-            'event' => event,
-            'name' => name,
-            'start' => start,
-            'finish' => finish,
-            'tags' => tags,
-          }
-
-          Rails::Tracer::Defer.defer_span(id: id, spaninfo: spaninfo)
-        end
-      end
-
-      def process_action(tracer: OpenTracing.global_tracer, active_span: nil, args: {})
-        event, start, finish, id, payload = *args
-
-        path = payload.fetch(:path, 'unknown')
-        name = "#{payload.fetch(:controller, 'unknown')}##{payload.fetch(:action, 'unknown')} #{path}"
-        tags = {
-          'component' => COMPONENT,
-          'span.kind' => 'client',
-          'http.method' => payload.fetch(:method, 'unknown'),
-          'http.status_code' => payload.fetch(:status, 'unknown'),
-          'http.path' => path,
-          'view.runtime' => payload.fetch(:view_runtime, 'unknown'),
-          'db.runtime' => payload.fetch(:db_runtime, 'unknown'),
-        }
-
-        if !Rails::Tracer::Defer.enabled
-          # write out the span
-          span = tracer.start_span(name,
-                                   child_of: active_span.respond_to?(:call) ? active_span.call : active_span,
-                                   start_time: start,
-                                   tags: tags)
-
-          span.finish(end_time: finish) if span
-        else
-          # defer the spans if full_trace is configured
-          spaninfo = {
-            'event' => event,
-            'name' => name,
-            'start' => start,
-            'finish' => finish,
-            'tags' => tags,
-          }
-
-          Rails::Tracer::Defer.defer_span(id: id, spaninfo: spaninfo)
-        end
-      end
-    end
-  end
-end

data/lib/rails/action_view/tracer.rb

@@ -1,105 +0,0 @@
-
-module ActionView
-  module Tracer
-    COMPONENT = "ActionView".freeze
-
-    class << self
-      def instrument(tracer: OpenTracing.global_tracer, active_span: nil)
-        @subscribers = []
-        @subscribers << ::ActiveSupport::Notifications.subscribe('render_template.action_view') do |*args|
-          ActionView::Tracer.render_template(tracer: tracer, active_span: active_span, args: args)
-        end
-        @subscribers << ::ActiveSupport::Notifications.subscribe('render_partial.action_view') do |*args|
-          ActionView::Tracer.render_partial(tracer: tracer, active_span: active_span, args: args)
-        end
-        @subscribers << ::ActiveSupport::Notifications.subscribe('render_collection.action_view') do |*args|
-          ActionView::Tracer.render_collection(tracer: tracer, active_span: active_span, args: args)
-        end
-      end
-
-      def disable
-        @subscribers.each do |subscriber|
-          ::ActiveSupport::Notifications.unsubscribe(subscriber)
-        end
-        @subscribers = []
-        self
-      end
-
-      def render_template(tracer: OpenTracing.global_tracer, active_span: nil, args: {})
-        event, start, finish, id, payload = *args
-
-        tags = {
-          'component' => COMPONENT,
-          'span.kind' => 'client',
-          'template_path' => payload.fetch(:identifier, 'unknown'),
-          'layout' => payload.fetch(:layout, 'unknown'),
-        }
-
-        handle_notification(tracer: tracer,
-                            active_span: active_span,
-                            id: id,
-                            name: event,
-                            tags: tags,
-                            start: start,
-                            finish: finish)
-      end
-
-      def render_partial(tracer: OpenTracing.global_tracer, active_span: nil, args: {})
-        event, start, finish, id, payload = *args
-
-        tags = {
-          'component' => COMPONENT,
-          'span.kind' => 'client',
-          'template_path' => payload.fetch(:identifier, 'unknown'),
-        }
-
-        handle_notification(tracer: tracer,
-                            active_span: active_span,
-                            id: id,
-                            name: event,
-                            tags: tags,
-                            start: start,
-                            finish: finish)
-      end
-
-      def render_collection(tracer: OpenTracing.global_tracer, active_span: nil, args: {})
-        event, start, finish, id, payload = *args
-
-        tags = {
-          'component' => COMPONENT,
-          'span.kind' => 'client',
-          'template_path' => payload.fetch(:identifier, 'unknown'),
-          'collection_size' => payload.fetch(:count, 'unknown'),
-        }
-
-        handle_notification(tracer: tracer,
-                            active_span: active_span,
-                            id: id,
-                            name: event,
-                            tags: tags,
-                            start: start,
-                            finish: finish)
-      end
-
-      def handle_notification(tracer:, active_span:, id:, name:, tags:, start:, finish:)
-        if !Rails::Tracer::Defer.enabled
-          span = tracer.start_span(name,
-                                   child_of: active_span.respond_to?(:call) ? active_span.call : active_span,
-                                   start_time: start,
-                                   tags: tags)
-
-          span.finish(end_time: finish) if span
-        else
-          spaninfo = {
-            'event' => name,
-            'name' => name,
-            'start' => start,
-            'finish' => finish,
-            'tags' => tags,
-          }
-          Rails::Tracer::Defer.defer_span(id: id, spaninfo: spaninfo)
-        end
-      end
-    end
-  end
-end

data/lib/rails/active_record/tracer.rb

@@ -1,89 +0,0 @@
-module ActiveRecord
-  module Tracer
-    DEFAULT_OPERATION_NAME = "sql.query".freeze
-
-    class << self
-      def instrument(tracer: OpenTracing.global_tracer, active_span: nil)
-        clear_subscribers
-        @subscriber = ::ActiveSupport::Notifications.subscribe('sql.active_record') do |*args|
-          ActiveRecord::Tracer.sql(tracer: tracer, active_span: active_span, args: args)
-        end
-
-        self
-      end
-
-      def disable
-        if @subscriber
-          ActiveSupport::Notifications.unsubscribe(@subscriber)
-          @subscriber = nil
-        end
-
-        self
-      end
-      alias :clear_subscribers :disable
-
-      def sql(tracer: OpenTracing.global_tracer, active_span: nil, args:)
-        event, start, finish, id, payload = *args
-
-        connection_config = ::ActiveRecord::Base.connection_config
-        name = payload.fetch(:name, 'unknown')
-        tags = {
-          'component' => 'ActiveRecord',
-          'span.kind' => 'client',
-          'db.user' => connection_config.fetch(:username, 'unknown'),
-          'db.instance' => connection_config.fetch(:database, 'unknown'),
-          'db.vendor' => connection_config.fetch(:adapter, 'unknown'),
-          'db.connection_id' => payload.fetch(:connection_id, 'unknown'),
-          'db.cached' => payload.fetch(:cached, false),
-          'db.statement' => payload.fetch(:sql, 'unknown'),
-          'db.type' => 'sql'
-        }
-
-        if !Rails::Tracer::Defer.enabled
-          span = tracer.start_span(name || DEFAULT_OPERATION_NAME,
-                                   child_of: active_span.respond_to?(:call) ? active_span.call : active_span,
-                                   start_time: start,
-                                   tags: tags)
-
-          if payload[:exception]
-            Rails::Tracer::SpanHelpers.set_error(span, payload[:exception_object] || payload[:exception])
-          end
-
-          span.finish(end_time: finish) if span
-        else
-          spaninfo = {
-            'event' => event,
-            'name' => name || DEFAULT_OPERATION_NAME,
-            'start' => start,
-            'finish' => finish,
-            'tags' => tags,
-          }
-
-          # errors aren't being propagated yet this way...
-
-          Rails::Tracer::Defer.defer_span(id: id, spaninfo: spaninfo)
-        end
-      end
-
-      def start_span(operation_name, tracer: OpenTracing.global_tracer, active_span: nil, start_time: Time.now, **fields)
-        connection_config = ::ActiveRecord::Base.connection_config
-
-        span = tracer.start_span(operation_name || DEFAULT_OPERATION_NAME,
-                                 child_of: active_span.respond_to?(:call) ? active_span.call : active_span,
-                                 start_time: start_time,
-                                 tags: {
-                                  'component' => 'ActiveRecord',
-                                  'span.kind' => 'client',
-                                  'db.user' => connection_config.fetch(:username, 'unknown'),
-                                  'db.instance' => connection_config.fetch(:database, 'unknown'),
-                                  'db.vendor' => connection_config.fetch(:adapter, 'unknown'),
-                                  'db.connection_id' => fields.fetch(:connection_id, 'unknown'),
-                                  'db.cached' => fields.fetch(:cached, false),
-                                  'db.statement' => fields.fetch(:sql, 'unknown'),
-                                  'db.type' => 'sql'
-                                 })
-        span
-      end
-    end
-  end
-end