rails-tracer 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 341252ba5950c2280f05fa00ebfd31a96b7a1e67
-  data.tar.gz: 3e6a3ff67203d73dbc3d3e2306abe460ac7d7d19
+  metadata.gz: a34ff90ac921cc85b1949fee9beaa086bd4d90f6
+  data.tar.gz: f930e3bb94f2d4a902b5adaaf39374b694f82668
 SHA512:
-  metadata.gz: a8ab55c727d3fd0c1b3c77db108b0ed0e8e6b252613aa3777c1f1307312444d9809383d638120557b6699b0e87e00ba34f073b82e883f1f40dd2e9eb2f64b33c
-  data.tar.gz: 27d5c6b05ea339a549dad913e37fd05cb857ceefe8539b241eccca877fafd6134451486f8b15930fd3725641a31ad34cf24af74162da099dc693fbf9074d8138
+  metadata.gz: 21bd5494160f32eb6acc36eac9fd7894921a453bf8742994f6e5978c41ff1c04384e119b684a15a6ac00be0451182bfa0810841495ecd6c6fa83ebfb91552f04
+  data.tar.gz: 7bbf9130efddb14404d00b7a11fc010701618d6a9edd43ac337572a81ddd8e255a501e7cbf2f611e6a58c3da529072863b824ce267fb4dec0f5223c9c8165e98

data/README.md

@@ -6,6 +6,7 @@ The following instrumentation is supported:
 
 * ActionDispatch - The library introduces a rack middleware, which is intended to be used together with `rack-tracer`, to generate more informative operation names based on information supplied by ActionDispatch.
 * ActiveRecord - The library hooks up into Rails, and instruments all ActiveRecord query. 
+* ActionSupport::Cache - The library hooks up into Rails, and instruments cache events.
 
 ## Installation
 
@@ -51,7 +52,8 @@ Auto-instrumentation example.
 ```ruby
 require 'rails/tracer'
 
-ActiveRecord::Tracer.instrument(tracer: OpenTracing.global_tracer, active_span: -> { OpenTracing.global_tracer.active_span })
+ActiveRecord::Tracer.instrument(tracer: OpenTracing.global_tracer,
+                               active_span: -> { OpenTracing.global_tracer.active_span })
 ```
 
 There are times when you might want to skip ActiveRecord's magic, and use connection directly. Still the library 
@@ -75,6 +77,39 @@ end
 q("FirstUser", "SELECT * FROM users LIMIT 1")
 ```
 
+## ActiveSupport::Cache
+
+The library hooks up into Rails using `ActiveSupport::Notifications`, and instruments all `ActiveSupport::Cache` events. 
+
+### Usage
+
+Auto-instrumentation example. 
+
+```ruby
+require 'rails/tracer'
+
+ActiveSupport::Cache::Tracer.instrument(tracer: OpenTracing.global_tracer, 
+                                        active_span: -> { OpenTracing.global_tracer.active_span })
+```
+
+If you want to skip the auto-instrumentation, still the library can help you with span creation and setting up proper tags. Instead of auto-instrumenting, as shown above, you can manually call `ActiveSupport::Cache::Tracer.start_span` as shown below.
+
+```ruby
+def read(key)
+  span = ActiveSupport::Cache::Tracer.start_span("InMemoryCache#read", 
+                                                 tracer: OpenTracing.global_tracer,
+                                                 active_span: -> { OpenTracing.global_tracer.active_span },
+                                                 key: key)
+  result = in_memory_cache[key]
+  span.set_tag('cache.hit', !!result) 
+  result
+ensure
+  span&.finish
+end
+
+read("user-1")
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/rails/active_support/cache/tracer.rb

@@ -0,0 +1,50 @@
+module ActiveSupport
+  module Cache
+    module Tracer
+      class << self
+        # TODO: In Rails 4.0+ it's possible to  subscribe to start events
+        def instrument(tracer: OpenTracing.global_tracer, active_span: nil)
+          events = %w(read write generate delete clear)
+          events.each do |event|
+            ActiveSupport::Notifications.subscribe("cache_#{event}.active_support") do |*args|
+              ActiveSupport::Cache::Tracer.instrument_event(tracer: tracer,
+                                                            active_span: active_span,
+                                                            event: event,
+                                                            args: args)
+            end
+          end
+        end
+
+        def instrument_event(tracer: OpenTracing.global_tracer, active_span: nil, event:, args:)
+          _, start, finish, _, payload = *args
+
+          span = start_span("cache.#{event}",
+                            event: event,
+                            tracer: tracer,
+                            active_span: active_span,
+                            start_time: start,
+                            **payload)
+
+          span.finish(end_time: finish)
+        end
+
+        def start_span(operation_name, tracer: OpenTracing.global_tracer, active_span: nil, start_time: Time.now, event:, **fields)
+          span = tracer.start_span(operation_name,
+                                   child_of: active_span.respond_to?(:call) ? active_span.call : active_span,
+                                   start_time: start_time,
+                                   tags: {
+                                    'component' => 'ActiveSupport::Cache',
+                                    'span.kind' => 'client',
+                                    'cache.key' => fields.fetch(:key, 'unknown')
+                                   })
+
+          if event == 'read'
+            span.set_tag('cache.hit', fields.fetch(:hit, false))
+          end
+
+          span
+        end
+      end
+    end
+  end
+end

data/lib/rails/tracer.rb

@@ -1,2 +1,3 @@
-require_relative "rack/tracer"
-require_relative "active_record/tracer"
+require "rails/rack/tracer"
+require "rails/active_record/tracer"
+require "rails/active_support/cache/tracer"

data/rails-tracer.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "rails-tracer"
-  spec.version       = "0.2.0"
+  spec.version       = "0.3.0"
   spec.authors       = ["iaintshine"]
   spec.email         = ["bodziomista@gmail.com"]
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-tracer
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - iaintshine
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-08-15 00:00:00.000000000 Z
+date: 2017-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentracing
@@ -224,6 +224,7 @@ files:
 - bin/console
 - bin/setup
 - lib/rails/active_record/tracer.rb
+- lib/rails/active_support/cache/tracer.rb
 - lib/rails/rack/tracer.rb
 - lib/rails/tracer.rb
 - rails-tracer.gemspec