aws-xray-sdk 0.10.2 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f2d9c2d4965cb1d4635d4e6a735f514c67adb2af4dbf26bb8188c162f6c1c0e
-  data.tar.gz: b8dc27fa2569bab52976d702e3d5b1112f29b614038b469defb8959fa6feab69
+  metadata.gz: 91c311c0f94185bc3f4a17afbfde8f7a4f881503feeb7eb116a43631c6649efc
+  data.tar.gz: 4a2791948dc071dfa2e57f410eb60311ff812aa276f0968dfc85db28632a2565
 SHA512:
-  metadata.gz: f63ce08cbdf5d6d913966c3485c4e75b444c8a1866ede982a8e2950b251a05c83b35351c46ff64749ccc4d74f2a6dc9950f10bd23f3a5e6bcf8cefa764ac87ff
-  data.tar.gz: 3a6a2183e526b5dbabe8d36e540cfefe20bc0f93d2ab8da8a77e2c6060bd91b8deda2bf0c93f13f4f5ab286230b509774a08f50059001fa328ab8b095d18e009
+  metadata.gz: 7c9caa633a61621f6c17a281c416855aef63033f8c8119589c0c1bff70218c80f7b84234251f97be5a7cf5b3d39a1d0dc8c54fb8c619ec46c9ab37aabb323bf8
+  data.tar.gz: 42cce4783e4dfa257317a1c3b6bca7fd52e2b4b1521b313048b1c8e1037a9bb85596e2b70a15fca54b15777fc941b380114bf5deec452062a1ea5bc73ac4b4ef

data/lib/aws-xray-sdk/configuration.rb

@@ -2,6 +2,7 @@ require 'aws-xray-sdk/exceptions'
 require 'aws-xray-sdk/patcher'
 require 'aws-xray-sdk/emitter/default_emitter'
 require 'aws-xray-sdk/context/default_context'
+require 'aws-xray-sdk/daemon_config'
 require 'aws-xray-sdk/sampling/default_sampler'
 require 'aws-xray-sdk/streaming/default_streamer'
 require 'aws-xray-sdk/segment_naming/dynamic_naming'
@@ -17,9 +18,9 @@ module XRay
     include Patcher
 
     SEGMENT_NAME_KEY = 'AWS_XRAY_TRACING_NAME'.freeze
-    CONFIG_KEY = %I[logger name sampling plugins daemon_address segment_naming
-                    naming_pattern emitter streamer context context_missing
-                    sampling_rules stream_threshold patch].freeze
+    CONFIG_KEY = %I[logger name sampling plugins daemon_address
+                    segment_naming naming_pattern emitter streamer context
+                    context_missing sampling_rules stream_threshold patch].freeze
 
     def initialize
       @name = ENV[SEGMENT_NAME_KEY]
@@ -38,9 +39,12 @@ module XRay
       @name = ENV[SEGMENT_NAME_KEY] || v
     end
 
-    # proxy method to the emitter's daemon_address config.
+    # setting daemon address for components communicate with X-Ray daemon.
     def daemon_address=(v)
-      emitter.daemon_address = v
+      v = ENV[DaemonConfig::DAEMON_ADDRESS_KEY] || v
+      config = DaemonConfig.new(v)
+      emitter.daemon_config = config
+      sampler.daemon_config = config if sampler.respond_to?(:daemon_config=)
     end
 
     # proxy method to the context's context_missing config.
@@ -63,8 +67,7 @@ module XRay
       segment_naming.pattern = v
     end
 
-    # makes a sampling decision based on internal configure, e.g.
-    #   if sampling enabled and the default sampling rule.
+    # makes a sampling decision without incoming filters.
     def sample?
       return true unless sampling
       sampler.sample?

data/lib/aws-xray-sdk/daemon_config.rb

