aws-xray 0.19.0 → 0.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0e6c60e80dd24f95f4ba376e17d0dfc54d3fafe1
-  data.tar.gz: 9caf21ace8870af635fde50847dcab42ec1354f8
+  metadata.gz: 7791521140cd959a8955511da8c84bc1adcbc3a4
+  data.tar.gz: dad29f16af29cc23eb0f5e156d7a58e8a4fd8154
 SHA512:
-  metadata.gz: e7d452cb872b1d0b35db19e3cc0c0ca7ae71bfea3f9254bb4780cc47d2393abaa5c4d6d335cdc1fcfa1297fcfb91e582c35b58b84b3c581125ee5d49d72dbc0c
-  data.tar.gz: 3c67908acd4f9124766718c0613f6d114eb38e842c79b5aee68e0fa65c1f5d9956a5130e09adbbebb40854330ee3c54079fd4b7a46a11f3be28717edb12fade3
+  metadata.gz: d7b21c857fc027e6aa601cf7de7179771e04d8e5d412feda876ebffec9a38c97f4082381272b7ed77795554f512adf1ef9eb1338345662d088631e8d28c0f5aa
+  data.tar.gz: 75b452f39bd6d993b86d2bb3c25b26a3ae7e6bf1590dcfe58d5a2b2b825a8b0eb02099f7d50c4892bd2fdc4c111cb24e2f9b7d2e11a63491a3092036fb60be39

data/lib/aws/xray.rb

@@ -26,8 +26,7 @@ module Aws
     # @param [String] name a logical name of this tracing context.
     def self.trace(name: nil)
       name = name || config.name || raise(MissingNameError)
-      client = Client.new(Aws::Xray.config.client_options)
-      Context.with_new_context(name, client, Trace.generate) do
+      Context.with_new_context(name, Trace.generate) do
         Context.current.base_trace do |seg|
           yield seg
         end

data/lib/aws/xray/client.rb

@@ -5,58 +5,51 @@ module Aws
     # Own the responsibility of holding destination address and sending
     # segments.
     class Client
-      # sock is for test.
-      def initialize(host: nil, port: nil, sock: nil)
-        @host, @port = host, port
-        @sock = sock
-      end
-
-      def copy
-        self.class.new(host: @host ? @host.dup : nil, port: @port, sock: @sock)
-      end
+      class << self
+        # @param [Aws::Xray::Segment] segment
+        def send_segment(segment)
+          Aws::Xray.config.logger.debug("#{Thread.current}: Client.send_segment started")
+          payload = %!{"format": "json", "version": 1}\n#{segment.to_json}\n!
 
-      # When UDPSocket#send can not send all bytes, just give up it.
-      # @param [Aws::Xray::Segment] segment
-      def send_segment(segment)
-        Aws::Xray.config.logger.debug("#{Thread.current}: Client#send_segment started")
-        payload = %!{"format": "json", "version": 1}\n#{segment.to_json}\n!
-
-        begin
-          if @sock # test env or not aws-xray is not enabled
-            send_payload(payload)
-            Aws::Xray.config.logger.debug("#{Thread.current}: Client#send_segment called #send_payload in the same thread")
-          else # production env
-            Worker.post(payload, self.copy)
-            Aws::Xray.config.logger.debug("#{Thread.current}: Client#send_segment posted a job to worker")
-          end
-        rescue QueueIsFullError => e
           begin
-            Aws::Xray.config.segment_sending_error_handler.call(e, payload, host: @host, port: @port)
-          rescue Exception => e
-            $stderr.puts("Error handler `#{Aws::Xray.config.segment_sending_error_handler}` raised an error: #{e}\n#{e.backtrace.join("\n")}")
+            if Aws::Xray.config.client_options[:sock] # test env or not aws-xray is not enabled
+              send_payload(payload)
+              Aws::Xray.config.logger.debug("#{Thread.current}: Client.send_segment called #send_payload in the same thread")
+            else # production env
+              Worker.post(payload)
+              Aws::Xray.config.logger.debug("#{Thread.current}: Client.send_segment posted a job to worker")
+            end
+          rescue QueueIsFullError => e
+            begin
+              host, port = Aws::Xray.config.client_options[:host], Aws::Xray.config.client_options[:port]
+              Aws::Xray.config.segment_sending_error_handler.call(e, payload, host: host, port: port)
+            rescue Exception => e
+              $stderr.puts("Error handler `#{Aws::Xray.config.segment_sending_error_handler}` raised an error: #{e}\n#{e.backtrace.join("\n")}")
+            end
           end
         end
-      end
 
-      # Will be called in other threads.
-      # @param [String] payload
-      def send_payload(payload)
-        Aws::Xray.config.logger.debug("#{Thread.current}: Client#send_payload")
-        sock = @sock || UDPSocket.new
+        # Will be called in other threads.
+        # @param [String] payload
+        def send_payload(payload)
+          Aws::Xray.config.logger.debug("#{Thread.current}: Client#send_payload")
+          sock = Aws::Xray.config.client_options[:sock] || UDPSocket.new
+          host, port = Aws::Xray.config.client_options[:host], Aws::Xray.config.client_options[:port]
 
-        begin
-          len = sock.send(payload, Socket::MSG_DONTWAIT, @host, @port)
-          raise CanNotSendAllByteError.new(payload.size, len) if payload.size != len
-          Aws::Xray.config.logger.debug("#{Thread.current}: Client#send_payload successfully sent payload, len=#{len}")
-          len
-        rescue SystemCallError, SocketError, CanNotSendAllByteError => e
           begin
-            Aws::Xray.config.segment_sending_error_handler.call(e, payload, host: @host, port: @port)
-          rescue Exception => e
-            $stderr.puts("Error handler `#{Aws::Xray.config.segment_sending_error_handler}` raised an error: #{e}\n#{e.backtrace.join("\n")}")
+            len = sock.send(payload, Socket::MSG_DONTWAIT, host, port)
+            raise CanNotSendAllByteError.new(payload.size, len) if payload.size != len
+            Aws::Xray.config.logger.debug("#{Thread.current}: Client#send_payload successfully sent payload, len=#{len}")
+            len
+          rescue SystemCallError, SocketError, CanNotSendAllByteError => e
+            begin
+              Aws::Xray.config.segment_sending_error_handler.call(e, payload, host: host, port: port)
+            rescue Exception => e
+              $stderr.puts("Error handler `#{Aws::Xray.config.segment_sending_error_handler}` raised an error: #{e}\n#{e.backtrace.join("\n")}")
+            end
+          ensure
+            sock.close
           end
-        ensure
-          sock.close
         end
       end
     end

data/lib/aws/xray/configuration.rb

@@ -7,21 +7,22 @@ module Aws
   module Xray
     # thread-unsafe, suppose to be used only in initialization phase.
     class Configuration
-      def initialize
-        @logger = ::Logger.new($stdout).tap {|l| l.level = Logger::INFO }
-      end
+      # Freeze to force users to set default annotation with writer method.
+      DEFAULT_ANNOTATION = {
+        hostname: Socket.gethostname,
+      }.freeze
 
-      # @return [String] name Logical service name for this application.
-      def name
-        @name ||= ENV['AWS_XRAY_NAME']
-      end
-      attr_writer :name
+      DEFAULT_METADATA = {
+        tracing_sdk: {
+          name: 'aws-xray',
+          version: Aws::Xray::VERSION,
+        }
+      }.freeze
 
-      # @return [Hash] client_options For xray-agent client.
-      #   - host: e.g. '127.0.0.1'
-      #   - port: e.g. 2000
-      def client_options
-        @client_options ||=
+      def initialize
+        @logger = ::Logger.new($stdout).tap {|l| l.level = Logger::INFO }
+        @name = ENV['AWS_XRAY_NAME']
+        @client_options =
           begin
             option = (ENV['AWS_XRAY_LOCATION'] || '').split(':')
             host = option[0]
