rails-instrumentation 0.1.0 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f16a0197a70766717864896e3d9124ac48883ecf01d6e3c748a3ac0ebe7d0cb7
-  data.tar.gz: 9ca9ebbc6a9250bdffe7b3d5007720c2b7f5c1d21e52f2f40435d83963c50257
+  metadata.gz: 7c7a110fc7c8a823c81d77c1895829f9d9f55a162b68f87cc745647e0f0213c4
+  data.tar.gz: 902e1fed1464ef3cab7f912488e52076813ad26d0a60ebd9e3f0a24394d6e6cb
 SHA512:
-  metadata.gz: 21a28e7f1141283809344b4ea7fccc32bf04ecd0a8a44e8c58d153346278c1f8e17db608636616bbd88baef54a2c1454bb26f63d7b58ea11331ed81f8701ae8c
-  data.tar.gz: e5183229a9d28d1577d3a33833adb400d9e21aeeebba0d7777b2a32a5ca01f0ae427e2cffff39e95e835a84335672644ae58d6e7590c400ed1c550d072643722
+  metadata.gz: 4618da4d9e430cb32683f55ad7668bb6626f2b4ed60fc58af81b08441e77f8a2ab01275fd1cf07b5e903dafbd3c754a1ff26e471c20f3f1aa3f54b1751bbb402
+  data.tar.gz: 6d99576f07843c873d5fd18ece9d194757870429a0477fe8b23e90f8689dd1839a43f774b6b765a3cc009616b13dbeebd85e1ea8e76438335b2971b511a71a2e

data/.gitignore

@@ -1,6 +1,7 @@
 /.bundle/
 /.yardoc
 /_yardoc/
+/vendor/
 /coverage/
 /doc/
 /pkg/

data/Appraisals

@@ -17,3 +17,11 @@ end
 appraise 'rails-4.2' do
   gem 'rails', '~> 4.2.0'
 end
+
+appraise 'rails-4.1' do
+  gem 'rails', '~> 4.1.0'
+end
+
+appraise 'rails-3.2' do
+  gem 'rails', '~> 3.2.0'
+end

data/lib/rails/instrumentation/patch.rb

@@ -6,10 +6,9 @@ module Rails
           alias_method :process_action_original, :process_action
 
           def process_action(method_name, *args)
-            # this naming scheme 'method.class' is how we ensure that the notification in the
+            # this naming scheme 'class.method' is how we ensure that the notification in the
             # subscriber is the same one
-            name = "#{method_name}.#{self.class.name}"
-            puts ::Rails::Instrumentation.tracer
+            name = "#{self.class.name}.#{method_name}"
             scope = ::Rails::Instrumentation.tracer.start_active_span(name)
 
             # skip adding tags here. Getting the complete set of information is
@@ -30,7 +29,6 @@ module Rails
       end
 
       def self.restore_process_action(klass: ::ActionController::Instrumentation)
-        puts klass.respond_to? :process_action_original, true
         klass.class_eval do
           remove_method :process_action
           alias_method :process_action, :process_action_original

data/lib/rails/instrumentation/subscriber.rb

@@ -35,6 +35,10 @@ module Rails
             end
           end
         end
+
+        def span_tags(tags)
+          self::BASE_TAGS.clone.merge(tags)
+        end
       end
     end
   end

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

@@ -13,49 +13,53 @@ module Rails
         broadcast
       ].freeze
 
+      # rubocop:disable Style/MutableConstant
+      BASE_TAGS = { 'component' => 'ActionCable' }
+      # rubocop:enable Style/MutableConstant.
+
       class << self
         def perform_action(event)
-          tags = {
+          tags = span_tags(
             'channel_class' => event.payload[:channel_class],
             'action' => event.payload[:action],
             'data' => event.payload[:data]
-          }
+          )
 
           Utils.trace_notification(event: event, tags: tags)
         end
 
         def transmit(event)
-          tags = {
+          tags = span_tags(
             'channel_class' => event.payload[:channel_class],
             'data' => event.payload[:data],
             'via' => event.payload[:via]
-          }
+          )
 
           Utils.trace_notification(event: event, tags: tags)
         end
 
         def transmit_subscription_confirmation(event)
