aws-xray 0.14.0 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e367a0bf45a2a7055628dc8e2f41626f164ece6a
-  data.tar.gz: 0da9a4d1438e8ffe38f369c341af17f44342b0b3
+  metadata.gz: 299ef3e4e20724f082b232846ec09d48257cf4e7
+  data.tar.gz: d66f81590342387f0dcdf80981aea4ec95fd9449
 SHA512:
-  metadata.gz: c287819c6e3ea6b726675c420aec2f1a2ca94f315c85a4feba9e019e26f68a9ab59adfc8e02b7f6a3d42d40a449168031695e3f9f05bb6b501f79c25350a2860
-  data.tar.gz: 6ec72a4fa10a76c7ed6ff305a93d7a821fa2a002dcf04e27431673ac7c273afee571b90538e64e3ce3f160ad842f77bd9f3521185f8cfd3cdd5f302a2215575f
+  metadata.gz: 364d93ef9043a99cc26383d1d6fe5f563fa580b9aaa2b4b7fc733eb4089de5602a66c8c61b002c2e2a7c7c92d6525ced5b12b7e461602a00f402c05a621ac8e8
+  data.tar.gz: 90c80537e55f225c5d797684e10472e56f617c6e5c7b3a9edcf237da933966dc82e9a6fa7f5068466e787733871f23811a336591fd32d47107701c355db8686c

data/README.md

@@ -8,9 +8,10 @@ It enables you to capture in-coming HTTP requests and out-going HTTP requests an
 AWS X-Ray is a ditributed tracing system. See more detail about AWS X-Ray at [official document](http://docs.aws.amazon.com/xray/latest/devguide/aws-xray.html).
 
 ## Features
+- Propagatin support in both single and multi thread environment.
 - Rack middleware.
 - Faraday middleware.
-- Propagatin support in both single and multi thread environment.
+- net/http hook.
 - Tracing HTTP request/response.
 - Tracing errors.
 - Annotation and metadata support.
@@ -88,6 +89,35 @@ Aws::Xray.trace(name: 'my-app-batch') do |seg|
 end
 ```
 
+### Hooks
+You can enable all the hooks with:
+
+```ruby
+# Gemfile
+gem 'aws-xray', require: 'aws/xray/hooks/all'
+```
+
+#### net/http hook
+To monkey patch net/http and records out-going http requests automatically, just require `aws/xray/hooks/net_http`:
+
+If you can pass headers for net/http client, you can setup subsegment name via `X-Aws-Xray-Name` header:
+
+```ruby
+Net::HTTP.start(host, port) do |http|
+  req = Net::HTTP::Get.new(uri, { 'X-Aws-Xray-Name' => 'target-app' })
+  http.request(req)
+end
+```
+
+If you can't access headers, e.g. external client library like aws-sdk or dogapi-rb, setup subsegment name by `Aws::Xray::Context#overwrite`:
+
+```ruby
+client = Aws::Sns::Client.new
+response = Aws::Xray::Context.current.overwrite(name: 'sns') do
+  client.create_topic(...)
+end
+```
+
 ### Multi threaded environment
 Tracing context is thread local. To pass current tracing context, copy current tracing context:
 

data/lib/aws/xray/context.rb

@@ -148,7 +148,7 @@ module Aws
       # CAUTION: the injection will NOT be propagated between threads!!
       #
       # @param [String] name
-      def overwrite_sub_segment(name:)
+      def overwrite(name:)
         @sub_segment_name = name.to_s
 
         begin

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

@@ -0,0 +1 @@
+require 'aws/xray/hooks/net_http'

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

@@ -4,6 +4,8 @@ module Aws
   module Xray
     module Hooks
       module NetHttp
+        NAME_HEADER = 'X-Aws-Xray-Name'.freeze
+
         def request(req, *args)
           return super unless Context.started?
           return super if Context.current.disabled?(:net_http)
@@ -18,7 +20,8 @@ module Aws
             url: uri.to_s,
             user_agent: req['User-Agent'],
           )
-          Context.current.child_trace(remote: true, name: address) do |sub|
+          name = req[NAME_HEADER] || req['Host'] || address
+          Context.current.child_trace(remote: true, name: name) do |sub|
             propagate_trace = sub.generate_trace
             req[TRACE_HEADER] = propagate_trace.to_header_value
             sub.set_http_request(request_record)

data/lib/aws/xray/version.rb

@@ -1,5 +1,5 @@
 module Aws
   module Xray
-    VERSION = '0.14.0'
+    VERSION = '0.15.0'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aws-xray
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.15.0
 platform: ruby
 authors:
 - Taiki Ono
@@ -144,6 +144,7 @@ files:
 - lib/aws/xray/error.rb
 - lib/aws/xray/faraday.rb
 - lib/aws/xray/header_parser.rb
+- lib/aws/xray/hooks/all.rb
 - lib/aws/xray/hooks/net_http.rb
 - lib/aws/xray/rack.rb
 - lib/aws/xray/rails.rb