aws-xray 0.31.0 → 0.32.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ec204a6182574fe431e244db52a75dfdde4ff3d4
-  data.tar.gz: 2cc7a2963eceb3eb50a2d36d0f41128df1d8b70c
+  metadata.gz: 0f836cc2b95778f08b4b4e751d4917dcf44fb042
+  data.tar.gz: fa4505884970bdd4016d4a0e5b3ed0dd0d515ee9
 SHA512:
-  metadata.gz: e7c5c8e2ad818a848e0adabd9386a1c4a355896d364eacbc5ede702aad07ea4b2e4787eb737a0bc19b7b372f460be24681ba0ee4c805e5347530f402ffcbde51
-  data.tar.gz: 4ad68d2b3e93166a27a766749ac90ad6289503462b6ccac2b67c62867de2184d29f3dd8d0b879f79c171aacc5c9d35c5283e3d2f1a69a198c557dd62f07374ab
+  metadata.gz: 38563eadc0beeeb77c701e6faf8256d8b7ca64f04184105101f38fdb767ba5bba936363e26c88536f69351d606b358b2dae94f654f6e408dfd2835f538aee095
+  data.tar.gz: fe472b43014a9207c3bcd93916a1d2d6e4f625208ccb6a9f5d43113e33d6c55930def7d744661ecda79dc70e2df22b4b93f35df1984fa4093d5b7770f3a206df

data/.gitignore

@@ -8,3 +8,4 @@
 /spec/reports/
 /tmp/
 example/Gemfile.lock
+/db/

data/aws-xray.gemspec

@@ -22,6 +22,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'rack'
+  spec.add_development_dependency 'activerecord'
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'coveralls'
   spec.add_development_dependency 'faraday'
@@ -33,5 +34,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rsolr'
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'sqlite3'
   spec.add_development_dependency 'webmock'
 end

data/lib/aws/xray/context.rb

@@ -84,7 +84,7 @@ module Aws
           base_segment.set_error(fault: true, e: e)
           raise e
         ensure
-          base_segment.finish
+          base_segment.finish unless base_segment.finished?
           Client.send_segment(base_segment) if @trace.sampled?
         end
       end
@@ -104,7 +104,7 @@ module Aws
           sub.set_error(fault: true, e: e)
           raise e
         ensure
-          sub.finish
+          sub.finish unless sub.finished?
           Client.send_segment(sub) if @trace.sampled?
         end
       end

data/lib/aws/xray/hooks/active_record.rb

@@ -0,0 +1,90 @@
+require 'aws/xray'
+require 'active_record'
+
+module Aws
+  module Xray
+    module Hooks
+      module ActiveRecord
+        extend self
+
+        IGNORE_NAMES = [nil, 'SCHEMA']
+
+        # event has #name, #time, #end, #duration, #payload
+        # payload has #sql, #name, #connection_id, #binds, #cached
+        #
+        # @param [ActiveSupport::Notifications::Event] e
+        def record(e)
+          return if IGNORE_NAMES.include?(e.payload[:name])
+
+          if !e.payload[:cached] && Aws::Xray::Context.started?
+            pool, con = fetch_connection_and_pool(e.payload[:connection_id])
+            return if pool.nil? || con.nil?
+            name = build_name(pool.spec)
+            return unless name # skip when connected to default host (typycally localhost)
+
+            Aws::Xray::Context.current.start_subsegment(name: name, remote: true) do |sub|
+              sub.start(e.time)
+              sub.finish(e.end)
+              sub.set_sql(Aws::Xray::Sql.build(
+                url: build_url(pool.spec),
+                database_version: build_version(con),
+              ))
+            end
+          end
+        end
+
+        private
+
+        def fetch_connection_and_pool(id)
+          pool, con = nil, nil
+          ::ActiveRecord::Base.connection_handler.connection_pool_list.each do |p|
+            p.connections.each do |c|
+              if c.object_id == id
+                pool, con = p, c
+              end
+            end
+          end
+          return pool, con
+        end
+
+        def build_name(spec)
+          spec.config.with_indifferent_access[:host]
+        end
+
+        def build_url(spec)
+          config = spec.config.with_indifferent_access
+          adapter = config.delete(:adapter) || 'unknown'
+          host = config.delete(:host) || 'localhost'
+          port = config.delete(:port) || ''
+          username = config.delete(:username) || ''
+          database = config.delete(:database) || ''
+          config.delete(:password)
+          query = config.map {|k, v| "#{k}=#{v}" }.join('&')
+          query_str = query.empty? ? '' : "?#{query}"
+          "#{adapter}://#{username}@#{host}:#{port}/#{database}#{query_str}"
+        end
+
+        def build_version(con)
+          if con.respond_to?(:version)
+            if (v = con.version.instance_variable_get('@version'))
+              v.join('.')
+            else
+              nil
+            end
+          else
+            nil
+          end
+        end
+      end
+    end
+  end
+end
+
+# maybe old version?
+if defined?(ActiveSupport::Notifications) && ActiveSupport::Notifications.respond_to?(:subscribe)
+  ActiveSupport::Notifications.subscribe('sql.active_record') do |*args|
+    Aws::Xray::Hooks::ActiveRecord.record(ActiveSupport::Notifications::Event.new(*args))
+  end
+else
+  $stderr.puts('Skip hooking active record events because this version of active record is not supported')
+end

