signalfx-rails-instrumentation 0.1.0 → 0.2.0

data/lib/rails/instrumentation/subscribers/action_view_subscriber.rb

@@ -0,0 +1,48 @@
+module Rails
+  module Instrumentation
+    module ActionViewSubscriber
+      include Subscriber
+
+      EVENT_NAMESPACE = 'action_view'.freeze
+
+      EVENTS = %w[
+        render_template
+        render_partial
+        render_collection
+      ].freeze
+
+      # rubocop:disable Style/MutableConstant
+      BASE_TAGS = { 'component' => 'ActionView' }
+      # rubocop:enable Style/MutableConstant.
+
+      class << self
+        def render_template(event)
+          tags = span_tags(
+            'template.identifier' => event.payload[:identifier],
+            'template.layout' => event.payload[:layout]
+          )
+
+          Utils.trace_notification(event: event, tags: tags)
+        end
+
+        def render_partial(event)
+          tags = span_tags(
+            'partial.identifier' => event.payload[:identifier]
+          )
+
+          Utils.trace_notification(event: event, tags: tags)
+        end
+
+        def render_collection(event)
+          tags = span_tags(
+            'template.identifier' => event.payload[:identifier],
+            'template.count' => event.payload[:count]
+          )
+          tags['template.cache_hits'] = event.payload[:cache_hits] if event.payload.key? :cache_hits
+
+          Utils.trace_notification(event: event, tags: tags)
+        end
+      end
+    end
+  end
+end

data/lib/rails/instrumentation/subscribers/active_job_subscriber.rb

@@ -0,0 +1,58 @@
+module Rails
+  module Instrumentation
+    module ActiveJobSubscriber
+      include Subscriber
+
+      EVENT_NAMESPACE = 'active_job'.freeze
+
+      EVENTS = %w[
+        enqueue_at
+        enqueue
+        perform_start
+        perform
+      ].freeze
+
+      # rubocop:disable Style/MutableConstant
+      BASE_TAGS = { 'component' => 'ActiveJob' }
+      # rubocop:enable Style/MutableConstant.
+
+      class << self
+        def enqueue_at(event)
+          tags = span_tags(
+            'adapter' => event.payload[:adapter],
+            'job' => event.payload[:job]
+          )
+
+          Utils.trace_notification(event: event, tags: tags)
+        end
+
+        def enqueue(event)
+          tags = span_tags(
+            'adapter' => event.payload[:adapter],
+            'job' => event.payload[:job]
+          )
+
+          Utils.trace_notification(event: event, tags: tags)
+        end
+
+        def perform_start(event)
+          tags = span_tags(
+            'adapter' => event.payload[:adapter],
+            'job' => event.payload[:job]
+          )
+
+          Utils.trace_notification(event: event, tags: tags)
+        end
+
+        def perform(event)
+          tags = span_tags(
+            'adapter' => event.payload[:adapter],
+            'job' => event.payload[:job]
+          )
+
+          Utils.trace_notification(event: event, tags: tags)
+        end
+      end
+    end
+  end
+end

data/lib/rails/instrumentation/subscribers/active_record_subscriber.rb

@@ -0,0 +1,45 @@
+# require 'active_support'
+
+module Rails
+  module Instrumentation
+    module ActiveRecordSubscriber
+      include Subscriber
+
+      EVENT_NAMESPACE = 'active_record'.freeze
+
+      EVENTS = %w[
+        sql
+        instantiation
+      ].freeze
+
+      # rubocop:disable Style/MutableConstant
+      BASE_TAGS = { 'component' => 'ActiveRecord' }
+      # rubocop:enable Style/MutableConstant.
+
+      class << self
+        def sql(event)
+          raw = event.payload[:sql]
+          statement = raw.respond_to?(:to_str) ? raw : raw.to_s
+          tags = span_tags(
+            'db.statement' => statement[0, 1024],
+            'name' => event.payload[:name],
+            'connection_id' => event.payload[:connection_id],
+            'binds' => event.payload[:binds],
+            'cached' => event.payload[:cached]
+          )
+
+          Utils.trace_notification(event: event, tags: tags)
+        end
+
+        def instantiation(event)
+          tags = span_tags(
+            'record.count' => event.payload[:record_count],
+            'record.class' => event.payload[:class_name]
+          )
+
+          Utils.trace_notification(event: event, tags: tags)
+        end
+      end
+    end
+  end
+end

