aws-xray-sdk 0.11.3 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cfc85964249b62a758e08922f43b94e994b38b85a0f220177744deb62ed4be1d
-  data.tar.gz: 301d7594d8e1863335108b6904c05a00806830ce2765d8a1ea099271023af0ae
+  metadata.gz: 7519a013ac4db9cf9536638f8abc1d77dc71c4a7edbb5dbc2b43bfc6f1ab3296
+  data.tar.gz: 58567280e37b1e041720d7cf1c86f1b55d38e992a2e6f19444950bc491d2ef7a
 SHA512:
-  metadata.gz: a4dbd429616dcb4e9b0372c7f4909894ffb0eba783091a89d36e824138703ea9d67fac332fbde372b2774f268b76060d14f66f1d02416e1517c383a44de7fde3
-  data.tar.gz: 19b1591a2bd2ef1afddfd676db64701d73a71253a5f6378366440b708b8e46672d485b89050f6bad31052284724ef47bb8f52f7023c6c5aeb99ca646cd844345
+  metadata.gz: 38640d9e8aa2bf1f2328b26670878056713e9e916934ade89ca4ef1132b998f3544b89e01ae3fa7ab619582e2db4487719dd132228c9a51273e7bc27e91cca06
+  data.tar.gz: b8d0aa1b3f0bc098cdd32e4f61ab810b4c1beee48aec785481edaf365c74174eda5a136e271b5b37c5aaed8ae6f8a74daeb2191f220d381520fe4ac6352fc03d

data/lib/aws-xray-sdk/context/default_context.rb

@@ -57,7 +57,7 @@ module XRay
       when 'RUNTIME_ERROR'
         raise ContextMissingError
       when 'LOG_ERROR'
-        logger.error %(can not find the current context.)
+        logger.error %(cannot find the current context.)
       end
       nil
     end

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

@@ -10,7 +10,7 @@ module XRay
 
   class ContextMissingError < AwsXRaySdkError
     def initialize
-      super('Can not find any active segment or subsegment.')
+      super('Cannot find any active segment or subsegment.')
     end
   end
 

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

@@ -1,7 +1,7 @@
 require 'aws-sdk-core'
 require 'aws-xray-sdk/facets/helper'
-require 'aws-xray-sdk/facets/resources/aws_params_whitelist'
-require 'aws-xray-sdk/facets/resources/aws_services_whitelist'
+require 'aws-xray-sdk/facets/resources/aws_params_allowlist'
+require 'aws-xray-sdk/facets/resources/aws_services_allowlist'
 
 module XRay
   class AwsSDKPlugin < Seahorse::Client::Plugin

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

@@ -2,7 +2,7 @@ require 'aws-xray-sdk/model/trace_header'
 
 module XRay
   module Facets
-    # Hepler functions shared for all external frameworks/libraries
+    # Helper functions shared for all external frameworks/libraries
     # like make sampling decisions from incoming http requests etc.
     module Helper
       TRACE_HEADER = 'X-Amzn-Trace-Id'.freeze

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

@@ -20,21 +20,26 @@ 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']+'/')
+      # HTTP requests to AWS Lambda Ruby Runtime will have the address and port
+      # matching the value set in ENV['AWS_LAMBDA_RUNTIME_API']
+      def lambda_runtime_request?
+        ENV['AWS_LAMBDA_RUNTIME_API'] == "#{address}:#{port}"
       end
 
       def xray_sampling_request?(req)
         req.path && (req.path == ('/GetSamplingRules') || req.path == ('/SamplingTargets'))
       end
+      
+      # HTTP requests to IMDS endpoint will be made to 169.254.169.254
+      # for both IMDSv1 and IMDSv2 with the latter including the 
+      # X-aws-ec2-metadata-token-ttl-seconds header.
+      def ec2_metadata_request?(req)
+        req.uri && req.uri.hostname == '169.254.169.254'
+      end
 
       def request(req, body = nil, &block)
-        # Do not trace requests to xray or aws lambda runtime
-        if xray_sampling_request?(req) || lambda_runtime_request?(req)
+        # Do not trace requests to xray or aws lambda runtime or ec2 metadata endpoint
+        if xray_sampling_request?(req) || lambda_runtime_request? || ec2_metadata_request?(req)
           return super
         end
 

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

@@ -17,7 +17,12 @@ module XRay
           pool, conn = get_pool_n_conn(payload[:connection_id])
 
           return if IGNORE_OPS.include?(payload[:name]) || pool.nil? || conn.nil?
-          db_config = pool.spec.config
+          # The spec notation is Rails < 6.1, later this can be found in the db_config
+          db_config = if pool.respond_to?(:spec)
+                        pool.spec.config
+                      else
+                        pool.db_config.configuration_hash
+                      end
           name, sql = build_name_sql_meta config: db_config, conn: conn
           subsegment = XRay.recorder.begin_subsegment name, namespace: 'remote'
           # subsegment is nil in case of context missing
@@ -52,6 +57,7 @@ module XRay
           ::ActiveRecord::Base.connection_handler.connection_pool_list.each do |p|
             conn = p.connections.select { |c| c.object_id == conn_id }
             pool = p unless conn.nil?
+            return [pool, conn] if !conn.nil? && !conn.empty? && !pool.nil?
           end
           [pool, conn]
         end

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

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

data/lib/aws-xray-sdk/facets/resources/{aws_params_whitelist.rb → aws_params_allowlist.rb}

@@ -330,6 +330,15 @@ module XRay
             }
           }
         },
+        SageMakerRuntime: {
+          operations: {
+            invoke_endpoint: {
+              request_parameters: %I[
+                endpoint_name
+              ]
+            }
+          }
+        },
         SNS: {
           operations: {
             publish: {

data/lib/aws-xray-sdk/facets/resources/{aws_services_whitelist.rb → aws_services_allowlist.rb}

@@ -3,20 +3,32 @@ module XRay
   module AwsServices
     # exausted list can be tracked at http://docs.aws.amazon.com/sdk-for-ruby/v3/api/Seahorse/Client/Base.html
     @whitelist = %I[
+      AccessAnalyzer
       ACM
-      APIGateway
+      ACMPCA
       AlexaForBusiness
-      AppStream
-      AppSync
+      Amplify
+      APIGateway
+      ApiGatewayManagementApi
+      ApiGatewayV2
+      AppConfig
       ApplicationAutoScaling
       ApplicationDiscoveryService
+      ApplicationInsights
+      AppMesh
+      AppStream
+      AppSync
       Athena
+      AugmentedAIRuntime
       AutoScaling
+      AutoScalingPlans
+      Backup
       Batch
       Budgets
+      Chime
       Cloud9
       CloudDirectory
-      CloudFormatioin
+      CloudFormation
       CloudFront
       CloudHSM
       CloudHSMV2
@@ -29,109 +41,193 @@ module XRay
       CodeBuild
       CodeCommit
       CodeDeploy
+      CodeGuruProfiler
+      CodeGuruReviewer
       CodePipeline
       CodeStar
+      CodeStarconnections
+      CodeStarNotifications
       CognitoIdentity
       CognitoIdentityProvider
       CognitoSync
       Comprehend
+      ComprehendMedical
+      ComputeOptimizer
       ConfigService
-      CostExplore
+      Connect
+      ConnectParticipant
       CostandUsageReportService
-      DAX
-      DataPipeline
+      CostExplore
+      CostExplorer
       DatabaseMigrationService
+      DataExchange
+      DataPipeline
+      DataSync
+      DAX
+      Detective
       DeviceFarm
       DirectConnect
       DirectoryService
+      DLM
+      DocDB
       DynamoDB
       DynamoDBStreams
+      EBS
       EC2
+      EC2InstanceConnect
       ECR
       ECS
       EFS
-      EMR
+      EKS
       ElastiCache
       ElasticBeanstalk
+      ElasticInference
       ElasticLoadBalancing
       ElasticLoadBalancingV2
-      ElasticTranscoder
       ElasticsearchService
+      ElasticTranscoder
+      EMR
+      EventBridge
       Firehose
+      FMS
+      ForecastQueryService
+      ForecastService
+      FraudDetector
+      FSx
       GameLift
       Glacier
+      GlobalAccelerator
       Glue
       Greengrass
+      GroundStation
       GuardDuty
       Health
       IAM
+      IVS
+      Imagebuilder
       ImportExport
       Inspector
       IoT
+      IoT1ClickDevicesService
+      IoT1ClickProjects
+      IoTAnalytics
       IoTDataPlane
+      IoTEvents
+      IoTEventsData
       IoTJobsDataPlane
-      KMS
+      IoTSecureTunneling
+      IoTThingsGraph
+      Kafka
+      Kendra
       Kinesis
       KinesisAnalytics
+      KinesisAnalyticsV2
       KinesisVideo
+      KinesisVideoArchivedMedia
       KinesisVideoArchiveMedia
       KinesisVideoMedia
+      KinesisVideoSignalingChannels
+      KMS
+      LakeFormation
       Lambda
       LambdaPreview
       Lex
       LexModelBuildingService
       LexRuntimeService
+      LicenseManager
       Lightsail
-      MQ
-      MTurk
+      LocationService
       MachineLearning
+      Macie
+      ManagedBlockchain
+      MarketplaceCatalog
       MarketplaceCommerceAnalytics
       MarketplaceEntitlementService
       MarketplaceMetering
+      MediaConnect
       MediaConvert
       MediaLive
       MediaPackage
+      MediaPackageVod
       MediaStore
       MediaStoreData
+      MediaTailor
       MigrationHub
+      MigrationHubConfig
       Mobile
+      MQ
+      MTurk
+      Neptune
+      NetworkManager
       OpsWorks
       OpsWorksCM
       Organizations
+      Outposts
+      Personalize
+      PersonalizeEvents
+      PersonalizeRuntime
+      PI
       Pinpoint
+      PinpointEmail
+      PinpointSMSVoice
       Polly
       Pricing
+      QLDB
+      QLDBSession
+      QuickSight
+      RAM
       RDS
+      RDSDataService
       Redshift
       Rekognition
       ResourceGroups
       ResourceGroupsTaggingAPI
+      RoboMaker
       Route53
       Route53Domains
+      Route53Resolver
       S3
-      SES
-      SFN
-      SMS
-      SNS
-      SQS
-      SSM
-      STS
-      SWF
+      S3Control
       SageMaker
       SageMakerRuntime
+      SavingsPlans
+      Schemas
+      SecretsManager
+      SecurityHub
       ServerlessApplicationRepository
       ServiceCatalog
       ServiceDiscovery
+      ServiceQuotas
+      SES
+      SESV2
+      SFN
       Shield
+      Signer
       SimpleDB
+      SMS
       Snowball
+      SNS
+      SQS
+      SSM
+      SSO
+      SSOOIDC
       States
       StorageGateway
+      STS
       Support
+      SWF
+      Textract
+      TranscribeService
+      TranscribeStreamingService
+      Transfer
       Translate
       WAF
       WAFRegional
+      WAFV2
       WorkDocs
+      WorkLink
+      WorkMail
+      WorkMailMessageFlow
       WorkSpaces
       XRay
     ]

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

@@ -1,36 +1,93 @@
-require 'open-uri'
+require 'net/http'
+require 'json'
 require 'aws-xray-sdk/logger'
 
 module XRay
   module Plugins
-    # A plugin that gets the EC2 instance-id and AZ if running on an EC2 instance.
+    # A plugin that gets the EC2 instance_id, availabiity_zone, instance_type, and ami_id if running on an EC2 instance.
+    # The plugin queries IMDSv2 endpoint with X-aws-ec2-metadata-token-ttl-seconds as 60 seconds, and fallback to using
+    # IMDSv1 endpoint.
+    # More details about EC2 instance metadata retreival: http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html#instancedata-data-retrieval
     module EC2
       include Logging
 
       ORIGIN = 'AWS::EC2::Instance'.freeze
-      # http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html#instancedata-data-retrieval
-      ID_ADDR = 'http://169.254.169.254/latest/meta-data/instance-id'.freeze
-      AZ_ADDR = 'http://169.254.169.254/latest/meta-data/placement/availability-zone'.freeze
+
+      METADATA_BASE_URL = 'http://169.254.169.254/latest'.freeze
 
       def self.aws
-        @@aws ||= begin
-          instance_id = open(ID_ADDR, open_timeout: 1).read
-          az = open(AZ_ADDR, open_timeout: 1).read
-          {
-            ec2: {
-              instance_id: instance_id,
-              availability_zone: az
-            }
+        @@aws = {}
+        token = get_token
+        ec2_metadata = get_metadata(token)
+        @@aws = {
+          ec2: ec2_metadata
+        }
+      end
+
+
+      private # private methods
+
+      def self.get_token
+        token_uri = URI(METADATA_BASE_URL + '/api/token')
+
+        req = Net::HTTP::Put.new(token_uri)
+        req['X-aws-ec2-metadata-token-ttl-seconds'] = '60'
+        begin
+          return do_request(req)
+        rescue StandardError => e
+          Logging.logger.warn %(cannot get the IMDSv2 token due to: #{e.message}.)
+          ''
+        end
+      end
+
+      def self.get_metadata(token)
+        metadata_uri = URI(METADATA_BASE_URL + '/dynamic/instance-identity/document')
+
+        req = Net::HTTP::Get.new(metadata_uri)
+        if token != ''
+          req['X-aws-ec2-metadata-token'] = token
+        end
+
+        begin
+          metadata_json = do_request(req)
+          return parse_metadata(metadata_json)
+        rescue StandardError => e
+          Logging.logger.warn %(cannot get the ec2 instance metadata due to: #{e.message}.)
+          {}
+        end
+      end
+
+      def self.parse_metadata(json_str)
+        metadata = {}
+        data = JSON(json_str)
+        metadata['instance_id'] = data['instanceId']
+        metadata['availability_zone'] = data['availabilityZone']
+        metadata['instance_type'] = data['instanceType']
+        metadata['ami_id'] = data['imageId']
+
+        metadata
+      end
+
+      def self.do_request(request)
+        begin
+          response = Net::HTTP.start(request.uri.hostname, read_timeout: 1) { |http|
+            http.request(request)
           }
+
+          if response.code == '200'
+            return response.body
+          else
+            raise(StandardError.new('Unsuccessful response::' + response.code + '::' + response.message))
+          end
         rescue StandardError => e
-          # Two attempts in total to get EC2 metadata
+          # Two attempts in total to complete the request successfully
           @retries ||= 0
           if @retries < 1
             @retries += 1
             retry
           else
-            @@aws = {}
-            Logging.logger.warn %(can not get the ec2 instance metadata due to: #{e.message}.)
+            Logging.logger.warn %(Failed to complete request due to: #{e.message}.)
+            raise e
           end
         end
       end

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

@@ -15,7 +15,7 @@ module XRay
           { ecs: { container: Socket.gethostname } }
         rescue StandardError => e
           @@aws = {}
-          Logging.logger.warn %(can not get the ecs container hostname due to: #{e.message}.)
+          Logging.logger.warn %(cannot get the ecs container hostname due to: #{e.message}.)
         end
       end
     end

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

@@ -17,7 +17,7 @@ module XRay
           { elastic_beanstalk: MultiJson.load(file) }
         rescue StandardError => e
           @@aws = {}
-          Logging.logger.warn %(can not get the environment config due to: #{e.message}.)
+          Logging.logger.warn %(cannot get the environment config due to: #{e.message}.)
         end
       end
     end

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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-xray-sdk
 version: !ruby/object:Gem::Version
-  version: 0.11.3
+  version: 0.13.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-31 00:00:00.000000000 Z
+date: 2022-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-xray
@@ -186,8 +186,8 @@ files:
 - lib/aws-xray-sdk/facets/rails/active_record.rb
 - lib/aws-xray-sdk/facets/rails/ex_middleware.rb
 - 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/facets/resources/aws_params_allowlist.rb
+- lib/aws-xray-sdk/facets/resources/aws_services_allowlist.rb
 - lib/aws-xray-sdk/lambda.rb
 - lib/aws-xray-sdk/lambda/facade_segment.rb
 - lib/aws-xray-sdk/lambda/lambda_context.rb
@@ -244,7 +244,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: AWS X-Ray SDK for Ruby