rails-tracer 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a34ff90ac921cc85b1949fee9beaa086bd4d90f6
-  data.tar.gz: f930e3bb94f2d4a902b5adaaf39374b694f82668
+  metadata.gz: 0e1e93a75097ddbf88329b765f10c4c935c24140
+  data.tar.gz: 1350b1c77006d804fba79b72dac70ede6e36ac5c
 SHA512:
-  metadata.gz: 21bd5494160f32eb6acc36eac9fd7894921a453bf8742994f6e5978c41ff1c04384e119b684a15a6ac00be0451182bfa0810841495ecd6c6fa83ebfb91552f04
-  data.tar.gz: 7bbf9130efddb14404d00b7a11fc010701618d6a9edd43ac337572a81ddd8e255a501e7cbf2f611e6a58c3da529072863b824ce267fb4dec0f5223c9c8165e98
+  metadata.gz: 845c819c94d5b260ab82586c0e470e0996aa7224e1b0a13a7794f9f01da7fcdf4d850af0c83c5d236529669f4c3402166ce12699fd143fefd90269884609f9f5
+  data.tar.gz: fe067ca4580cacc133e9a1bae10673f3cfc71ea7157c2311baa0de1641f130f87c6ad8672463262e835764ba155a5d5e40169c222428efc7e34db474ce633ad5

data/.travis.yml

@@ -1,5 +1,8 @@
-sudo: false
+sudo: true
 language: ruby
 rvm:
   - 2.3.4
-before_install: gem install bundler -v 1.15.3
+before_install: 
+  - gem install bundler -v 1.15.3
+services:
+  - memcached

data/CHANGELOG.md

@@ -0,0 +1,26 @@
+## 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/README.md

