aws-xray 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7205283919522f3fa51c16bc8e5f11136ba04a9c
-  data.tar.gz: 0fa4f411671929e4c436939d190afa7fd48e181e
+  metadata.gz: 2caae0694ce40c2e40f13c9ef137f20fe74afad1
+  data.tar.gz: 4d1063ecbb78d4ba27c798d6c5017268097e7bf8
 SHA512:
-  metadata.gz: 9c4aea978c59e664b39d10ca7df5c57c8537069fff4df2196b7e3213fa71c990a66e05cd6e0c816a95311d03e9ace2614ecddcad036e5b04c892f78ca51b1e1e
-  data.tar.gz: 6519acd350a5c0a6ceddad31bdd54db472466cf35bc4d5e044404e4290475607296e9b820c64e40d1099307b715fb927ccf53c5a029b249f69531ee2cacf9a4d
+  metadata.gz: 72eccf23076cbfbd0d6254b3bcf36bb3b97d438024fc469193226dbabe550c3d4855a89fa4d3fac1e1a41a03d70f92c069d75354918bef1ff09ebb0a676aaa71
+  data.tar.gz: 7e7eab73da12c373b836b2f3811dc2574c6399033496480986f6b1e0d0faad04dca0869015851a46cd3508a4a23a3ef5f63822a95b4151b15fee76cbe7e4a9b5

data/README.md

@@ -37,14 +37,12 @@ Aws::Xray.config.name = 'my-app'
 Rails.application.config.middleware.use Aws::Xray::Rack
 ```
 
-Or just require `aws/xray/rails`:
+Or just require `aws/xray/rails`. It uses your application name by default.
+e.g. `Legacy::MyBlog` -> `legacy-my-blog`.
 
 ```ruby
 # Gemfile
 gem 'aws-xray', require: 'aws/xray/rails'
-
-# config/initializers/aws_xray.rb
-Aws::Xray.config.name = 'my-app'
 ```
 
 To trace out-going HTTP requests, see below.
@@ -90,13 +88,11 @@ client = Faraday.new('...') do |builder|
 end
 
 # Start new tracing context then perform arbitrary actions in the block.
-Aws::Xray::Context.with_new_context('test-app', xray_client, trace_header) do
-  Aws::Xray::Context.current.base_trace do
-    client.get('/foo')
+Aws::Xray.trace do |seg|
+  client.get('/foo')
 
-    Aws::Xray::Context.current.child_trace do |sub|
-      # DB access or something to trace.
-    end
+  Aws::Xray::Context.current.child_trace do |sub|
+    # DB access or something to trace.
   end
 end
 ```

data/example/campain_app_config.ru

@@ -1,7 +1,8 @@
 require 'pry'
 require 'aws-xray'
 
-use Aws::Xray::Rack, name: 'campain-app'
+Aws::Xray.config.name = 'campain-app'
+use Aws::Xray::Rack
 
 class DbConnectionError < StandardError
   def initialize

data/example/fron_app_config.ru

@@ -4,7 +4,8 @@ require 'aws-xray'
 
 recipe_app = ENV.fetch('RECIPE_APP') # host:port
 
-use Aws::Xray::Rack, name: 'front-app'
+Aws::Xray.config.name = 'front-app'
+use Aws::Xray::Rack
 
 run Proc.new {|env|
   headers = { 'Host' => 'recipe-app' }

data/example/recipe_app_config.ru

@@ -5,7 +5,8 @@ require 'aws-xray'
 user_app = ENV.fetch('USER_APP') # host:port
 campain_app = ENV.fetch('CAMPAIN_APP') # host:port
 
-use Aws::Xray::Rack, name: 'recipe-app'
+Aws::Xray.config.name = 'recipe-app'
+use Aws::Xray::Rack
 
 run Proc.new {|env|
   user_client = Faraday.new(url: "http://#{user_app}/", headers: { 'Host' => 'user-app' }) do |builder|

data/example/user_app_config.ru

@@ -1,7 +1,8 @@
 require 'pry'
 require 'aws-xray'
 
-use Aws::Xray::Rack, name: 'user-app'
+Aws::Xray.config.name = 'user-app'
+use Aws::Xray::Rack
 
 run Proc.new {|env|
   ['200', {'Content-Type' => 'text/plain'}, ['user-1']]

data/lib/aws/xray.rb

@@ -7,9 +7,28 @@ module Aws
   module Xray
     TRACE_HEADER = 'X-Amzn-Trace-Id'.freeze
 
+    class MissingNameError < ::StandardError
+      def initialize
+        super("`name` is empty. Configure this with `Aws::Xray.config.name = 'my-app'`.")
+      end
+    end
+
     @config = Configuration.new
     class << self
       attr_reader :config
     end
+
+    # @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.current.base_trace do |seg|
+          yield seg
+        end
+      end
+    ensure
+      client.close
+    end
   end
 end

data/lib/aws/xray/client.rb

@@ -21,6 +21,10 @@ module Aws
           $stderr.puts("Can not send all bytes: #{len} sent")
         end
       end
+
+      def close
+        @sock.close
+      end
     end
   end
 end

data/lib/aws/xray/context.rb

@@ -13,12 +13,22 @@ module Aws
           end
         end
 
+        # @return [Aws::Xray::Context]
         def current
           Thread.current.thread_variable_get(VAR_NAME) || raise(NotSetError)
         end
 
-        def with_new_context(name, client, trace_header)
-          build_current(name, client, trace_header)
+        # @param [String] name logical name of this tracing context.
+        # @param [Aws::Xray::Client] client Require this parameter because the
+        #   socket inside client can live longer than this context. For example
+        #   the life-cycle of context is HTTP request based but the socket can
+        #   live over HTTP requests cycle, it is opened when application starts
+        #   then is closed when application exits.
+        # @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)
           yield
         ensure
           remove_current
@@ -26,8 +36,8 @@ module Aws
 
         private
 
-        def build_current(name, client, trace_header)
-          Thread.current.thread_variable_set(VAR_NAME, Context.new(name, client, trace_header))
+        def build_current(name, client, trace)
+          Thread.current.thread_variable_set(VAR_NAME, Context.new(name, client, trace))
         end
 
         def remove_current
@@ -37,11 +47,11 @@ module Aws
 
       attr_reader :name
 
-      def initialize(name, client, trace_header)
+      def initialize(name, client, trace)
         @name = name
         @client = client
-        @trace_header = trace_header
-        @base_segment = Segment.build(@name, trace_header)
+        @trace = trace
+        @base_segment = Segment.build(@name, trace)
       end
 
       # Rescue standard errors and record the error to the segment.
@@ -67,7 +77,7 @@ module Aws
       # @yield [Aws::Xray::SubSegment]
       # @return [Object] A value which given block returns.
       def child_trace(remote:, name:)
-        sub = SubSegment.build(@trace_header, @base_segment, remote: remote, name: name)
+        sub = SubSegment.build(@trace, @base_segment, remote: remote, name: name)
         res = yield sub
         @client.send_segment(sub)
         res

data/lib/aws/xray/faraday.rb

@@ -14,8 +14,8 @@ module Aws
         name = @name || req_env.request_headers['Host'] || "unknown-request-from-#{Context.current.name}"
 
         Context.current.child_trace(remote: true, name: name) do |sub|
-          propagate_trace_header = sub.generate_trace_header
-          req_env.request_headers[TRACE_HEADER] = propagate_trace_header.to_header_value
+          propagate_trace = sub.generate_trace
+          req_env.request_headers[TRACE_HEADER] = propagate_trace.to_header_value
           sub.set_http_request(Request.build_from_faraday_env(req_env))
 
           @app.call(req_env).on_complete do |res_env|

data/lib/aws/xray/rack.rb

@@ -1,4 +1,4 @@
-require 'aws/xray/trace_header'
+require 'aws/xray/trace'
 require 'aws/xray/client'
 require 'aws/xray/context'
 require 'aws/xray/version_detector'
@@ -8,12 +8,6 @@ module Aws
     class Rack
       TRACE_ENV = 'HTTP_X_AMZN_TRACE_ID'.freeze
 
-      class MissingNameError < ::StandardError
-        def initialize
-          super("`name` is empty. Configure this with `Aws::Xray.config.name = 'my-app'`.")
-        end
-      end
-
       # TODO: excluded_paths, included_paths
       #
       # @param  [Hash] client_options For xray-agent client.
@@ -28,18 +22,18 @@ module Aws
 
       def call(env)
         header_value = env[TRACE_ENV]
-        trace_header = if header_value
-                         TraceHeader.build_from_header_value(header_value)
+        trace = if header_value
+                         Trace.build_from_header_value(header_value)
                        else
-                         TraceHeader.generate
+                         Trace.generate
                        end
 
-        Context.with_new_context(@name, @client, trace_header) do
+        Context.with_new_context(@name, @client, trace) do
           Context.current.base_trace do |seg|
             seg.set_http_request(Request.build_from_rack_env(env))
             status, headers, body = @app.call(env)
             seg.set_http_response(status, headers['Content-Length'])
-            headers[TRACE_HEADER] = trace_header.to_header_value
+            headers[TRACE_HEADER] = trace.to_header_value
             [status, headers, body]
           end
         end

data/lib/aws/xray/rails.rb

@@ -3,6 +3,10 @@ require 'aws/xray'
 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(/(\/|_)/, '-')
+      end
+
       initializer 'aws-xray.rack_middleware' do |app|
         app.middleware.use Aws::Xray::Rack
       end

data/lib/aws/xray/segment.rb

@@ -10,8 +10,8 @@ module Aws
     # http://docs.aws.amazon.com/xray/latest/devguide/xray-api-segmentdocuments.html
     class Segment
       class << self
-        def build(name, trace_header)
-          new(name: name, trace_id: trace_header.root, parent_id: trace_header.parent)
+        def build(name, trace)
+          new(name: name, trace_id: trace.root, parent_id: trace.parent)
         end
       end
 

data/lib/aws/xray/sub_segment.rb

@@ -5,15 +5,15 @@ module Aws
     # http://docs.aws.amazon.com/xray/latest/devguide/xray-api-segmentdocuments.html
     class SubSegment < Segment
       # @param [Boolean] remote
-      def self.build(trace_header, parent, remote:, name:)
-        new(name: name, trace_header: trace_header, parent_id: parent.id, remote: remote)
+      def self.build(trace, parent, remote:, name:)
+        new(name: name, trace: trace, parent_id: parent.id, remote: remote)
       end
 
       TYPE_NAME = 'subsegment'.freeze
 
-      def initialize(name:, trace_header:, parent_id:, remote:)
-        super(name: name, trace_id: trace_header.root, parent_id: parent_id)
-        @trace_header = trace_header
+      def initialize(name:, trace:, parent_id:, remote:)
+        super(name: name, trace_id: trace.root, parent_id: parent_id)
+        @trace = trace
         @remote = !!remote
       end
 
@@ -37,8 +37,8 @@ module Aws
         h
       end
 
-      def generate_trace_header
-        @trace_header.copy(parent: @id)
+      def generate_trace
+        @trace.copy(parent: @id)
       end
     end
   end

data/lib/aws/xray/{trace_header.rb → trace.rb}

@@ -3,7 +3,7 @@ require 'securerandom'
 
 module Aws
   module Xray
-    class TraceHeader
+    class Trace
       class << self
         def generate(now = Time.now)
           new(root: generate_root(now))

data/lib/aws/xray/version.rb

@@ -1,5 +1,5 @@
 module Aws
   module Xray
-    VERSION = "0.3.0"
+    VERSION = "0.4.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aws-xray
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Taiki Ono
@@ -122,7 +122,7 @@ files:
 - lib/aws/xray/response.rb
 - lib/aws/xray/segment.rb
 - lib/aws/xray/sub_segment.rb
-- lib/aws/xray/trace_header.rb
+- lib/aws/xray/trace.rb
 - lib/aws/xray/version.rb
 - lib/aws/xray/version_detector.rb
 homepage: https://github.com/taiki45/aws-xray