@@ -32,60 +33,54 @@ module Aws
               { sock: NullSocket.new }
             end
           end
+        @excluded_paths = (ENV['AWS_XRAY_EXCLUDED_PATHS'] || '').split(',')
+        @version = VersionDetector.new.call
+        @default_annotation = DEFAULT_ANNOTATION
+        @default_metadata = DEFAULT_METADATA
+        @segment_sending_error_handler = DefaultErrorHandler.new($stderr)
+        @worker = Aws::Xray::Worker::Configuration.new
+        @sampling_rate = Float(ENV['AWS_XRAY_SAMPLING_RATE'] || 0.001)
       end
-      attr_writer :client_options
 
+      # @param [String] name Logical service name for this application.
+      # @return [String]
+      attr_accessor :name
+
+      # @param [Hash] client_options For xray-agent client.
+      #   - host: e.g. '127.0.0.1'
+      #   - port: e.g. 2000
+      # @return [Hash]
+      attr_accessor :client_options
+
+      # @param [Array<String>] excluded_paths
       # @return [Array<String>]
-      def excluded_paths
-        @excluded_paths ||= (ENV['AWS_XRAY_EXCLUDED_PATHS'] || '').split(',')
-      end
-      attr_writer :excluded_paths
+      attr_accessor :excluded_paths
 
       # @return [String]
-      def version
-        @version ||= VersionDetector.new.call
-      end
+      attr_reader :version
       # @param [String,Proc] version A String or callable object which returns application version.
       #   Default version detection tries to solve with `app_root/REVISION` file.
       def version=(v)
         @version = v.respond_to?(:call) ? v.call : v
       end
 
-      DEFAULT_ANNOTATION = {
-        hostname: Socket.gethostname,
-      }.freeze
-      # @return [Hash] default annotation with key-value format.
-      def default_annotation
-        @default_annotation ||= DEFAULT_ANNOTATION
-      end
-      # @param [Hash] h default annotation Hash.
+      # @return [Hash]
+      attr_reader :default_annotation
+      # @param [Hash] annotation annotation with key-value format. keys and
+      #   values are automatically normalized according to X-Ray's format spec.
       def default_annotation=(annotation)
         @default_annotation = AnnotationNormalizer.call(annotation)
       end
 
-      DEFAULT_METADATA = {
-        tracing_sdk: {
-          name: 'aws-xray',
-          version: Aws::Xray::VERSION,
-        }
-      }.freeze
-      # @return [Hash] Default metadata.
-      def default_metadata
-        @default_metadata ||= DEFAULT_METADATA
-      end
-      # @param [Hash] metadata Default metadata.
-      attr_writer :default_metadata
+      # @param [Hash] default_metadatametadata Default metadata.
+      # @return [Hash]
+      attr_accessor :default_metadata
 
-      def segment_sending_error_handler
-        @segment_sending_error_handler ||= DefaultErrorHandler.new($stderr)
-      end
       # @param [Proc] segment_sending_error_handler Callable object
-      attr_writer :segment_sending_error_handler
+      attr_accessor :segment_sending_error_handler
 
       # @return [Aws::Xray::Worker::Configuration]
-      def worker
-        @worker ||= Aws::Xray::Worker::Configuration.new
-      end
+      attr_reader :worker
       # Set given configuration and reset workers according to the given
       # configuration.
       # @param [Aws::Xray::Worker::Configuration] conf
@@ -96,12 +91,9 @@ module Aws
       end
 
       # Default is 0.1%.
-      # @return [Float]
-      def sampling_rate
-        @sampling_rate ||= Float(ENV['AWS_XRAY_SAMPLING_RATE'] || 0.001)
-      end
       # @param [Float] sampling_rate
-      attr_writer :sampling_rate
+      # @return [Float]
+      attr_accessor :sampling_rate
 
       # @param [Logger] logger
       # @return [Logger]

data/lib/aws/xray/context.rb

@@ -1,5 +1,5 @@
 require 'aws/xray/segment'
-require 'aws/xray/sub_segment'
+require 'aws/xray/subsegment'
 
 module Aws
   module Xray
@@ -26,12 +26,11 @@ module Aws
         end
 
         # @param [String] name logical name of this tracing context.
-        # @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.
-        def with_new_context(name, client, trace)
-          build_current(name, client, trace)
+        def with_new_context(name, trace)
+          build_current(name, trace)
           yield
         ensure
           remove_current
@@ -39,8 +38,8 @@ module Aws
 
         private
 
-        def build_current(name, client, trace)
-          Thread.current.thread_variable_set(VAR_NAME, Context.new(name, client, trace))
+        def build_current(name, trace)
+          Thread.current.thread_variable_set(VAR_NAME, Context.new(name, trace))
         end
 
         def remove_current
@@ -50,26 +49,24 @@ module Aws
 
       attr_reader :name
 
-      # client and trace are frozen by default.
-      def initialize(name, client, trace, base_segment_id = nil)
+      def initialize(name, trace, base_segment_id = nil)
         raise 'name is required' unless name
         @name = name
-        @client = client
         @trace = trace
         @base_segment_id = base_segment_id
         @disabled_ids = []
-        @sub_segment_name = nil
+        @subsegment_name = nil
       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.
+      # Trace should be imutable and thread-safe.
       #
       # See README for example.
       def copy
-        self.class.new(@name.dup, @client.copy, @trace.copy, @base_segment_id ? @base_segment_id.dup : nil)
+        self.class.new(@name.dup, @trace.copy, @base_segment_id ? @base_segment_id.dup : nil)
       end
 
       # Rescue all exceptions and record the exception to the segment.
@@ -88,17 +85,17 @@ module Aws
           raise e
         ensure
           base_segment.finish
-          @client.send_segment(base_segment) if @trace.sampled?
+          Client.send_segment(base_segment) if @trace.sampled?
         end
       end
 
       # @param [Boolean] remote
       # @param [String] name Arbitrary name of the sub segment. e.g. "funccall_f".
-      # @yield [Aws::Xray::SubSegment]
+      # @yield [Aws::Xray::Subsegment]
       # @return [Object] A value which given block returns.
       def child_trace(remote:, name:)
         raise SegmentDidNotStartError unless @base_segment_id
-        sub = SubSegment.build(@trace, @base_segment_id, remote: remote, name: overwrite_name(name))
+        sub = Subsegment.build(@trace, @base_segment_id, remote: remote, name: overwrite_name(name))
 
         begin
           yield sub
@@ -107,7 +104,7 @@ module Aws
           raise e
         ensure
           sub.finish
-          @client.send_segment(sub) if @trace.sampled?
+          Client.send_segment(sub) if @trace.sampled?
         end
       end
 
@@ -135,22 +132,22 @@ module Aws
       #
       # @param [String] name
       def overwrite(name:)
-        @sub_segment_name = name.to_s
+        @subsegment_name = name.to_s
 
         begin
           yield
         ensure
-          @sub_segment_name = nil
+          @subsegment_name = nil
         end
       end
 
       private
 
       def overwrite_name(name)
-        return name unless @sub_segment_name
+        return name unless @subsegment_name
 
-        name = @sub_segment_name
-        @sub_segment_name = nil
+        name = @subsegment_name
+        @subsegment_name = nil
         name
       end
     end

data/lib/aws/xray/rack.rb

@@ -4,15 +4,10 @@ module Aws
       TRACE_ENV = 'HTTP_X_AMZN_TRACE_ID'.freeze
       ORIGINAL_TRACE_ENV = 'HTTP_X_AMZN_TRACE_ID_ORIGINAL'.freeze
 
-      # @param  [Hash] client_options For xray-agent client.
-      #   - host: e.g. '127.0.0.1'
-      #   - port: e.g. 2000
-      #   - sock: test purpose.
       # @param [Array<String,Regexp>] excluded_paths for health-check endpoints etc...