@@ -92,6 +92,14 @@ ActiveSupport::Cache::Tracer.instrument(tracer: OpenTracing.global_tracer,
                                         active_span: -> { OpenTracing.global_tracer.active_span })
 ```
 
+If you use [Dalli](https://github.com/petergoldstein/dalli/) and `ActiveSupport::Cache::DalliStore` as your application's cache store, you can get low-level details about Memcached calls by setting `dalli` option to `true`. If you want to get even more details, simply require [tracing-logger](https://github.com/iaintshine/ruby-tracing-logger) and Dalli error logs will be attached to the current active span. The library will wrap current `Dalli.logger` into a `Tracing::CompositeLogger` and append additional `Tracing::Logger` with severity level set to `Logger::ERROR`.
+
+```ruby
+ActiveSupport::Cache::Tracer.instrument(tracer: OpenTracing.global_tracer, 
+                                        active_span: -> { OpenTracing.global_tracer.active_span },
+                                        dalli: true)
+```
+
 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

data/docker-compose.yml

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

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

@@ -0,0 +1,80 @@
+require "method/tracer"
+
+module Dalli
+  class Tracer
+    class << self
+      def instrument(tracer: OpenTracing.global_tracer, active_span: nil)
+        ::Dalli::Server.class_eval do
+          @tracer = tracer
+          @active_span = active_span
+
+          class << self
+            attr_reader :tracer, :active_span
+          end
+
+          def tracer
+            self.class.tracer
+          end
+
+          def active_span
+            self.class.active_span
+          end
+
+          alias_method :request_without_instrumentation, :request
+
+          def request(op, *args)
+            tags = {
+              'component' => 'Dalli::Server',
+              'span.kind' => 'client',
+              'db.statement' => op.to_s,
+              'db.type' => 'memcached',
+              'peer.hostname' => hostname,
+              'peer.port' => port,
+              'peer.weight' => weight
+            }
+            Method::Tracer.trace("Dalli::Server#request", tracer: tracer, child_of: active_span, tags: tags) do
+              request_without_instrumentation(op, *args)
+            end
+          end
+        end
+
+        ::Dalli::Client.class_eval do
+          @tracer = tracer
+          @active_span = active_span
+
+          class << self
+            attr_reader :tracer, :active_span
+          end
+
+          def tracer
+            self.class.tracer
+          end
+
+          def active_span
+            self.class.active_span
+          end
+
+          alias_method :perform_without_instrumentation, :perform
+
+          def perform(*args)
+            Method::Tracer.trace("Dalli::Client#perform", tracer: tracer, child_of: active_span) do
+              perform_without_instrumentation(*args)
+            end
+          end
+        end
+      end
+
+      def remove_instrumentation
+        ::Dalli::Server.class_eval do
+          alias_method :request, :request_without_instrumentation
+          remove_method :request_without_instrumentation
+        end
+
+        ::Dalli::Client.class_eval do
+          alias_method :perform, :perform_without_instrumentation
+          remove_method :perform_without_instrumentation
+        end
+      end
+    end
+  end
+end

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

@@ -3,7 +3,7 @@ module ActiveSupport
     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)
+        def instrument(tracer: OpenTracing.global_tracer, active_span: nil, dalli: false)
           events = %w(read write generate delete clear)
           events.each do |event|
             ActiveSupport::Notifications.subscribe("cache_#{event}.active_support") do |*args|
@@ -13,6 +13,26 @@ module ActiveSupport
                                                             args: args)
             end
           end
+
+          instrument_dalli(tracer: tracer, active_span: active_span) if dalli
+        end
+
+        def instrument_dalli(tracer:, active_span:)
+          return unless defined?(ActiveSupport::Cache::DalliStore)
+          require 'rails/active_support/cache/dalli_tracer'
+
+          Dalli::Tracer.instrument(tracer: tracer, active_span: active_span)
+          instrument_dalli_logger(active_span: active_span)
+        end
+
+        def instrument_dalli_logger(active_span:, level: Logger::ERROR)
+          return unless defined?(Tracing::Logger)
+          return unless active_span
+          return if [Tracing::Logger, Tracing::CompositeLogger].any? { |t| Dalli.logger.is_a?(t) }
+
+          tracing_logger = Tracing::Logger.new(active_span: active_span, level: level)
+          loggers = [tracing_logger, Dalli.logger].compact
+          Dalli.logger = Tracing::CompositeLogger.new(*loggers)
         end
 
         def instrument_event(tracer: OpenTracing.global_tracer, active_span: nil, event:, args:)

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.3.0"
+  spec.version       = "0.4.0"
   spec.authors       = ["iaintshine"]
   spec.email         = ["bodziomista@gmail.com"]
 
@@ -21,13 +21,15 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'opentracing', '~> 0.3.1'
   spec.add_dependency "rack-tracer", "~> 0.3.0"
+  spec.add_dependency "method-tracer", "~> 1.1"
 
   spec.add_development_dependency "rails", "~> 5.1.3"
   spec.add_development_dependency "sqlite3"
   spec.add_development_dependency "puma", "~> 3.7"
   spec.add_development_dependency "rspec-rails", "~> 3.6"
   spec.add_development_dependency "database_cleaner", "~> 1.6"
-
+  spec.add_development_dependency "dalli", "~> 2.7.6"
+  spec.add_development_dependency "tracing-logger", "~> 1.0"
   spec.add_development_dependency "test-tracer", "~> 1.1"
   spec.add_development_dependency "bundler", "~> 1.15"
   spec.add_development_dependency "rake", "~> 10.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-tracer
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - iaintshine
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-08-16 00:00:00.000000000 Z
+date: 2017-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentracing
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.3.0
+- !ruby/object:Gem::Dependency
+  name: method-tracer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -108,6 +122,34 @@ dependencies:
     - - "~>"
       - !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
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.7.6
+- !ruby/object:Gem::Dependency
+  name: tracing-logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: test-tracer
   requirement: !ruby/object:Gem::Requirement
@@ -217,13 +259,16 @@ files:
 - ".rspec"
 - ".ruby-verison"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
+- docker-compose.yml
 - lib/rails/active_record/tracer.rb
+- lib/rails/active_support/cache/dalli_tracer.rb
 - lib/rails/active_support/cache/tracer.rb
 - lib/rails/rack/tracer.rb
 - lib/rails/tracer.rb