-          tags = {
+          tags = span_tags(
             'channel_class' => event.payload[:channel_class]
-          }
+          )
 
           Utils.trace_notification(event: event, tags: tags)
         end
 
         def transmit_subscription_rejection(event)
-          tags = {
+          tags = span_tags(
             'channel_class' => event.payload[:channel_class]
-          }
+          )
 
           Utils.trace_notification(event: event, tags: tags)
         end
 
         def broadcast(event)
-          tags = {
+          tags = span_tags(
             'broadcasting' => event.payload[:broadcasting],
             'message' => event.payload[:message],
             'coder' => event.payload[:coder]
-          }
+          )
 
           Utils.trace_notification(event: event, tags: tags)
         end

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

@@ -21,72 +21,76 @@ module Rails
         unpermitted_parameters
       ].freeze
 
+      # rubocop:disable Style/MutableConstant
+      BASE_TAGS = { 'component' => 'ActionController' }
+      # rubocop:enable Style/MutableConstant.
+
       class << self
         def write_fragment(event)
-          tags = {
+          tags = span_tags(
             'key.write' => event.payload[:key]
-          }
+          )
 
           Utils.trace_notification(event: event, tags: tags)
         end
 
         def read_fragment(event)
-          tags = {
+          tags = span_tags(
             'key.read' => event.payload[:key]
-          }
+          )
 
           Utils.trace_notification(event: event, tags: tags)
         end
 
         def expire_fragment(event)
-          tags = {
+          tags = span_tags(
             'key.expire' => event.payload[:key]
-          }
+          )
 
           Utils.trace_notification(event: event, tags: tags)
         end
 
         def exist_fragment?(event)
-          tags = {
+          tags = span_tags(
             'key.exist' => event.payload[:key]
-          }
+          )
 
           Utils.trace_notification(event: event, tags: tags)
         end
 
         def write_page(event)
-          tags = {
+          tags = span_tags(
             'path.write' => event.payload[:path]
-          }
+          )
 
           Utils.trace_notification(event: event, tags: tags)
         end
 
         def expire_page(event)
-          tags = {
+          tags = span_tags(
             'path.expire' => event.payload[:path]
-          }
+          )
 
           Utils.trace_notification(event: event, tags: tags)
         end
 
         def start_processing(event)
-          tags = {
+          tags = span_tags(
             'controller' => event.payload[:controller],
             'controller.action' => event.payload[:action],
             'request.params' => event.payload[:params],
             'request.format' => event.payload[:format],
             'http.method' => event.payload[:method],
             'http.url' => event.payload[:path]
-          }
+          )
 
           Utils.trace_notification(event: event, tags: tags)
         end
 
         def process_action(event)
-          span_name = "#{event.payload[:action]}.#{event.payload[:controller]}"
+          span_name = "#{event.payload[:controller]}.#{event.payload[:action]}"
 
-          tags = {
+          tags = span_tags(
             'controller' => event.payload[:controller],
             'controller.action' => event.payload[:action],
             'request.params' => event.payload[:params],
@@ -95,8 +99,15 @@ module Rails
             'http.url' => event.payload[:path],
             'http.status_code' => event.payload[:status],
             'view.runtime.ms' => event.payload[:view_runtime],
-            'db.runtime.ms' => event.payload[:db_runtime]
-          }
+            'db.runtime.ms' => event.payload[:db_runtime],
+            'span.kind' => 'server'
+          )
+
+
+          status_code = event.payload[:status]
+          if status_code.is_a? Integer and status_code >= 500
+            tags['error'] = true
+          end
 
           # Only append these tags onto the active span created by the patched 'process_action'
           # Otherwise, create a new span for this notification as usual
@@ -105,15 +116,18 @@ module Rails
             tags.each do |key, value|
               ::Rails::Instrumentation.tracer.active_span.set_tag(key, value)
             end
+            if event.payload.key? :exception
+              Utils.tag_error(active_span, event.payload)
+            end
           else
             Utils.trace_notification(event: event, tags: tags)
           end
         end
 
         def send_file(event)
-          tags = {
+          tags = span_tags(
             'path.send' => event.payload[:path]
-          }
+          )
 
           # there may be additional keys in the payload. It might be worth
           # trying to tag them too
@@ -125,30 +139,30 @@ module Rails
           # no defined keys, but user keys may be passed in. Might want to add
           # them at some point
 