@@ -0,0 +1,59 @@
+require 'aws-xray-sdk/exceptions'
+
+module XRay
+  # The class that stores X-Ray daemon configuration about
+  # the ip address and port for UDP and TCP port. It gets the address
+  # string from `AWS_XRAY_DAEMON_ADDRESS` and then from recorder's
+  # configuration for `daemon_address`.
+  # A notation of `127.0.0.1:2000` or `tcp:127.0.0.1:2000 udp:127.0.0.2:2001`
+  # are both acceptable. The former one means UDP and TCP are running at
+  # the same address. By default it assumes a X-Ray daemon
+  # running at `127.0.0.1:2000` listening to both UDP and TCP traffic.
+  class DaemonConfig
+    DAEMON_ADDRESS_KEY = 'AWS_XRAY_DAEMON_ADDRESS'.freeze
+    attr_reader :tcp_ip, :tcp_port, :udp_ip, :udp_port
+    @@dafault_addr = '127.0.0.1:2000'
+
+    def initialize(addr: @@dafault_addr)
+      update_address(addr)
+    end
+
+    def update_address(v)
+      v = ENV[DAEMON_ADDRESS_KEY] || v
+      update_addr(v)
+    rescue StandardError
+      raise InvalidDaemonAddressError, %(Invalid X-Ray daemon address specified: #{v}.)
+    end
+
+    private
+
+    def update_addr(v)
+      parts = v.split(' ')
+      if parts.length == 1 # format of '127.0.0.1:2000'
+        addr = parts[0].split(':')
+        raise InvalidDaemonAddressError unless addr.length == 2
+        @tcp_ip = addr[0]
+        @tcp_port = addr[1].to_i
+        @udp_ip = addr[0]
+        @udp_port = addr[1].to_i
+      else
+        set_tcp_udp(parts) # format of 'tcp:127.0.0.1:2000 udp:127.0.0.2:2001'
+      end
+    end
+
+    def set_tcp_udp(parts)
+      part1 = parts[0]
+      part2 = parts[1]
+      key1 = part1.split(':')[0]
+      key2 = part2.split(':')[0]
+      addr_h = {}
+      addr_h[key1] = part1.split(':')
+      addr_h[key2] = part2.split(':')
+
+      @tcp_ip = addr_h['tcp'][1]
+      @tcp_port = addr_h['tcp'][2].to_i
+      @udp_ip = addr_h['udp'][1]
+      @udp_port = addr_h['udp'][2].to_i
+    end
+  end
+end

data/lib/aws-xray-sdk/emitter/default_emitter.rb

@@ -2,6 +2,7 @@ require 'socket'
 require 'aws-xray-sdk/logger'
 require 'aws-xray-sdk/emitter/emitter'
 require 'aws-xray-sdk/exceptions'
+require 'aws-xray-sdk/daemon_config'
 
 module XRay
   # The default emitter the X-Ray recorder uses to send segments/subsegments
@@ -10,12 +11,11 @@ module XRay
     include Emitter
     include Logging
 
-    attr_reader :address
+    attr_reader :daemon_config
 
-    def initialize
+    def initialize(daemon_config: DaemonConfig.new)
       @socket = UDPSocket.new
-      @address = ENV[DAEMON_ADDRESS_KEY] || '127.0.0.1:2000'
-      configure_socket(@address)
+      self.daemon_config = daemon_config
     end
 
     # Serializes a segment/subsegment and sends it to the X-Ray daemon
@@ -25,29 +25,18 @@ module XRay
       return nil unless entity.sampled
       begin
         payload = %(#{@@protocol_header}#{@@protocol_delimiter}#{entity.to_json})
-        logger.debug %(sending payload #{payload} to daemon at #{address}.)
+        logger.debug %(sending payload #{payload} to daemon at #{@address}.)
         @socket.send payload, 0
       rescue StandardError => e
         logger.warn %(failed to send payload due to #{e.message})
       end
     end
 
-    def daemon_address=(v)
-      v = ENV[DAEMON_ADDRESS_KEY] || v
-      @address = v
-      configure_socket(v)
-    end
-
-    private
-
-    def configure_socket(v)
-      begin
-        addr = v.split(':')
-        host, ip = addr[0], addr[1].to_i
-        @socket.connect(host, ip)
-      rescue StandardError
-        raise InvalidDaemonAddressError, %(Invalid X-Ray daemon address specified: #{v}.)
-      end
+    def daemon_config=(v)
+      @address = %(#{v.udp_ip}:#{v.udp_port})
+      @socket.connect(v.udp_ip, v.udp_port)
+    rescue StandardError
+      raise InvalidDaemonAddressError, %(Invalid X-Ray daemon address specified: #{v}.)
     end
   end
 end

data/lib/aws-xray-sdk/emitter/emitter.rb

@@ -4,8 +4,6 @@ module XRay
   # The emitter interface the X-Ray recorder uses to send segments/subsegments
   # to the X-Ray daemon over UDP.
   module Emitter
-    DAEMON_ADDRESS_KEY = 'AWS_XRAY_DAEMON_ADDRESS'.freeze
-
     @@protocol_header = {
       format:   'json',
       version:  1
@@ -17,7 +15,7 @@ module XRay
       raise 'Not implemented'
     end
 
-    def daemon_address=(v)
+    def daemon_config=(v)
       raise 'Not implemented'
     end
   end

data/lib/aws-xray-sdk/facets/aws_sdk.rb

@@ -17,15 +17,19 @@ module XRay
       include XRay::Facets::Helper
 
       def call(context)
-        recorder = Aws.config[:xray_recorder]
-        if recorder.current_entity.nil?
-          super
-        end
-
         operation = context.operation_name
         service_name = context.client.class.api.metadata['serviceAbbreviation'] ||
                        context.client.class.to_s.split('::')[1]
-        recorder.capture service_name, namespace: 'aws' do |subsegment|
+        if skip?(service_name, operation)
+          return super
+        end
+
+        recorder = Aws.config[:xray_recorder]
+        if recorder.nil? || recorder.current_entity.nil?
+          return super
+        end
+
+        recorder.capture(service_name, namespace: 'aws') do |subsegment|
           # inject header string before calling downstream AWS services
           context.http_request.headers[TRACE_HEADER] = prep_header_str entity: subsegment
           response = @handler.call(context)
@@ -109,6 +113,10 @@ module XRay
         v = target.keys if descriptor[:get_keys]
         meta[descriptor[:rename_to]] = v
       end
+
+      def skip?(service, op)
+        return service == 'XRay' && (op == :get_sampling_rules || op == :get_sampling_targets)
+      end
     end
   end
 

data/lib/aws-xray-sdk/facets/helper.rb

@@ -26,21 +26,14 @@ module XRay
       # the highest precedence. If the `trace_header` doesn't contain
       # sampling decision then it checks if sampling is enabled or not
       # in the recorder. If not enbaled it returns 'true'. Otherwise it uses
-      # sampling rule to decide.
-      def should_sample?(header_obj:, recorder:,
-                         host: nil, method: nil, path: nil,
-                         **args)
+      # sampling rules to decide.
+      def should_sample?(header_obj:, recorder:, sampling_req:, **args)
         # check outside decision
         if i = header_obj.sampled
-          if i.zero?
-            false
-          else
-            true
-          end
+          !i.zero?
         # check sampling rules
         elsif recorder.sampling_enabled?
-          recorder.sampler.sample_request?(service_name: host, url_path: path,
-                                           http_method: method)
+          recorder.sampler.sample_request?(sampling_req)
         # sample if no reason not to
         else
           true

data/lib/aws-xray-sdk/facets/net_http.rb

@@ -21,6 +21,10 @@ module XRay
       end
 
       def request(req, body = nil, &block)
+        if req.path && (req.path == ('/GetSamplingRules') || req.path == ('/SamplingTargets'))
+          return super
+        end
+
         entity = XRay.recorder.current_entity
         capture = !(entity && entity.namespace && entity.namespace == 'aws'.freeze)
         if started? && capture && entity

data/lib/aws-xray-sdk/facets/rack.rb

@@ -8,6 +8,7 @@ module XRay
     class Middleware
       include XRay::Facets::Helper
       X_FORWARD = 'HTTP_X_FORWARDED_FOR'.freeze
+      SCHEME_SEPARATOR = "://".freeze
 
       def initialize(app, recorder: nil)
         @app = app
@@ -22,16 +23,15 @@ module XRay
         host = req.host
         url_path = req.path
         method = req.request_method
+        # get segment name from host header if applicable
+        seg_name = @recorder.segment_naming.provide_name(host: req.host)
 
         # get sampling decision
         sampled = should_sample?(
-          header_obj: header, recorder: @recorder,
-          host: host, method: method, path: url_path
+          header_obj: header, recorder: @recorder, sampling_req:
+          { host: host, http_method: method, url_path: url_path, service: seg_name }
         )
 
-        # get segment name from host header if applicable
-        seg_name = @recorder.segment_naming.provide_name(host: req.host)
-
         # begin the segment
         segment = @recorder.begin_segment seg_name, trace_id: header.root, parent_id: header.parent_id,
                                                     sampled: sampled
@@ -63,7 +63,9 @@ module XRay
 
       def extract_request_meta(req)
         req_meta = {}
-        req_meta[:url] = req.url if req.url
+        req_meta[:url] = req.scheme + SCHEME_SEPARATOR if req.scheme
+        req_meta[:url] += req.host_with_port if req.host_with_port
+        req_meta[:url] += req.path if req.path
         req_meta[:user_agent] = req.user_agent if req.user_agent
         req_meta[:method] = req.request_method if req.request_method
         if req.has_header?(X_FORWARD)

data/lib/aws-xray-sdk/facets/rails/railtie.rb

@@ -6,7 +6,7 @@ module XRay
   class Railtie < ::Rails::Railtie
     RAILS_OPTIONS = %I[active_record].freeze
 
-    initializer "aws-xray-sdk.rack_middleware" do |app|
+    initializer("aws-xray-sdk.rack_middleware") do |app|
       app.middleware.insert 0, Rack::Middleware
       app.middleware.use XRay::Rails::ExceptionMiddleware
     end

data/lib/aws-xray-sdk/model/cause.rb

@@ -1,4 +1,4 @@
-require 'oj'
+require 'multi_json'
 
 module XRay
   # Represents cause section in segment and subsegment document.
@@ -26,7 +26,7 @@ module XRay
 
     def to_json
       @to_json ||= begin
-        Oj.dump to_h, mode: :compat, use_as_json: true
+        MultiJson.dump to_h
       end
     end
 

data/lib/aws-xray-sdk/model/dummy_entities.rb

@@ -38,6 +38,10 @@ module XRay
       # no-op
     end
 
+    def sampling_rule_name=(v)
+      # no-op
+    end
+
     def to_h
       # no-op
     end

data/lib/aws-xray-sdk/model/entity.rb

@@ -1,6 +1,6 @@
 require 'securerandom'
 require 'bigdecimal'
-require 'oj'
+require 'multi_json'
 require 'aws-xray-sdk/exceptions'
 require 'aws-xray-sdk/model/cause'
 require 'aws-xray-sdk/model/annotations'
@@ -168,7 +168,7 @@ module XRay
 
     def to_json
       @to_json ||= begin
-        Oj.dump to_h, mode: :compat, use_as_json: true
+        MultiJson.dump(to_h)
       end
     end
 

data/lib/aws-xray-sdk/model/metadata.rb

@@ -1,4 +1,4 @@
-require 'oj'
+require 'multi_json'
 require 'aws-xray-sdk/exceptions'
 
 module XRay
@@ -48,7 +48,7 @@ module XRay
 
     def to_json
       @to_json ||= begin
-        Oj.dump to_h, mode: :compat, use_as_json: true
+        MultiJson.dump to_h
       end
     end
   end

data/lib/aws-xray-sdk/model/segment.rb

@@ -6,7 +6,8 @@ module XRay
   # details about the request, and details about the work done.
   class Segment
     include Entity
-    attr_accessor :ref_counter, :subsegment_size, :origin, :user, :service
+    attr_accessor :ref_counter, :subsegment_size, :origin,
+                  :user, :service
 
     # @param [String] trace_id Manually crafted trace id.
     # @param [String] name Must be specified either on object creation or
@@ -39,6 +40,12 @@ module XRay
       @subsegment_size = subsegment_size - subsegment.all_children_count - 1
     end
 
+    def sampling_rule_name=(v)
+      @aws ||= {}
+      @aws[:xray] ||= {}
+      @aws[:xray][:sampling_rule_name] = v
+    end
+
     def decrement_ref_counter
       @ref_counter -= 1
     end

data/lib/aws-xray-sdk/plugins/elastic_beanstalk.rb

@@ -1,4 +1,4 @@
-require 'oj'
+require 'multi_json'
 require 'aws-xray-sdk/logger'
 
 module XRay
@@ -14,7 +14,7 @@ module XRay
       def self.aws
         @@aws ||= begin
           file = File.open(CONF_PATH)
-          { elastic_beanstalk: Oj.load(file) }
+          { elastic_beanstalk: MultiJson.load(file) }
         rescue StandardError => e
           @@aws = {}
           Logging.logger.warn %(can not get the environment config due to: #{e.message}.)

data/lib/aws-xray-sdk/recorder.rb

@@ -12,11 +12,12 @@ module XRay
   # and send them to the X-Ray daemon. It is also responsible for managing
   # context.
   class Recorder
-    attr_reader :config
+    attr_reader :config, :origin
 
     def initialize(user_config: nil)
       @config = Configuration.new
       @config.configure(user_config) unless user_config.nil?
+      @origin = nil
     end
 
     # Begin a segment for the current context. The recorder
@@ -31,7 +32,7 @@ module XRay
       sample = sampled.nil? ? config.sample? : sampled
       if sample
         segment = Segment.new name: seg_name, trace_id: trace_id, parent_id: parent_id
-        populate_runtime_context(segment)
+        populate_runtime_context(segment, sample)
       else
         segment = DummySegment.new name: seg_name, trace_id: trace_id, parent_id: parent_id
       end
@@ -204,14 +205,14 @@ module XRay
 
     private_class_method
 
-    def populate_runtime_context(segment)
+    def populate_runtime_context(segment, sample)
       @aws ||= begin
         aws = {}
         config.plugins.each do |p|
           meta = p.aws
           if meta.is_a?(Hash) && !meta.empty?
             aws.merge! meta
-            segment.origin = p::ORIGIN
+            @origin = p::ORIGIN
           end
         end
         xray_meta = { xray:
@@ -230,6 +231,8 @@ module XRay
 
       segment.aws = @aws
       segment.service = @service
+      segment.origin = @origin
+      segment.sampling_rule_name = sample if sample.is_a?(String)
     end
   end
 end