data/lib/aws/xray/hooks/all.rb

@@ -1,3 +1,4 @@
 require 'aws/xray'
+require 'aws/xray/hooks/active_record'
 require 'aws/xray/hooks/net_http'
 require 'aws/xray/hooks/rsolr'

data/lib/aws/xray/segment.rb

@@ -86,10 +86,18 @@ module Aws
       end
       alias_method :set_metadata, :add_metadata
 
+      def start(now = Time.now)
+        @start_time = now.to_f
+      end
+
       def finish(now = Time.now)
         @end_time = now.to_f
       end
 
+      def finished?
+        !!@end_time
+      end
+
       def to_json
         to_h.to_json
       end
@@ -127,12 +135,6 @@ module Aws
         h[:parent_id] = @parent_id if @parent_id
         h
       end
-
-      private
-
-      def start(now = Time.now)
-        @start_time = now.to_f
-      end
     end
   end
 end

data/lib/aws/xray/sql.rb

@@ -0,0 +1,13 @@
+module Aws
+  module Xray
+    class Sql < Struct.new(:url, :database_version)
+      def self.build(url: nil, database_version: nil)
+        new(url, database_version)
+      end
+
+      def to_h
+        super.delete_if {|_, v| v.nil? }
+      end
+    end
+  end
+end

data/lib/aws/xray/subsegment.rb

@@ -1,4 +1,5 @@
 require 'aws/xray/segment'
+require 'aws/xray/sql'
 
 module Aws
   module Xray
@@ -15,6 +16,7 @@ module Aws
         super(name: name, trace_id: trace.root, parent_id: parent_id)
         @trace = trace
         @remote = !!remote
+        @sql = nil
       end
 
       # Set traced=false if the downstream call is not traced app.
@@ -25,6 +27,11 @@ module Aws
         @http_request.traced = traced
       end
 
+      # @param [Aws::Xray::Sql] sql
+      def set_sql(sql)
+        @sql = sql
+      end
+
       def to_h
         h = super
         # x_forwarded_for is Segment only.
@@ -34,6 +41,7 @@ module Aws
         end
         h[:type] = TYPE_NAME
         h[:namespace] = 'remote' if @remote
+        h[:sql] = @sql.to_h if @sql
         h
       end
 

data/lib/aws/xray/version.rb

@@ -1,5 +1,5 @@
 module Aws
   module Xray
-    VERSION = '0.31.0'
+    VERSION = '0.32.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-xray
 version: !ruby/object:Gem::Version
-  version: 0.31.0
+  version: 0.32.0
 platform: ruby
 authors:
 - Taiki Ono
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-06-28 00:00:00.000000000 Z
+date: 2017-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  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: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -178,6 +192,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !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: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -231,6 +259,7 @@ files:
 - lib/aws/xray/errors.rb
 - lib/aws/xray/faraday.rb
 - lib/aws/xray/header_parser.rb
+- lib/aws/xray/hooks/active_record.rb
 - lib/aws/xray/hooks/all.rb
 - lib/aws/xray/hooks/net_http.rb
 - lib/aws/xray/hooks/rsolr.rb
@@ -240,6 +269,7 @@ files:
 - lib/aws/xray/response.rb
 - lib/aws/xray/segment.rb
 - lib/aws/xray/sockets.rb
+- lib/aws/xray/sql.rb
 - lib/aws/xray/subsegment.rb
 - lib/aws/xray/trace.rb
 - lib/aws/xray/version.rb
@@ -266,7 +296,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: The unofficial X-Ray Tracing SDK for Ruby.