aws-xray 0.6.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: '0976ec151baafd973cfcb253bb8c72ceeceb1425'
-  data.tar.gz: b91bd7bf26e3fae566c962a4bd5f3a72d316ca1f
+  metadata.gz: 2e3c5e5103576cdd8082e34375764847e25f0ba3
+  data.tar.gz: fd6877a751905e3387625c230f9f7615a1265035
 SHA512:
-  metadata.gz: d2f85373ef66e1faa436030a78e58c3b88ef0b076d941b32c81f0d748b105a7a0a30c8b87241cc6dfafd5c4bbc96663c531282511ee4e53f32626aa0f54beb62
-  data.tar.gz: 00ad0675fca0043ea74a72579871253aa8780aa1e5dfe99d161466d3722d9f86ffe92c05b70d5caed9bf962d25520909119717c72c120ae22222cec56e9cdfc5
+  metadata.gz: 76c31717fe55d97fa6fc548f06f4ca827fd08b60fe61f4c055dc16d85ede43188e2ce1bdc34e8773e0de71a6a6155950c7544424773c72a52e0e3653c653b6db
+  data.tar.gz: 2efe2933ccd9ca9cb31e9367115fca96ebdd6ee30f3f9cfb42b0e8689009700f77c129b8cb4d123fba61517741e0cb4f34d3d33674edd01f80e0cf8de9309d30

data/.travis.yml

@@ -4,7 +4,6 @@ branches:
   only:
     - master
 rvm:
-  - 2.1
-  - 2.2
+  - 2.2.7
   - 2.3
   - 2.4

data/README.md

@@ -98,7 +98,7 @@ end
 ```
 
 ## Configurations
-### Xray agent location
+### X-Ray agent location
 In container environments, we often run xray agent container beside application container.
 For that case, pass `AWS_XRAY_LOCATION` environment variable to container to specify host and port of xray agent.
 
@@ -106,7 +106,13 @@ For that case, pass `AWS_XRAY_LOCATION` environment variable to container to spe
 docker run --link xray:xray --env AWS_XRAY_LOCATION=xray:2000 my-application
 ```
 
-### Recording pplication version
+### Excluded paths
+To avoid tracing health checking requests, use "excluded paths" configuration.
+
+- Environment variable: `AWS_XRAY_EXCLUDED_PATHS=/health_check,/another_check`
+- Global configuration: `Aws::Xray.config.excluded_paths = %w[/health_check /another_check]`
+
+### Recording application version
 aws-xray automatically tries to set application version by reading `app_root/REVISION` file.
 If you want to set another version, set it with:
 

data/aws-xray.gemspec

@@ -24,6 +24,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'faraday'
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rack-test'
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'pry-byebug'
 end

data/lib/aws/xray/configuration.rb

@@ -9,8 +9,17 @@ module Aws
       DEFAULT_HOST = option ? option.split(':').first : 'localhost'
       DEFAULT_PORT = option ? Integer(option.split(':').last) : 2000
 
+      name_option = ENV['AWS_XRAY_NAME']
+      DEFAULT_NAME = name_option ? name_option : nil
+
+      path_option = ENV['AWS_XRAY_EXCLUDED_PATHS']
+      DEFAULT_EXCLUDED_PATHS = path_option ? path_option.split(',') : []
+
       # @return [String] name Logical service name for this application.
-      attr_accessor :name
+      def name
+        @name ||= DEFAULT_NAME
+      end
+      attr_writer :name
 
       # @return [Hash] client_options For xray-agent client.
       #   - host: e.g. '127.0.0.1'
@@ -21,6 +30,12 @@ module Aws
       end
       attr_writer :client_options
 
+      # @return [Array<String>]
+      def excluded_paths
+        @excluded_paths ||= DEFAULT_EXCLUDED_PATHS
+      end
+      attr_writer :excluded_paths
+
       # @return [String]
       def version
         @version ||= VersionDetector.new.call

data/lib/aws/xray/rack.rb

@@ -8,19 +8,29 @@ module Aws
     class Rack
       TRACE_ENV = 'HTTP_X_AMZN_TRACE_ID'.freeze
 
-      # TODO: excluded_paths, included_paths
-      #
       # @param  [Hash] client_options For xray-agent client.
       #   - host: e.g. '127.0.0.1'
       #   - port: e.g. 2000
       #   - sock: test purpose.
-      def initialize(app, client_options: {})
+      # @param [Array<String>] excluded_paths for health-check endpoints etc...
+      def initialize(app, client_options: {}, 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
 
       def call(env)
+        if @excluded_paths.include?(env['PATH_INFO'])
+          @app.call(env)
+        else
+          call_with_tracing(env)
+        end
+      end
+
+      private
+
+      def call_with_tracing(env)
         header_value = env[TRACE_ENV]
         trace = if header_value
                          Trace.build_from_header_value(header_value)

data/lib/aws/xray/rails.rb

@@ -4,7 +4,15 @@ module Aws
   module Xray
     class Railtie < ::Rails::Railtie
       initializer 'aws-xray.set_name' do |app|
-        Aws::Xray.config.name = app.class.parent_name.underscore.gsub(/(\/|_)/, '-')
+        unless Aws::Xray.config.name
+          app_name = app.class.parent_name.underscore.gsub(/(\/|_)/, '-')
+
+          if Rails.env.production?
+            Aws::Xray.config.name = app_name
+          else
+            Aws::Xray.config.name = "#{app_name}-#{Rails.env}"
+          end
+        end
       end
 
       initializer 'aws-xray.rack_middleware' do |app|

data/lib/aws/xray/segment.rb

@@ -78,7 +78,7 @@ module Aws
           id: @id,
           trace_id: @trace_id,
           start_time: @start_time,
-          annotation: @annotation,
+          annotations: @annotation,
           metadata: @metadata,
         }
         if @version

data/lib/aws/xray/version.rb

@@ -1,5 +1,5 @@
 module Aws
   module Xray
-    VERSION = '0.6.1'
+    VERSION = '0.7.0'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aws-xray
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Taiki Ono
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement