aws-xray 0.32.2 → 0.33.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9339c52726c1286dc967332ebd1214d81dff09a7
-  data.tar.gz: 85c8c3eecbd5b705e05975db29e893cdd809c309
+  metadata.gz: 86518cf5bf93669438808fdc243b85a0f008c6fb
+  data.tar.gz: d3f4dc26f179fcdac79c1e869dd3184bd205839e
 SHA512:
-  metadata.gz: 1fec4a00dfae3a47a23f5263fbe8512cf447e9ef274518052c62078e58707a0ff014a5c7236ac844df8771574700ee9d4b6fae9938bb79ca828b6c4b0ff6cd3e
-  data.tar.gz: '0668ff24b6871a361b87996111bb08883407988665aaca163e34b698dd5530a26b5b5b0d00eb9045e308199ac5fb35c32bd550040e28441ac00928f41180e0c5'
+  metadata.gz: 4e7b87167a284726f295ea77cd6f91f56c1729e4699708fac291e223c0f4b02c8727b557a631bd54fb78747b38bdce5a5036e5b8a833e0c57d69b82ecc50aea1
+  data.tar.gz: 3016ab09e4e9e956b3f7ad02411c945d95ae75449f043e4967cdcfdde9ebafff841b2b6a430c46b151514f93c5e79fab0c9408eb80afa92dc21b8bee395581b4

data/README.md

@@ -215,6 +215,10 @@ Optionaly, aws-xray offers an error handler which integrats with Sentry. To use
 Aws::Xray.config.segment_sending_error_handler = Aws::Xray::ErrorHandlerWithSentry.new
 ```
 
+### Recording caller of HTTP requests
+Set `Aws::Xray.config.record_caller_of_http_requests = true` if you want investigate the caller of specific HTTP requests.
+It records caller of net/http and Faraday middleware.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/aws/xray/caller_builder.rb

@@ -0,0 +1,33 @@
+module Aws
+  module Xray
+    module CallerBuilder
+      extend self
+
+      MAX_BACKTRACE_SIZE = 100
+
+      # Build caller stack trace data.
+      # @return [Hash] for metadata
+      def call
+        dir = (Dir.pwd + '/') rescue '/'
+        stack = caller
+
+        truncated = [stack.size - MAX_BACKTRACE_SIZE, 0].max
+        stack = stack[0..MAX_BACKTRACE_SIZE - 1].map do |s|
+          file, line, method_name = s.split(':')
+          {
+            path: file.sub(dir, ''),
+            line: line,
+            label: method_name,
+          }
+        end
+
+        {
+          caller: {
+            stack: stack,
+            truncated: truncated,
+          }
+        }
+      end
+    end
+  end
+end

data/lib/aws/xray/configuration.rb

@@ -41,6 +41,7 @@ module Aws
         @worker = Aws::Xray::Worker::Configuration.new
         @sampling_rate = Float(ENV['AWS_XRAY_SAMPLING_RATE'] || 0.001)
         @solr_hook_name = 'solr'
+        @record_caller_of_http_requests = false
       end
 
       # @param [String] name Logical service name for this application.
@@ -103,6 +104,10 @@ module Aws
       # @param [String] solr_hook_name
       # @return [String]
       attr_accessor :solr_hook_name
+
+      # @param [Boolean] record_caller_of_http_requests
+      # @return [Boolean]
+      attr_accessor :record_caller_of_http_requests
     end
   end
 end

data/lib/aws/xray/faraday.rb

@@ -25,6 +25,7 @@ module Aws
           res = Context.current.disable_trace(:net_http) { @app.call(req_env) }
           res.on_complete do |res_env|
             sub.set_http_response_with_error(res_env.status, res_env.response_headers['Content-Length'], remote: true)
+            sub.add_metadata(CallerBuilder.call) if Aws::Xray.config.record_caller_of_http_requests
           end
         end
       end

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

@@ -30,6 +30,7 @@ module Aws
             res = request_without_aws_xray(req, *args, &block)
 
             sub.set_http_response_with_error(res.code.to_i, res['Content-Length'], remote: true)
+            sub.add_metadata(CallerBuilder.call) if Aws::Xray.config.record_caller_of_http_requests
             res
           end
         end

data/lib/aws/xray/segment.rb

@@ -4,6 +4,7 @@ require 'aws/xray/request'
 require 'aws/xray/response'
 require 'aws/xray/error'
 require 'aws/xray/annotation_normalizer'
+require 'aws/xray/caller_builder'
 
 module Aws
   module Xray

data/lib/aws/xray/version.rb

@@ -1,5 +1,5 @@
 module Aws
   module Xray
-    VERSION = '0.32.2'
+    VERSION = '0.33.0'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aws-xray
 version: !ruby/object:Gem::Version
-  version: 0.32.2
+  version: 0.33.0
 platform: ruby
 authors:
 - Taiki Ono
@@ -250,6 +250,7 @@ files:
 - lib/aws-xray.rb
 - lib/aws/xray.rb
 - lib/aws/xray/annotation_normalizer.rb
+- lib/aws/xray/caller_builder.rb
 - lib/aws/xray/cause.rb
 - lib/aws/xray/client.rb
 - lib/aws/xray/configuration.rb