aws-xray 0.32.1 → 0.32.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d11b7c6ff399ca4649fb5ad82eb3c6dcf8988e77
-  data.tar.gz: 00bcf28cadccf4d3345b8eac6fa3bcf67c40caa0
+  metadata.gz: 9339c52726c1286dc967332ebd1214d81dff09a7
+  data.tar.gz: 85c8c3eecbd5b705e05975db29e893cdd809c309
 SHA512:
-  metadata.gz: d9c402b81de88eb7e43243886f41e1c62c0900858cd575926752468f3924ca869758da3889c48fe371abadec3347c573f19ca652a3e42cc3ba11a47fc4f5721c
-  data.tar.gz: 9c471ba49ce067607d584ac14ca76edccf922d1d62700980de9dbd0c1b575e6adfad975ec947e4b547713f7b47c4666133607701c6b3053ba3d97ea7b15eae5b
+  metadata.gz: 1fec4a00dfae3a47a23f5263fbe8512cf447e9ef274518052c62078e58707a0ff014a5c7236ac844df8771574700ee9d4b6fae9938bb79ca828b6c4b0ff6cd3e
+  data.tar.gz: '0668ff24b6871a361b87996111bb08883407988665aaca163e34b698dd5530a26b5b5b0d00eb9045e308199ac5fb35c32bd550040e28441ac00928f41180e0c5'

data/README.md

@@ -87,7 +87,7 @@ end
 Aws::Xray.trace(name: 'my-app-batch') do |seg|
   client.get('/foo')
 
-  Aws::Xray::Context.current.start_subsegment(name: 'fetch-user', remote: true) do |sub|
+  Aws::Xray.start_subsegment(name: 'fetch-user', remote: true) do |sub|
     # DB access or something to trace.
   end
 end
@@ -113,7 +113,7 @@ Net::HTTP.start(host, port) do |http|
 end
 ```
 
-If you can't access headers, e.g. external client library like aws-sdk or dogapi-rb, setup subsegment name by `Aws::Xray::Context#overwrite`:
+If you can't access headers, e.g. external client library like aws-sdk or dogapi-rb, setup subsegment name by `Aws::Xray.overwrite`:
 
 ```ruby
 client = Aws::Sns::Client.new
@@ -135,8 +135,8 @@ Aws::Xray.config.solr_hook_name = 'solr-development'
 Tracing context is thread local. To pass current tracing context, copy current tracing context:
 
 ```ruby
-Thread.new(Aws::Xray::Context.current.copy) do |context|
-  Aws::Xray::Context.with_given_context(context) do
+Thread.new(Aws::Xray.current_context.copy) do |context|
+  Aws::Xray.with_given_context(context) do
     # Do something
   end
 end

data/lib/aws/xray/rack.rb

@@ -26,15 +26,13 @@ module Aws
         env[ORIGINAL_TRACE_ENV] = env[TRACE_ENV] if env[TRACE_ENV] # just for the record
         env[TRACE_ENV] = trace.to_header_value
 
-        Context.with_new_context(@name, trace) do
-          Context.current.start_segment do |seg|
-            seg.set_http_request(Request.build_from_rack_env(env))
-            status, headers, body = @app.call(env)
-            length = headers['Content-Length'] || 0
-            seg.set_http_response_with_error(status, length, remote: false)
-            headers[TRACE_HEADER] = trace.to_header_value
-            [status, headers, body]
-          end
+        Aws::Xray.trace(name: @name, trace: trace) do |seg|
+          seg.set_http_request(Request.build_from_rack_env(env))
+          status, headers, body = @app.call(env)
+          length = headers['Content-Length'] || 0
+          seg.set_http_response_with_error(status, length, remote: false)
+          headers[TRACE_HEADER] = trace.to_header_value
+          [status, headers, body]
         end
       end
 

data/lib/aws/xray/subsegment.rb

@@ -10,6 +10,11 @@ module Aws
         new(name: name, trace: trace, parent_id: parent_id, remote: remote)
       end
 
+      # Build a subsegment as null object.
+      def self.build_null
+        build(Trace.generate, SecureRandom.hex(8), remote: true, name: '')
+      end
+
       TYPE_NAME = 'subsegment'.freeze
 
       def initialize(name:, trace:, parent_id:, remote:)

data/lib/aws/xray/version.rb

@@ -1,5 +1,5 @@
 module Aws
   module Xray
-    VERSION = '0.32.1'
+    VERSION = '0.32.2'
   end
 end

data/lib/aws/xray.rb

@@ -22,24 +22,66 @@ module Aws
     end
     Worker.reset(Worker::Configuration.new)
 
-    # @param [String] name a logical name of this tracing context.
-    def self.trace(name: nil)
-      name = name || config.name || raise(MissingNameError)
-      Context.with_new_context(name, Trace.generate) do
-        Context.current.start_segment do |seg|
-          yield seg
+    class << self
+      # @param [String] name a logical name of this tracing context.
+      # @return [Object] result of given block
+      def trace(name: nil, trace: Trace.generate)
+        name = name || config.name || raise(MissingNameError)
+        Context.with_new_context(name, trace) do
+          Context.current.start_segment do |seg|
+            yield seg
+          end
         end
       end
-    end
 
-    # Overwrite under lying tracing name at once. If current context does not
-    # set to current thread, do nothing.
-    # @param [String] name
-    def self.overwrite(name:, &block)
-      if Context.started?
-        Context.current.overwrite(name: name, &block)
-      else
-        block.call
+      # @return [Boolean] whether tracing context is started or not.
+      def started?
+        Context.started?
+      end
+
+      # @return [Aws::Xray::Context]
+      # @raise [Aws::Xray::NotSetError] when the current context is not yet set.
+      #   Call this method after start tracing with `Aws::Xray.trace`.
+      def current_context
+        Context.current
+      end
+
+      # @param [Aws::Xray::Context] context copied context
+      # @return [Object] result of given block
+      def with_given_context(context, &block)
+        Context.with_given_context(context, &block)
+      end
+
+      # @yield [Aws::Xray::Subsegment] null subsegment
+      # @return [Object] result of given block
+      def start_subsegment(name:, remote:, &block)
+        if started?
+          current_context.start_subsegment(name: name, remote: remote, &block)
+        else
+          block.call(Subsegment.build_null)
+        end
+      end
+
+      # @param [Symbol] id
+      # @return [Object] result of given block
+      def disable_trace(id, &block)
+        if started?
+          current_context.disable_trace(id, &block)
+        else
+          block.call
+        end
+      end
+
+      # Overwrite under lying tracing name at once. If current context is not
+      # set to current thread, do nothing.
+      # @param [String] name
+      # @return [Object] result of given block
+      def overwrite(name:, &block)
+        if started?
+          current_context.overwrite(name: name, &block)
+        else
+          block.call
+        end
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aws-xray
 version: !ruby/object:Gem::Version
-  version: 0.32.1
+  version: 0.32.2
 platform: ruby
 authors:
 - Taiki Ono