-          Utils.trace_notification(event: event, tags: tags)
+          Utils.trace_notification(event: event, tags: BASE_TAGS)
         end
 
         def redirect_to(event)
-          tags = {
+          tags = span_tags(
             'http.status_code' => event.payload[:status],
             'redirect.url' => event.payload[:location]
-          }
+          )
 
           Utils.trace_notification(event: event, tags: tags)
         end
 
         def halted_callback(event)
-          tags = {
+          tags = span_tags(
             'filter' => event.payload[:filter]
-          }
+          )
 
           Utils.trace_notification(event: event, tags: tags)
         end
 
         def unpermitted_parameters(event)
-          tags = {
+          tags = span_tags(
             'unpermitted_keys' => event.payload[:keys]
-          }
+          )
 
           Utils.trace_notification(event: event, tags: tags)
         end

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

@@ -11,9 +11,13 @@ module Rails
         process
       ].freeze
 
+      # rubocop:disable Style/MutableConstant
+      BASE_TAGS = { 'component' => 'ActionMailer' }
+      # rubocop:enable Style/MutableConstant.
+
       class << self
         def receive(event)
-          tags = {
+          tags = span_tags(
             'mailer' => event.payload[:mailer],
             'message.id' => event.payload[:message_id],
             'message.subject' => event.payload[:subject],
@@ -23,13 +27,13 @@ module Rails
             'message.cc' => event.payload[:cc],
             'message.date' => event.payload[:date],
             'message.body' => event.payload[:mail]
-          }
+          )
 
           Utils.trace_notification(event: event, tags: tags)
         end
 
         def deliver(event)
-          tags = {
+          tags = span_tags(
             'mailer' => event.payload[:mailer],
             'message.id' => event.payload[:message_id],
             'message.subject' => event.payload[:subject],
@@ -39,17 +43,17 @@ module Rails
             'message.cc' => event.payload[:cc],
             'message.date' => event.payload[:date],
             'message.body' => event.payload[:mail]
-          }
+          )
 
           Utils.trace_notification(event: event, tags: tags)
         end
 
         def process(event)
-          tags = {
+          tags = span_tags(
             'mailer' => event.payload[:mailer],
             'action' => event.payload[:action],
             'args' => event.payload[:args]
-          }
+          )
 
           Utils.trace_notification(event: event, tags: tags)
         end

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

@@ -11,29 +11,33 @@ module Rails
         render_collection
       ].freeze
 
+      # rubocop:disable Style/MutableConstant
+      BASE_TAGS = { 'component' => 'ActionView' }
+      # rubocop:enable Style/MutableConstant.
+
       class << self
         def render_template(event)
-          tags = {
+          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 = {
+          tags = span_tags(
             'partial.identifier' => event.payload[:identifier]
-          }
+          )
 
           Utils.trace_notification(event: event, tags: tags)
         end
 
         def render_collection(event)
-          tags = {
+          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)

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

@@ -12,39 +12,43 @@ module Rails
         perform
       ].freeze
 
+      # rubocop:disable Style/MutableConstant
+      BASE_TAGS = { 'component' => 'ActiveJob' }
+      # rubocop:enable Style/MutableConstant.
+
       class << self
         def enqueue_at(event)
-          tags = {
+          tags = span_tags(
             'adapter' => event.payload[:adapter],
             'job' => event.payload[:job]
-          }
+          )
 
           Utils.trace_notification(event: event, tags: tags)
         end
 
         def enqueue(event)
-          tags = {
+          tags = span_tags(
             'adapter' => event.payload[:adapter],
             'job' => event.payload[:job]
-          }
+          )
 
           Utils.trace_notification(event: event, tags: tags)
         end
 
         def perform_start(event)
-          tags = {
+          tags = span_tags(
             'adapter' => event.payload[:adapter],
             'job' => event.payload[:job]
-          }
+          )
 
           Utils.trace_notification(event: event, tags: tags)
         end
 
         def perform(event)
-          tags = {
+          tags = span_tags(
             'adapter' => event.payload[:adapter],
             'job' => event.payload[:job]
-          }
+          )
 
           Utils.trace_notification(event: event, tags: tags)
         end

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

@@ -12,24 +12,30 @@ module Rails
         instantiation
       ].freeze
 