data/lib/rails/instrumentation/subscribers/active_storage_subscriber.rb

@@ -0,0 +1,91 @@
+module Rails
+  module Instrumentation
+    module ActiveStorageSubscriber
+      include Subscriber
+
+      EVENT_NAMESPACE = 'active_storage'.freeze
+
+      EVENTS = %w[
+        service_upload
+        service_streaming_download
+        service_download
+        service_delete
+        service_delete_prefixed
+        service_exist
+        service_url
+      ].freeze
+
+      # rubocop:disable Style/MutableConstant
+      BASE_TAGS = { 'component' => 'ActiveStorage' }
+      # rubocop:enable Style/MutableConstant.
+
+      class << self
+        def service_upload(event)
+          tags = span_tags(
+            'key' => event.payload[:key],
+            'service' => event.payload[:service],
+            'checksum' => event.payload[:checksum]
+          )
+
+          Utils.trace_notification(event: event, tags: tags)
+        end
+
+        def service_streaming_download(event)
+          tags = span_tags(
+            'key' => event.payload[:key],
+            'service' => event.payload[:service]
+          )
+
+          Utils.trace_notification(event: event, tags: tags)
+        end
+
+        def service_download(event)
+          tags = span_tags(
+            'key' => event.payload[:key],
+            'service' => event.payload[:service]
+          )
+
+          Utils.trace_notification(event: event, tags: tags)
+        end
+
+        def service_delete(event)
+          tags = span_tags(
+            'key' => event.payload[:key],
+            'service' => event.payload[:service]
+          )
+
+          Utils.trace_notification(event: event, tags: tags)
+        end
+
+        def service_delete_prefixed(event)
+          tags = span_tags(
+            'key.prefix' => event.payload[:prefix],
+            'service' => event.payload[:service]
+          )
+
+          Utils.trace_notification(event: event, tags: tags)
+        end
+
+        def service_exist(event)
+          tags = span_tags(
+            'key' => event.payload[:key],
+            'service' => event.payload[:service],
+            'exist' => event.payload[:exist]
+          )
+
+          Utils.trace_notification(event: event, tags: tags)
+        end
+
+        def service_url(event)
+          tags = span_tags(
+            'key' => event.payload[:key],
+            'service' => event.payload[:service],
+            'url' => event.payload[:url] # generated url, not accessed url
+          )
+
+          Utils.trace_notification(event: event, tags: tags)
+        end
+      end
+    end
+  end
+end

data/lib/rails/instrumentation/subscribers/active_support_subscriber.rb

@@ -0,0 +1,74 @@
+module Rails
+  module Instrumentation
+    module ActiveSupportSubscriber
+      include Subscriber
+
+      EVENT_NAMESPACE = 'active_support'.freeze
+
+      EVENTS = %w[
+        cache_read
+        cache_generate
+        cache_fetch_hit
+        cache_write
+        cache_delete
+        cache_exist?
+      ].freeze
+
+      # rubocop:disable Style/MutableConstant
+      BASE_TAGS = { 'component' => 'ActiveSupport' }
+      # rubocop:enable Style/MutableConstant.
+
+      class << self
+        def cache_read(event)
+          tags = span_tags(
+            'key' => event.payload[:key],
+            'hit' => event.payload[:hit],
+            'super_operation' => event.payload[:super_operation]
+          )
+
+          Utils.trace_notification(event: event, tags: tags)
+        end
+
+        def cache_generate(event)
+          tags = span_tags(
+            'key' => event.payload[:key]
+          )
+
+          Utils.trace_notification(event: event, tags: tags)
+        end
+
+        def cache_fetch_hit(event)
+          tags = span_tags(
+            'key' => event.payload[:key]
+          )
+
+          Utils.trace_notification(event: event, tags: tags)
+        end
+
+        def cache_write(event)
+          tags = span_tags(
+            'key' => event.payload[:key]
+          )
+
+          Utils.trace_notification(event: event, tags: tags)
+        end
+
+        def cache_delete(event)
+          tags = span_tags(
+            'key' => event.payload[:key]
+          )
+
+          Utils.trace_notification(event: event, tags: tags)
+        end
+
+        def cache_exist?(event)
+          tags = span_tags(
+            'key' => event.payload[:key]
+          )
+
+          Utils.trace_notification(event: event, tags: tags)
+        end
+      end
+    end
+  end
+end

