rails-instrumentation 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 1c26892d66e7c765f6b96fcd43c4183992637b79d141ceadb2bca673c127c9c1
-  data.tar.gz: f8e3b2ba6d27678d736a82d4ef16c9c9f82d7d1af1b6396926dd1b574c721a84
+SHA1:
+  metadata.gz: 8551104747da24e8bfa6d6dbc2358c0191862fed
+  data.tar.gz: f41da46c02ae8c48875b643606051d441bf0047c
 SHA512:
-  metadata.gz: b91a64c9f342fe3775b3691a707fd23a126abc62fb335dfa6cd0525ec74bf3f6ecd9382d78129b7200734817284e7c538ee7105a6b454428fb9d21127d72b2b1
-  data.tar.gz: 37f379774abce8a13e36a2934b547b04265e6854d301d1aae1f1d31e921034796adc3724248a39b643fc677fbe2778f77d7d85708211664ea4908d7ac72b98a7
+  metadata.gz: 448bc729d36f9612721c77c57d53da429520f62d3005d44b70c28d5f5d78a19caf33bf2551f2558395f6e773371beef4d4bca7b4d3c5616d14f1daa8613b8f40
+  data.tar.gz: 17b16dae5dcf85e2e0ca6bea7eba7103365eb8157544ab795f325b3f9f9d28ebcbf3992da6f2ce4767c73eedd788c9b42fe552e7a0b2b6001ec4f34f6c3a5f54

data/lib/rails/instrumentation/patch.rb

@@ -6,9 +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}"
+            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

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,9 @@ 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'
+          )
 
           # Only append these tags onto the active span created by the patched 'process_action'
           # Otherwise, create a new span for this notification as usual
@@ -111,9 +116,9 @@ module Rails
         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 +130,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,28 @@ module Rails
         instantiation
       ].freeze
 
+      # rubocop:disable Style/MutableConstant
+      BASE_TAGS = { 'component' => 'ActiveRecord' }
+      # rubocop:enable Style/MutableConstant.
+
       class << self
         def sql(event)
-          tags = {
+          tags = span_tags(
             'db.statement' => event.payload[:sql],
             '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.1'.freeze
+    VERSION = '0.1.2'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-instrumentation
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Ashwin Chandrasekar
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-05-06 00:00:00.000000000 Z
+date: 2019-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentracing
@@ -184,7 +184,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
+rubyforge_project: 
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: OpenTracing instrumentation for Rails.