+      # rubocop:disable Style/MutableConstant
+      BASE_TAGS = { 'component' => 'ActiveRecord' }
+      # rubocop:enable Style/MutableConstant.
+
       class << self
         def sql(event)
-          tags = {
-            'db.statement' => event.payload[:sql],
+          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 = {
+          tags = span_tags(
             'record.count' => event.payload[:record_count],
             'record.class' => event.payload[:class_name]
-          }
+          )
 
           Utils.trace_notification(event: event, tags: tags)
         end

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

@@ -15,69 +15,73 @@ module Rails
         service_url
       ].freeze
 
+      # rubocop:disable Style/MutableConstant
+      BASE_TAGS = { 'component' => 'ActiveStorage' }
+      # rubocop:enable Style/MutableConstant.
+
       class << self
         def service_upload(event)
-          tags = {
+          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 = {
+          tags = span_tags(
             'key' => event.payload[:key],
             'service' => event.payload[:service]
-          }
+          )
 
           Utils.trace_notification(event: event, tags: tags)
         end
 
         def service_download(event)
-          tags = {
+          tags = span_tags(
             'key' => event.payload[:key],
             'service' => event.payload[:service]
-          }
+          )
 
           Utils.trace_notification(event: event, tags: tags)
         end
 
         def service_delete(event)
-          tags = {
+          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 = {
+          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 = {
+          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 = {
+          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

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

@@ -14,53 +14,57 @@ module Rails
         cache_exist?
       ].freeze
 
+      # rubocop:disable Style/MutableConstant
+      BASE_TAGS = { 'component' => 'ActiveSupport' }
+      # rubocop:enable Style/MutableConstant.
+
       class << self
         def cache_read(event)
-          tags = {
+          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 = {
+          tags = span_tags(
             'key' => event.payload[:key]
-          }
+          )
 
           Utils.trace_notification(event: event, tags: tags)
         end
 
         def cache_fetch_hit(event)
-          tags = {
+          tags = span_tags(
             'key' => event.payload[:key]
-          }
+          )
 
           Utils.trace_notification(event: event, tags: tags)
         end
 
         def cache_write(event)
-          tags = {
+          tags = span_tags(
             'key' => event.payload[:key]
-          }
+          )
 
           Utils.trace_notification(event: event, tags: tags)
         end
 
         def cache_delete(event)
-          tags = {
+          tags = span_tags(
             'key' => event.payload[:key]
-          }
+          )
 
           Utils.trace_notification(event: event, tags: tags)
         end
 
         def cache_exist?(event)
-          tags = {
+          tags = span_tags(
             'key' => event.payload[:key]
-          }
+          )
 
           Utils.trace_notification(event: event, tags: tags)
         end

data/lib/rails/instrumentation/utils.rb

@@ -18,7 +18,7 @@ module Rails
         # 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 = tags.merge(::Rails::Instrumentation::TAGS)
+          tags = ::Rails::Instrumentation::TAGS.clone.merge(tags)
 
           span = ::Rails::Instrumentation.tracer.start_span(event.name,
                                                             tags: tags,

data/lib/rails/instrumentation/version.rb

@@ -1,5 +1,5 @@
 module Rails
   module Instrumentation
-    VERSION = '0.1.0'.freeze
+    VERSION = '0.1.5'.freeze
   end
 end

data/rails-instrumentation.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'opentracing', '~> 0.3'
   spec.add_development_dependency 'appraisal', '~> 2.2'
-  spec.add_development_dependency 'bundler', '~> 1.17'
+  spec.add_development_dependency 'bundler', '>= 1.17'
   spec.add_development_dependency 'opentracing_test_tracer', '~> 0.1'
   spec.add_development_dependency 'rails', '~> 5.2.2'
   spec.add_development_dependency 'rake', '~> 10.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-instrumentation
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.5
 platform: ruby
 authors:
 - Ashwin Chandrasekar
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-02-11 00:00:00.000000000 Z
+date: 2020-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentracing
@@ -42,14 +42,14 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.17'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.17'
 - !ruby/object:Gem::Dependency
@@ -136,7 +136,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.31'
-description: 
+description:
 email:
 - achandrasekar@signalfx.com
 executables: []
@@ -169,7 +169,7 @@ files:
 homepage: https://github.com/signalfx/ruby-rails-instrumentation
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -184,8 +184,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: OpenTracing instrumentation for Rails.
 test_files: []