data/lib/rails/instrumentation/utils.rb

@@ -0,0 +1,44 @@
+require 'active_support/notifications'
+
+module Rails
+  module Instrumentation
+    module Utils
+      class << self
+        # calls a handler function with name 'event' on the handler module.
+        # For example, if the handler module is ActionViewSubscriber and the
+        # event hook is 'render_template.action_controller', full_name is
+        # 'render_template.action_controller' and event_name is 'render_template'
+        def register_subscriber(full_name: '', event_name: '', handler_module: nil)
+          ::ActiveSupport::Notifications.subscribe(full_name) do |*args|
+            event = ::ActiveSupport::Notifications::Event.new(*args)
+            handler_module.send(event_name, event)
+          end
+        end
+
+        # takes and event and some set of tags from a handler, and creates a
+        # span with the event's name and the start and finish times.
+        def trace_notification(event:, tags: [])
+          tags = ::Rails::Instrumentation::TAGS.clone.merge(tags)
+
+          span = ::Rails::Instrumentation.tracer.start_span(event.name,
+                                                            tags: tags,
+                                                            start_time: event.time)
+
+          # tag transaction_id
+          span.set_tag('transaction.id', event.transaction_id)
+          tag_error(span, event.payload) if event.payload.key? :exception_object
+
+          span.finish(end_time: event.end)
+        end
+
+        # according to the ActiveSupport::Notifications documentation, exceptions
+        # will be indicated with the presence of the :exception and :exception_object
+        # keys. These will be tagged and logged according to the OpenTracing
+        # specification.
+        def tag_error(span, payload)
+          span.record_exception(payload[:exception_object])
+        end
+      end
+    end
+  end
+end

data/lib/rails/instrumentation/version.rb

@@ -0,0 +1,5 @@
+module Rails
+  module Instrumentation
+    VERSION = '0.2.0'.freeze
+  end
+end

data/rails-instrumentation.gemspec

@@ -0,0 +1,32 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rails/instrumentation/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'signalfx-rails-instrumentation'
+  spec.version       = Rails::Instrumentation::VERSION
+  spec.authors       = ['Ashwin Chandrasekar']
+  spec.email         = ['achandrasekar@signalfx.com']
+
+  spec.summary       = 'OpenTracing instrumentation for Rails.'
+  spec.homepage      = 'https://github.com/signalfx/ruby-rails-instrumentation'
+
+  # 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(__dir__)) 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.3'
+  spec.add_development_dependency 'appraisal', '~> 2.2'
+  spec.add_development_dependency 'bundler', '>= 1.17'
+  spec.add_development_dependency 'signalfx_test_tracer', '>= 0.1.2'
+  spec.add_development_dependency 'rails', '~> 5.2.2'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.63.0'
+  spec.add_development_dependency 'rubocop-rspec', '~> 1.31'
+end

metadata

@@ -1,195 +1,85 @@
 --- !ruby/object:Gem::Specification
 name: signalfx-rails-instrumentation
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
-- iaintshine
-autorequire: 
+- Ashwin Chandrasekar
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2018-12-14 00:00:00.000000000 Z
+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.3.1
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">"
-      - !ruby/object:Gem::Version
-        version: 0.3.1
-- !ruby/object:Gem::Dependency
-  name: rack-tracer
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">"
-      - !ruby/object:Gem::Version
-        version: 0.3.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">"
-      - !ruby/object:Gem::Version
-        version: 0.3.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: puma
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.7'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
-- !ruby/object:Gem::Dependency
-  name: rspec-rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.6'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.6'
-- !ruby/object:Gem::Dependency
-  name: database_cleaner
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.6'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.6'
-- !ruby/object:Gem::Dependency
-  name: dalli
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.7.6
-  type: :development
+        version: '0.3'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.7.6
+        version: '0.3'
 - !ruby/object:Gem::Dependency
-  name: tracing-logger
+  name: appraisal
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
-  name: test-tracer
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.1
+        version: '1.17'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.1
+        version: '1.17'
 - !ruby/object:Gem::Dependency
-  name: tracing-matchers
+  name: signalfx_test_tracer
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: 0.1.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: 0.1.2
 - !ruby/object:Gem::Dependency
-  name: spanmanager
+  name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 5.2.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.0
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.15'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.15'
+        version: 5.2.2
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -219,95 +109,68 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
-  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: simplecov-console
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.63.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.63.0
 - !ruby/object:Gem::Dependency
-  name: appraisal
+  name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.31'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-description: ''
+        version: '1.31'
+description:
 email:
-- bodziomista@gmail.com
+- achandrasekar@signalfx.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
-- ".rspec"
-- ".ruby-version"
-- ".travis.yml"
+- ".rubocop.yml"
 - Appraisals
-- CHANGELOG.md
 - Gemfile
+- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
-- docker-compose.yml
-- gemfiles/.bundle/config
-- gemfiles/rails_32.gemfile
-- gemfiles/rails_4.gemfile
-- gemfiles/rails_40.gemfile
-- gemfiles/rails_41.gemfile
-- gemfiles/rails_42.gemfile
-- gemfiles/rails_5.gemfile
-- gemfiles/rails_50.gemfile
-- gemfiles/rails_51.gemfile
-- lib/rails-tracer.rb
-- lib/rails/action_controller/tracer.rb
-- lib/rails/action_view/tracer.rb
-- lib/rails/active_record/tracer.rb
-- lib/rails/active_support/cache/core_ext.rb
-- lib/rails/active_support/cache/dalli_tracer.rb
-- lib/rails/active_support/cache/manual_tracer.rb
-- lib/rails/active_support/cache/subscriber.rb
-- lib/rails/active_support/cache/tracer.rb
-- lib/rails/defer_notifications.rb
-- lib/rails/rack/tracer.rb
-- lib/rails/span_helpers.rb
-- lib/rails/tracer.rb
-- rails-tracer.gemspec
-homepage: https://github.com/signalfx/ruby-rails-tracer
-licenses:
-- Apache-2.0
+- lib/rails/instrumentation.rb
+- lib/rails/instrumentation/patch.rb
+- lib/rails/instrumentation/subscriber.rb
+- lib/rails/instrumentation/subscribers/action_cable_subscriber.rb
+- lib/rails/instrumentation/subscribers/action_controller_subscriber.rb
+- lib/rails/instrumentation/subscribers/action_mailer_subscriber.rb
+- lib/rails/instrumentation/subscribers/action_view_subscriber.rb
+- lib/rails/instrumentation/subscribers/active_job_subscriber.rb
+- lib/rails/instrumentation/subscribers/active_record_subscriber.rb
+- lib/rails/instrumentation/subscribers/active_storage_subscriber.rb
+- lib/rails/instrumentation/subscribers/active_support_subscriber.rb
+- lib/rails/instrumentation/utils.rb
+- lib/rails/instrumentation/version.rb
+- rails-instrumentation.gemspec
+homepage: https://github.com/signalfx/ruby-rails-instrumentation
+licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -315,16 +178,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.2.0
+      version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
-summary: Fork of ruby-rails-tracer. Rack OpenTracing middleware enhanced for Rails
+summary: OpenTracing instrumentation for Rails.
 test_files: []