-      def initialize(app, client_options: {}, excluded_paths: [])
+      def initialize(app, excluded_paths: [])
         @app = app
         @name = Aws::Xray.config.name || raise(MissingNameError)
-        @client = Client.new(Aws::Xray.config.client_options.merge(client_options))
         @excluded_paths = excluded_paths + Aws::Xray.config.excluded_paths
       end
 
@@ -31,7 +26,7 @@ module Aws
         env[ORIGINAL_TRACE_ENV] = env[TRACE_ENV] if env[TRACE_ENV] # just for the record
         env[TRACE_ENV] = trace.to_header_value
 
-        Context.with_new_context(@name, @client, trace) do
+        Context.with_new_context(@name, trace) do
           Context.current.base_trace do |seg|
             seg.set_http_request(Request.build_from_rack_env(env))
             status, headers, body = @app.call(env)

data/lib/aws/xray/segment.rb

@@ -108,7 +108,7 @@ module Aws
         end
         if @http_request
           request_hash = @http_request.to_h
-          # traced is SubSegment only
+          # traced is Subsegment only
           request_hash.delete(:traced)
           h[:http] = { request:  request_hash }
         end

data/lib/aws/xray/{sub_segment.rb → subsegment.rb}

@@ -3,7 +3,7 @@ require 'aws/xray/segment'
 module Aws
   module Xray
     # http://docs.aws.amazon.com/xray/latest/devguide/xray-api-segmentdocuments.html
-    class SubSegment < Segment
+    class Subsegment < Segment
       # @param [Boolean] remote
       def self.build(trace, parent_id, remote:, name:)
         new(name: name, trace: trace, parent_id: parent_id, remote: remote)

data/lib/aws/xray/version.rb

@@ -1,5 +1,5 @@
 module Aws
   module Xray
-    VERSION = '0.19.0'
+    VERSION = '0.20.0'
   end
 end

data/lib/aws/xray/worker.rb

@@ -10,19 +10,16 @@ module Aws
         end
       end
 
-      class Item < Struct.new(:payload, :client)
-      end
-
       @post_lock = ::Mutex.new
       @pid = $$
       class << self
         # @param [String] payload to send
         # @param [Aws::Xray::Client] client
-        def post(payload, client)
+        def post(payload)
           Aws::Xray.config.logger.debug("#{Thread.current}: Worker.post received a job")
           @post_lock.synchronize do
             refresh_if_forked
-            @queue.push(Item.new(payload, client.copy))
+            @queue.push(payload)
           end
           Aws::Xray.config.logger.debug("#{Thread.current}: Worker.post pushed a job")
         rescue ThreadError => e
@@ -54,10 +51,10 @@ module Aws
         th = Thread.new(@queue) do |queue|
           loop do
             Aws::Xray.config.logger.debug("#{Thread.current}: Worker#run waits a job")
-            item = queue.pop
+            payload = queue.pop
             Aws::Xray.config.logger.debug("#{Thread.current}: Worker#run received a job")
-            if item.is_a?(Item)
-              item.client.send_payload(item.payload)
+            if payload
+              Client.send_payload(payload.to_s)
               Aws::Xray.config.logger.debug("#{Thread.current}: Worker#run sent a payload")
             else
               Aws::Xray.config.logger.debug("#{Thread.current}: Worker#run received invalid item, ignored it")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aws-xray
 version: !ruby/object:Gem::Version
-  version: 0.19.0
+  version: 0.20.0
 platform: ruby
 authors:
 - Taiki Ono
@@ -196,7 +196,7 @@ files:
 - lib/aws/xray/response.rb
 - lib/aws/xray/segment.rb
 - lib/aws/xray/sockets.rb
-- lib/aws/xray/sub_segment.rb
+- lib/aws/xray/subsegment.rb
 - lib/aws/xray/trace.rb
 - lib/aws/xray/version.rb
 - lib/aws/xray/version_detector.rb