rails_opentracer 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ebecd0945eb679dfeb98e6cca76563c0f0876be5
-  data.tar.gz: 1b74a57df36cb548c7afac1930e0fceb525680aa
+  metadata.gz: d15842672de526bc49701d76608ad4721e9296aa
+  data.tar.gz: 9b4b7e1859877526b2212eb1a2099c8089ca15fb
 SHA512:
-  metadata.gz: 3790f9481f5e7d2687fd1e5ea6b481beab79a7f4ebf717c3805d3a1cb446b92de37ddda3f844845061f9f6e6ed1c4bb381b3a268994ef21b755d3b9cb703c3bf
-  data.tar.gz: c67f581ca1bb9d16e42b77c0899c0f84656fe9a34d278de18e3395aae4e579363da949bc97b0f1283971e6564a073a0f6d279314349536eeb7f3532833944d44
+  metadata.gz: aa2a5835ea28709c759a8410e03a4b565c4a9b7251d4f94297e15f0ca1aacca7d0b0e0d69c4996b6fb4bf07d698517b57a04b822a174bb5222051fb458deb497
+  data.tar.gz: e04c7d812f52162fe813dc07633165d867447499303db62809c88f7f5a4bcaa4b2a1751185ff3e5b1952df301a607eb05205bd534e0c26239e2c995716286db0

data/README.md

@@ -9,7 +9,7 @@ TODO:
 - Testz
 - Is faraday_tracer.rb required ?
 - Instrument active record tracing (and give creditz to ruby-rails-tracer's dude)
-- Are all those generators "the way" we want to do thingz?
+- Are all those generators "the way" we want to do things?
 
 ## Installation
 

data/lib/rails_opentracer/active_record/rails_opentracer.rb

@@ -0,0 +1,65 @@
+module ActiveRecord
+  module RailsOpentracer
+    DEFAULT_OPERATION_NAME = "sql.query".freeze
+
+    class << self
+      def instrument(tracer: OpenTracing.global_tracer, active_span: nil)
+        clear_subscribers
+        @subscriber = ::ActiveSupport::Notifications.subscribe('sql.active_record') do |*args|
+          ActiveRecord::Tracer.sql(tracer: tracer, active_span: active_span, args: args)
+        end
+
+        self
+      end
+
+      def disable
+        if @subscriber
+          ActiveSupport::Notifications.unsubscribe(@subscriber)
+          @subscriber = nil
+        end
+
+        self
+      end
+      alias :clear_subscribers :disable
+
+      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))
+
+        if payload[:exception]
+          RailsOpenTracer::SpanHelpers.set_error(span, payload[:exception_object] || payload[:exception])
+        end
+
+        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_opentracer/span_helpers.rb

@@ -0,0 +1,17 @@
+module RailsOpentracer
+  module SpanHelpers
+    class << self
+      def set_error(span, exception)
+        span.set_tag('error', true)
+
+        case exception
+        when Array
+          exception_class, exception_message = exception
+          span.log(event: 'error', :'error.kind' => exception_class, message: exception_message)
+        when Exception
+          span.log(event: 'error', :'error.object' => exception)
+        end
+      end
+    end
+  end
+end

data/lib/rails_opentracer/version.rb

@@ -1,3 +1,3 @@
 module RailsOpentracer
-  VERSION = "0.1.6"
+  VERSION = "0.1.7"
 end

data/lib/rails_opentracer.rb

@@ -1,7 +1,20 @@
+require 'rails_opentracing/activerecord/rails_opentracer.rb'
+require 'rails_opentracing/span_helpers'
 require 'rails_opentracer/version'
 require 'faraday'
 
 module RailsOpentracer
+
+  class << self
+    def instrument(tracer: OpenTracing.global_tracer, active_span: nil, active_record: true)
+      ActiveRecord::RailsOpentracer.instrument(tracer: tracer, active_span: active_span) if active_record
+    end
+
+    def disable
+      ActiveRecord::RailsOpenTracer.disable
+    end
+  end
+
   def get(url)
     connection = Faraday.new do |con|
       con.use FaradayTracer

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_opentracer
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - Nicholas Erasmus
@@ -115,6 +115,8 @@ files:
 - lib/generators/templates/rails_opentracer_initializer.rb
 - lib/generators/templates/tracer.rb
 - lib/rails_opentracer.rb
+- lib/rails_opentracer/active_record/rails_opentracer.rb
+- lib/rails_opentracer/span_helpers.rb
 - lib/rails_opentracer/version.rb
 - rails_opentracer.gemspec
 homepage: https://github.com/nuclearnic/rails_opentracer