aws-xray 0.16.5 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7928f5c7fd83ac39e46cbb525539c50e0c448e99
-  data.tar.gz: 1fb21ce7a1aa3b9ed5598eb2ca2664351ea16c78
+  metadata.gz: 4662c7e02f96d99ec218697501619aafc62a6e42
+  data.tar.gz: 21600a8fce7aa843e712b31f0ca7417bf9cc6a3c
 SHA512:
-  metadata.gz: ef131aa7abd38587411272edf8ea1092907f365e391b1582000ec78977c4ab10fd766a239845d4c6e5c71e456660102276aa9e953154f4504f4b7a5d26b0b510
-  data.tar.gz: 2d44467d2051f591d94e70a133b46ab8d377d160880ea28b1e0c9d879870578efd682897bfb5500581f7873c879036b2cfe6bd32c3c28019d224e528dabe7a70
+  metadata.gz: 05dd8e836d6149bcbdfd04338103abb82baa82a084dd89b6b77c95a45648d5250ca41637456cff69a38753ce9bc582bad9c2134f7e31f470bf6bfa050f0e5459
+  data.tar.gz: d419d7eacc9e52d05ebbbf068fb795133b87d67fed9997036c39502dad95ac0907927b40d46b2c6d115b18dccf67c0e45f4b41d1f1208fe4c40bb2b0326ee45d

data/README.md

@@ -124,8 +124,9 @@ Tracing context is thread local. To pass current tracing context, copy current t
 
 ```ruby
 Thread.new(Aws::Xray::Context.current.copy) do |context|
-  Aws::Xray::Context.set_current(context)
-  # Do something
+  Aws::Xray::Context.with_given_context(context) do
+    # Do something
+  end
 end
 ```
 
@@ -175,6 +176,22 @@ Aws::Xray.config.default_metadata = Aws::Xray.config.default_metadata.merge(key:
 
 Note: See official document about annotation and metadata in AWS X-Ray.
 
+### Error handlers
+When aws-xray fails to send segments due to system call errors, it logs errors to stderr by default.
+If you want to track these errors, for example with Sentry, you can configure your own error handler:
+
+```ruby
+Aws::Xray.config.segment_sending_error_handler = MyCustomErrorHandler.new
+```
+
+The error handler must be callable object and receive 2 arguments and 2 keyword arguments. See `Aws::Xray::DefaultErrorHandler` more detail.
+
+Optionaly, aws-xray offers an error handler which integrats with Sentry. To use it:
+
+```ruby
+Aws::Xray.config.segment_sending_error_handler = ErrorHandlerWithSentry.new
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/aws/xray/client.rb

@@ -25,13 +25,11 @@ module Aws
           len = sock.send(payload, 0, @host, @port)
           $stderr.puts("Can not send all bytes: #{len} sent") if payload.size != len
         rescue SystemCallError, SocketError => e
-          $stderr.puts(<<-EOS)
-Failed to send a segment:
-Segnemt:
-#{payload}
-Error: #{e}
-#{e.backtrace.join("\n")}
-          EOS
+          begin
+            Aws::Xray.config.segment_sending_error_handler.call(e, payload, host: @host, port: @port)
+          rescue Exception => e
+            $stderr.puts("Error handler `#{Aws::Xray.config.segment_sending_error_handler}` raised an error: #{e}\n#{e.backtrace.join("\n")}")
+          end
         ensure
           sock.close
         end

data/lib/aws/xray/configuration.rb

@@ -1,6 +1,7 @@
 require 'socket'
 require 'aws/xray/annotation_normalizer'
 require 'aws/xray/version_detector'
+require 'aws/xray/error_handlers'
 
 module Aws
   module Xray
@@ -70,6 +71,12 @@ module Aws
       end
       # @param [Hash] metadata Default metadata.
       attr_writer :default_metadata
+
+      def segment_sending_error_handler
+        @segment_sending_error_handler ||= DefaultErrorHandler.new($stderr)
+      end
+      # @param [Proc] segment_sending_error_handler Callable object
+      attr_writer :segment_sending_error_handler
     end
   end
 end

data/lib/aws/xray/error_handlers.rb

@@ -0,0 +1,35 @@
+module Aws
+  module Xray
+    class DefaultErrorHandler
+      # @param [IO] io
+      def initialize(io)
+        @io = io
+      end
+
+      # @param [Exception] error
+      # @param [String] payload
+      # @param [String,nil] host
+      # @param [Integer,nil] port
+      def call(error, payload, host:, port:)
+        @io.puts(<<-EOS)
+Failed to send a segment to #{host}:#{port}:
+Segnemt:
+#{payload}
+Error: #{error}
+#{error.backtrace.join("\n")}
+        EOS
+      end
+    end
+
+    # Must be configured sentry-raven gem.
+    class ErrorHandlerWithSentry
+      def call(error, payload, host:, port:)
+        if defined?(Raven)
+          ::Raven.capture_exception(error)
+        else
+          $stderr.puts('ErrorHandlerWithSentry is configured but `Raven` is undefined.')
+        end
+      end
+    end
+  end
+end

data/lib/aws/xray/version.rb

@@ -1,5 +1,5 @@
 module Aws
   module Xray
-    VERSION = '0.16.5'
+    VERSION = '0.17.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-xray
 version: !ruby/object:Gem::Version
-  version: 0.16.5
+  version: 0.17.0
 platform: ruby
 authors:
 - Taiki Ono
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-06-13 00:00:00.000000000 Z
+date: 2017-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -156,6 +156,7 @@ files:
 - lib/aws/xray/configuration.rb
 - lib/aws/xray/context.rb
 - lib/aws/xray/error.rb
+- lib/aws/xray/error_handlers.rb
 - lib/aws/xray/faraday.rb
 - lib/aws/xray/header_parser.rb
 - lib/aws/xray/hooks/all.rb
@@ -191,7 +192,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: The unofficial X-Ray Tracing SDK for Ruby.