aws-xray 0.11.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2e2db1f1c47ffff23ff5b3ba4907d7db96f00ac8
-  data.tar.gz: 53a29948b35d186813d7266ce6c4953d4738ea3a
+  metadata.gz: 2ecfbca12fbd25e263e57ef71b541a24e305fd51
+  data.tar.gz: 693d7427b8e08fb09c7ef44c6fce33feab3cfb21
 SHA512:
-  metadata.gz: b611a69af5a88fe9aeac5e87cc82b65667b23a465307ad1e48cb1fe69d525675ba7390903548119d5d276db3ead306c0d1802169cb32fd57e02ce3df1c95cbb2
-  data.tar.gz: 1ed14d0833d3634882b1283652a98128784994f7d603047ed625e26869cd9aeb76013db6423ac6eaaa7c6ffde89bd291b207fdd7dd383d1de29546b472b285ec
+  metadata.gz: '081c37ab015b24bdbdd4c2e1b150c0bfd8b6f039cab16dfb15f93ba5549cc47fe12a49e39e01cbe87f19f9a168956d1368e87ec85ded71f5aa2927eba3477ee4'
+  data.tar.gz: 20c0d925ebb6d9ecbf81a8f0b73d9a07587f2f4661174586892f44e170665b372a2730871f673ecfeb11d2d06acd5e78d178cf3ad329b3337a3da27ea7ff61d9

data/README.md

