rails-tracer 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: '042756289491ce49c5e0a2c38a4d28a27103c893'
-  data.tar.gz: 9a4f1916f6bcfd9f64dd25ec4d0f180baa5bcdba
+  metadata.gz: 341252ba5950c2280f05fa00ebfd31a96b7a1e67
+  data.tar.gz: 3e6a3ff67203d73dbc3d3e2306abe460ac7d7d19
 SHA512:
-  metadata.gz: e90a6d17069102cdae33dd4db1cc90518cee06911f3a34554ab4b2ef78364db495a749ac7ef52afa5580dcd687bd56d2fa98847c49444422b2f320f6a7591960
-  data.tar.gz: 6a6c8e227868cfa4b11641c48e885b972927e304aa4d6bfc5d09c519c46a54fd974a4ec902233b45f62b817a003045e7da00c4ef3590c400a92b4790bc22a72d
+  metadata.gz: a8ab55c727d3fd0c1b3c77db108b0ed0e8e6b252613aa3777c1f1307312444d9809383d638120557b6699b0e87e00ba34f073b82e883f1f40dd2e9eb2f64b33c
+  data.tar.gz: 27d5c6b05ea339a549dad913e37fd05cb857ceefe8539b241eccca877fafd6134451486f8b15930fd3725641a31ad34cf24af74162da099dc693fbf9074d8138

data/README.md

@@ -2,10 +2,10 @@
 
 This gem is an attempt to introduce OpenTracing instrumentation into Rails. It's in a very early stage. 
 
-When you use `rack-tracer`, the generated operation name corresponds to the request's http method e.g. GET, POST etc.
-It's not perfect. You need to dig into the trace to understand with what url it's related. 
+The following instrumentation is supported:
 
-The `rails-tracer` introduces another rack middleware, which is intended to be used together with `rack-tracer`, to generate more informative operation names in the form `ControllerName#action`.
+* 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. 
 
 ## Installation
 
@@ -23,7 +23,14 @@ Or install it yourself as:
 
     $ gem install rails-tracer
 
-## Usage
+## ActionDispatch 
+
+When you use `rack-tracer`, the generated operation name corresponds to the request's http method e.g. GET, POST etc.
+It's not perfect. You need to dig into the trace to understand with what url it's related. 
+
+The `rails-tracer` introduces another rack middleware, which is intended to be used together with `rack-tracer`, to generate more informative operation names in the form `ControllerName#action`.
+
+### Usage
 
 ```ruby
 require 'rack/tracer'
@@ -33,6 +40,41 @@ Rails.configuration.middleware.use(Rack::Tracer)
 Rails.configuration.middleware.insert_after(Rack::Tracer, Rails::Rack::Tracer)
 ```
 
+## ActiveRecord
+
+The library hooks up into Rails using `ActiveSupport::Notifications`, and instruments all `ActiveRecord` query. 
+
+### Usage
+
+Auto-instrumentation example. 
+
+```ruby
+require 'rails/tracer'
+
+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 
+can help you with span creation. Instead of auto-instrumenting you can manually call `ActiveRecord::Tracer.start_span` as shown below.
+
+```ruby
+def q(name, sql)
+  span = ActiveRecord::Tracer.start_span(name, 
+                                          tracer: OpenTracing.global_tracer,
+                                          active_span: -> { OpenTracing.global_tracer.active_span },
+                                          sql: sql)
+  ActiveRecord::Base.
+    connection.
+    raw_connection.
+    query(sql).
+    each(as: :hash)
+ensure
+  span&.finish
+end
+
+q("FirstUser", "SELECT * FROM users LIMIT 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_record/tracer.rb

@@ -0,0 +1,48 @@
+module ActiveRecord
+  module Tracer
+    DEFAULT_OPERATION_NAME = "sql.query".freeze
+
+    class << self
+      def instrument(tracer: OpenTracing.global_tracer, active_span: nil)
+        ::ActiveSupport::Notifications.subscribe('sql.active_record') do |*args|
+          ActiveRecord::Tracer.sql(tracer: tracer, active_span: active_span, args: args)
+        end
+      end
+
+      def sql(tracer: OpenTracing.global_tracer, active_span: nil, args:)
+        _, start, finish, _, payload = *args
+
+        span = start_span(payload.fetch(:name),
+                          tracer: tracer,
+                          active_span: active_span,
+                          start_time: start,
+                          sql: payload.fetch(:sql),
+                          cached: payload.fetch(:cached, false),
+                          connection_id: payload.fetch(:connection_id))
+
+        span.finish(end_time: finish)
+      end
+
+
+      def start_span(operation_name, tracer: OpenTracing.global_tracer, active_span: nil, start_time: Time.now, **fields)
+        connection_config = ::ActiveRecord::Base.connection_config
+
+        span = tracer.start_span(operation_name || DEFAULT_OPERATION_NAME,
+                                 child_of: active_span.respond_to?(:call) ? active_span.call : active_span,
+                                 start_time: start_time,
+                                 tags: {
+                                  'component' => 'ActiveRecord',
+                                  'span.kind' => 'client',
+                                  'db.user' => connection_config.fetch(:username, 'unknown'),
+                                  'db.instance' => connection_config.fetch(:database),
+                                  'db.vendor' => connection_config.fetch(:adapter),
+                                  'db.connection_id' => fields.fetch(:connection_id, 'unknown'),
+                                  'db.cached' => fields.fetch(:cached, false),
+                                  'db.statement' => fields.fetch(:sql),
+                                  'db.type' => 'sql'
+                                 })
+        span
+      end
+    end
+  end
+end

data/lib/rails/tracer.rb

@@ -1 +1,2 @@
 require_relative "rack/tracer"
+require_relative "active_record/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.1.1"
+  spec.version       = "0.2.0"
   spec.authors       = ["iaintshine"]
   spec.email         = ["bodziomista@gmail.com"]
 
@@ -22,6 +22,12 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'opentracing', '~> 0.3.1'
   spec.add_dependency "rack-tracer", "~> 0.3.0"
 
+  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 "test-tracer", "~> 1.1"
   spec.add_development_dependency "bundler", "~> 1.15"
   spec.add_development_dependency "rake", "~> 10.0"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails-tracer
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - iaintshine
@@ -38,6 +38,76 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.3.0
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.3
+- !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: test-tracer
   requirement: !ruby/object:Gem::Requirement
@@ -153,6 +223,7 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- lib/rails/active_record/tracer.rb
 - lib/rails/rack/tracer.rb
 - lib/rails/tracer.rb
 - rails-tracer.gemspec