aws-xray-sdk 0.11.2 → 0.11.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 12bf7fe4479fe58271466a730e04d20a38d125aa
-  data.tar.gz: bd3f3df33fd65ea9f82aa5579316dd8d526d75e2
+SHA256:
+  metadata.gz: cfc85964249b62a758e08922f43b94e994b38b85a0f220177744deb62ed4be1d
+  data.tar.gz: 301d7594d8e1863335108b6904c05a00806830ce2765d8a1ea099271023af0ae
 SHA512:
-  metadata.gz: f515f1e1016a02f04ad8fee38848fd95ed432dad394befc512781cd66d7c26b6bd0191c0a7895f1bc98cd5c864722fe01ed93b536d56557e167c94a81233ff80
-  data.tar.gz: 9527449a4c4aaccb8496bc6ff5d764609a287d986144538f3821576c44989bee3b8982387f1d9afab8d0663c09618c2f0e202c2abbb0343563c918fb2beba690
+  metadata.gz: a4dbd429616dcb4e9b0372c7f4909894ffb0eba783091a89d36e824138703ea9d67fac332fbde372b2774f268b76060d14f66f1d02416e1517c383a44de7fde3
+  data.tar.gz: 19b1591a2bd2ef1afddfd676db64701d73a71253a5f6378366440b708b8e46672d485b89050f6bad31052284724ef47bb8f52f7023c6c5aeb99ca646cd844345

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

@@ -28,4 +28,7 @@ module XRay
 
   class UnsupportedPatchingTargetError < AwsXRaySdkError
   end
+
+  class UnsupportedOperationError < AwsXRaySdkError
+  end
 end

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

@@ -20,8 +20,21 @@ module XRay
         super(*options)
       end
 
+      # HTTP requests to AWS Lambda Ruby Runtime will begin with the
+      # value set in ENV['AWS_LAMBDA_RUNTIME_API']
+      def lambda_runtime_request?(req)
+        ENV['AWS_LAMBDA_RUNTIME_API']  &&
+          req.uri &&
+          req.uri.to_s.start_with?('http://'+ENV['AWS_LAMBDA_RUNTIME_API']+'/')
+      end
+
+      def xray_sampling_request?(req)
+        req.path && (req.path == ('/GetSamplingRules') || req.path == ('/SamplingTargets'))
+      end
+
       def request(req, body = nil, &block)
-        if req.path && (req.path == ('/GetSamplingRules') || req.path == ('/SamplingTargets'))
+        # Do not trace requests to xray or aws lambda runtime
+        if xray_sampling_request?(req) || lambda_runtime_request?(req)
           return super
         end
 

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

@@ -0,0 +1,35 @@
+# AWS Lambda functions should require this file to configure the XRay.recorder
+# for use within the function.
+
+require_relative 'lambda/lambda_recorder'
+require_relative 'lambda/facade_segment'
+require_relative 'lambda/lambda_context'
+require_relative 'lambda/lambda_streamer'
+
+module XRay
+  @recorder = LambdaRecorder.new
+
+  # provide an instance of LambdaRecorder as the global XRay.recorder
+  def self.recorder
+    @recorder
+  end
+end
+
+
+# Set `XRAY_LAMBDA_PATCH_CONFIG` before requiring `aws-xray-sdk/lambda`
+# to configure which libraries (if any) to instrument.
+#
+# By default, both `net_http` and `aws_sdk` will be instrumented
+unless defined? XRAY_LAMBDA_PATCH_CONFIG
+  XRAY_LAMBDA_PATCH_CONFIG = %I[net_http aws_sdk]
+end
+
+# Configure the XRay.recorder with Lambda specific config.
+#
+# From here, a lambda may create subsegments manually, or via
+# the instrumented libraries setup by XRAY_LAMBDA_PATCH_CONFIG
+XRay.recorder.configure(
+  patch: XRAY_LAMBDA_PATCH_CONFIG,
+  context: XRay::LambdaContext.new,
+  streamer: XRay::LambdaStreamer.new
+)

data/lib/aws-xray-sdk/lambda/facade_segment.rb

@@ -0,0 +1,109 @@
+module XRay
+  class FacadeSegment < XRay::Segment
+
+    class ImmutableEmptyCollection
+      def [](key)
+        nil
+      end
+  
+      def []=(k, v)
+        raise UnsupportedOperationError
+      end
+  
+      def update(h)
+        raise UnsupportedOperationError
+      end
+  
+      def to_h
+        {}
+      end
+    end
+
+
+    def initialize(trace_id: nil, name: nil, parent_id: nil, id: nil, sampled: true)
+      super(trace_id: trace_id, name: name, parent_id: parent_id)
+      @id = id
+      @sampled = sampled
+      @empty_collection = ImmutableEmptyCollection.new
+    end
+
+    def ready_to_send?
+      false #never send this facade. AWS Lambda has already created a Segment with these ids
+    end
+
+    #
+    #Methods from Entity that are not supported
+    #
+    def close(end_time: nil)
+      raise UnsupportedOperationError
+    end
+    def apply_status_code(status:)
+      raise UnsupportedOperationError
+    end
+    def merge_http_request(request:)
+      raise UnsupportedOperationError
+    end
+    def merge_http_response(response:)
+      raise UnsupportedOperationError
+    end
+    def add_exception(exception:, remote: false)
+      raise UnsupportedOperationError
+    end
+
+    #
+    # Mutation accessors from Entity that are not supported
+    #
+    def parent=(value)
+      raise UnsupportedOperationError
+    end
+    def throttle=(value)
+      raise UnsupportedOperationError
+    end
+    def error=(value)
+      raise UnsupportedOperationError
+    end
+    def fault=(value)
+      raise UnsupportedOperationError
+    end
+    def sampled=(value)
+      raise UnsupportedOperationError
+    end
+    def aws=(value)
+      raise UnsupportedOperationError
+    end
+    def start_time=(value)
+      raise UnsupportedOperationError
+    end
+    def end_time=(value)
+      raise UnsupportedOperationError
+    end
+
+    #
+    # Mutation accessors from Segment that are not supported
+    #
+    def origin=(value)
+      raise UnsupportedOperationError
+    end
+    def user=(value)
+      raise UnsupportedOperationError
+    end
+    def service=(value)
+      raise UnsupportedOperationError
+    end
+    
+    #
+    # Annotations are read only
+    #
+    def annotations
+      @empty_collection
+    end
+
+    #
+    # Metadata is read only
+    #
+    def metadata(namespace: :default)
+      @empty_collection
+    end
+
+  end
+end

data/lib/aws-xray-sdk/lambda/lambda_context.rb

@@ -0,0 +1,37 @@
+require_relative '../model/trace_header'
+
+module XRay
+  # LambdaContext extends the default context so that
+  # we can provide an appropriate FacadeSegment as the
+  # root context for each function invocation.
+  class LambdaContext < XRay::DefaultContext
+ 
+    TRACE_ID_ENV_VAR = '_X_AMZN_TRACE_ID'.freeze
+
+    def lambda_trace_id
+      ENV[TRACE_ID_ENV_VAR]
+    end
+
+    # If the environment trace id changes, create a new facade for that
+    # segment and make it the context's current entity
+    def check_context
+      #Create a new FacadeSegment if the _X_AMZN_TRACE_ID changes.
+      return if lambda_trace_id == @current_trace_id
+
+      @current_trace_id = lambda_trace_id
+      trace_header = XRay::TraceHeader.from_header_string(header_str: @current_trace_id)
+      segment = FacadeSegment.new(trace_id: trace_header.root,
+        parent_id: trace_header.parent_id,
+        id: trace_header.parent_id,
+        name: 'lambda_context',
+        sampled: trace_header.sampled == 1
+      )
+      store_entity(entity: segment)
+    end
+
+    def current_entity
+      check_context #ensure the FacadeSegment is current whenever the current_entity is retrieved
+      super
+    end
+  end
+end

data/lib/aws-xray-sdk/lambda/lambda_recorder.rb

@@ -0,0 +1,19 @@
+require 'aws-xray-sdk/recorder'
+
+module XRay
+  class LambdaRecorder < Recorder
+    include Logging
+
+    def begin_segment(name, trace_id: nil, parent_id: nil, sampled: nil)
+      # no-op
+      logger.warn('Cannot create segments inside Lambda function. Returning current segment.')
+      return current_segment
+    end
+    
+    def end_segment(end_time: nil)
+      # no-op
+      logger.warn('Cannot end segment inside Lambda function. Ignored.')
+      nil
+    end
+  end
+end

data/lib/aws-xray-sdk/lambda/lambda_streamer.rb

@@ -0,0 +1,9 @@
+module XRay
+  # LambdaStreamer extends DefaultStreamer so that subsegments 
+  # are sent to the XRay endpoint as they are available.
+  class LambdaStreamer < XRay::DefaultStreamer
+    def initialize
+      @stream_threshold = 1 #Stream every subsegment as it is available
+    end
+  end
+end

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

@@ -1,3 +1,3 @@
 module XRay
-  VERSION = '0.11.2'
+  VERSION = '0.11.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-xray-sdk
 version: !ruby/object:Gem::Version
-  version: 0.11.2
+  version: 0.11.3
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-18 00:00:00.000000000 Z
+date: 2019-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-xray
@@ -188,6 +188,11 @@ files:
 - lib/aws-xray-sdk/facets/rails/railtie.rb
 - lib/aws-xray-sdk/facets/resources/aws_params_whitelist.rb
 - lib/aws-xray-sdk/facets/resources/aws_services_whitelist.rb
+- lib/aws-xray-sdk/lambda.rb
+- lib/aws-xray-sdk/lambda/facade_segment.rb
+- lib/aws-xray-sdk/lambda/lambda_context.rb
+- lib/aws-xray-sdk/lambda/lambda_recorder.rb
+- lib/aws-xray-sdk/lambda/lambda_streamer.rb
 - lib/aws-xray-sdk/logger.rb
 - lib/aws-xray-sdk/model/annotations.rb
 - lib/aws-xray-sdk/model/cause.rb
@@ -239,8 +244,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: AWS X-Ray SDK for Ruby