@@ -10,7 +10,7 @@ AWS X-Ray is a ditributed tracing system. See more detail about AWS X-Ray at [of
 ## Features
 - Rack middleware.
 - Faraday middleware.
-- Propagatin support limited in single thread environment.
+- Propagatin support in both single and multi thread environment.
 - Tracing HTTP request/response.
 - Tracing errors.
 - Annotation and metadata support.
@@ -88,6 +88,16 @@ Aws::Xray.trace(name: 'my-app-batch') do |seg|
 end
 ```
 
+### Multi threaded environment
+Tracing context is thread local. To pass current tracing context, copy current tracing context:
+
+```ruby
+Thread.new(Aws::Xray::Context.current.copy) do |context|
+  Aws::Xray::Context.set_current(context)
+  # Do something
+end
+```
+
 ## Configurations
 ### X-Ray agent location
 aws-xray does not send any trace data dby efault. Set `AWS_XRAY_LOCATION` environment variable like `AWS_XRAY_LOCATION=localhost:2000`

data/lib/aws/xray.rb

@@ -28,8 +28,6 @@ module Aws
           yield seg
         end
       end
-    ensure
-      client.close
     end
   end
 end

data/lib/aws/xray/client.rb

@@ -2,28 +2,28 @@ require 'socket'
 
 module Aws
   module Xray
+    # Own the responsibility of holding destination address and sending
+    # segments.
     class Client
-      # sock is for test
-      #
-      # XXX: keep options for implmenting copying later.
+      # sock is for test.
       def initialize(host: nil, port: nil, sock: nil)
-        @host, @port = host, port
-        @sock = sock || UDPSocket.new
+        @host, @port = host.freeze, port.freeze
+        @sock = sock
+        freeze
       end
 
+      # When UDPSocket#send can not send all bytes, just give up it.
       # @param [Aws::Xray::Segment] segment
       def send_segment(segment)
-        segment.finish
         payload = %!{"format": "json", "version": 1}\n#{segment.to_json}\n!
-        len = @sock.send(payload, 0, @host, @port)
-        # TODO: retry
-        if payload.size != len
-          $stderr.puts("Can not send all bytes: #{len} sent")
-        end
-      end
+        sock = @sock || UDPSocket.new
 
-      def close
-        @sock.close
+        begin
+          len = sock.send(payload, 0, @host, @port)
+          $stderr.puts("Can not send all bytes: #{len} sent") if payload.size != len
+        ensure
+          sock.close
+        end
       end
     end
   end

data/lib/aws/xray/context.rb

@@ -4,31 +4,40 @@ require 'aws/xray/sub_segment'
 module Aws
   module Xray
     class Context
-      class << self
-        VAR_NAME = :_aws_xray_context_
+      VAR_NAME = :_aws_xray_context_
+
+      class BaseError < ::StandardError; end
+
+      class NotSetError < BaseError
+        def initialize
+          super('Context is not set for this thread')
+        end
+      end
 
-        class NotSetError < ::StandardError
-          def initialize
-            super('Context is not set for this thread')
-          end
+      class SegmentDidNotStartError < BaseError
+        def initialize
+          super('Segment did not start yet')
         end
+      end
 
+      class << self
         # @return [Aws::Xray::Context]
         def current
           Thread.current.thread_variable_get(VAR_NAME) || raise(NotSetError)
         end
 
+        # @param [Aws::Xray::Context] context
+        def set_current(context)
+          Thread.current.thread_variable_set(VAR_NAME, context)
+        end
+
         # @return [Boolean]
         def started?
           !!Thread.current.thread_variable_get(VAR_NAME)
         end
 
         # @param [String] name logical name of this tracing context.
-        # @param [Aws::Xray::Client] client Require this parameter because the
-        #   socket inside client can live longer than this context. For example
-        #   the life-cycle of context is HTTP request based but the socket can
-        #   live over HTTP requests cycle, it is opened when application starts
-        #   then is closed when application exits.
+        # @param [Aws::Xray::Client] client
         # @param [Aws::Xray::Trace] trace newly generated trace or created with
         #   HTTP request header.
         # @yield [Aws::Xray::Context] newly created context.
@@ -52,11 +61,23 @@ module Aws
 
       attr_reader :name
 
-      def initialize(name, client, trace)
-        @name = name
+      # client and trace are frozen by default.
+      def initialize(name, client, trace, base_segment_id = nil)
+        @name = name.freeze
         @client = client
         @trace = trace
-        @base_segment = Segment.build(@name, trace)
+        @base_segment_id = base_segment_id
+      end
+
+      # Curretly context object is thread safe, so copying is not necessary,
+      # but in case we need this, offer copy interface for multi threaded
+      # environment.
+      #
+      # client and trace should be imutable and thread-safe.
+      #
+      # See README for example.
+      def copy
+        self.class.new(@name, @client, @trace, @base_segment_id)
       end
 
       # Rescue standard errors and record the error to the segment.
@@ -65,13 +86,18 @@ module Aws
       # @yield [Aws::Xray::Segment]
       # @return [Object] A value which given block returns.
       def base_trace
-        res = yield @base_segment
-        @client.send_segment(@base_segment)
-        res
-      rescue => e
-        @base_segment.set_error(fault: true, e: e)
-        @client.send_segment(@base_segment)
-        raise e
+        base_segment = Segment.build(@name, @trace)
+        @base_segment_id = base_segment.id.freeze
+
+        begin
+          yield base_segment
+        rescue => e
+          base_segment.set_error(fault: true, e: e)
+          raise e
+        ensure
+          base_segment.finish
+          @client.send_segment(base_segment)
+        end
       end
 
       # Rescue standard errors and record the error to the sub segment.
@@ -82,14 +108,18 @@ module Aws
       # @yield [Aws::Xray::SubSegment]
       # @return [Object] A value which given block returns.
       def child_trace(remote:, name:)
-        sub = SubSegment.build(@trace, @base_segment, remote: remote, name: name)
-        res = yield sub
-        @client.send_segment(sub)
-        res
-      rescue => e
-        sub.set_error(fault: true, e: e)
-        @client.send_segment(sub)
-        raise e
+        raise SegmentDidNotStartError unless @base_segment_id
+        sub = SubSegment.build(@trace, @base_segment_id, remote: remote, name: name)
+
+        begin
+          yield sub
+        rescue => e
+          sub.set_error(fault: true, e: e)
+          raise e
+        ensure
+          sub.finish
+          @client.send_segment(sub)
+        end
       end
     end
   end

data/lib/aws/xray/sub_segment.rb

@@ -5,8 +5,8 @@ module Aws
     # http://docs.aws.amazon.com/xray/latest/devguide/xray-api-segmentdocuments.html
     class SubSegment < Segment
       # @param [Boolean] remote
-      def self.build(trace, parent, remote:, name:)
-        new(name: name, trace: trace, parent_id: parent.id, remote: remote)
+      def self.build(trace, parent_id, remote:, name:)
+        new(name: name, trace: trace, parent_id: parent_id, remote: remote)
       end
 
       TYPE_NAME = 'subsegment'.freeze

data/lib/aws/xray/trace.rb

@@ -3,6 +3,7 @@ require 'securerandom'
 
 module Aws
   module Xray
+    # Imutable
     class Trace
       class << self
         def generate(now = Time.now)
@@ -25,9 +26,10 @@ module Aws
       attr_reader :root, :parent
 
       def initialize(root:, sampled: true, parent: nil)
-        @root = root
+        @root = root.freeze
         @sampled = sampled
-        @parent = parent
+        @parent = parent.freeze
+        freeze
       end
 
       def to_header_value
@@ -46,7 +48,7 @@ module Aws
       end
 
       def copy(parent:)
-        self.class.new(root: @root, sampled: @sampled, parent: parent)
+        self.class.new(root: @root.dup, sampled: @sampled, parent: parent.freeze)
       end
     end
   end

data/lib/aws/xray/version.rb

@@ -1,5 +1,5 @@
 module Aws
   module Xray
-    VERSION = '0.11.0'
+    VERSION = '0.12.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-xray
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.12.0
 platform: ruby
 authors:
 - Taiki Ono
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-06-06 00:00:00.000000000 Z
+date: 2017-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday