google-cloud-error_reporting 0.25.0 → 0.26.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2f57b6c70aad426eb8b82902378418d095dcb7df
-  data.tar.gz: 68844ca432aa4fea4ccf1846928ba9ede67b175c
+  metadata.gz: 95eeb57ecd15fd08ecd122259beaefb06afc9eab
+  data.tar.gz: d77c448cde21c23c922fcd0c456618723fe6ed2a
 SHA512:
-  metadata.gz: 1fc21b526bdb71e683f6a17d8eea04ff90f19d5f16b4344de4ff9ad1e039ad0a0db5a45a7e5b2370d6ddc36a210d682f166e120bb2e0b6367fb35a91b5c600c5
-  data.tar.gz: 9d7b384e32d1c9b25b61305cd00d3c594db0d625ee94eeff1791c703bf3d023569a5844c3df5eaf59809d1948b358e9323cea9e0e40fdf9f8479aee7a0a9e800
+  metadata.gz: 07d4e2e0e62f24b647d026014198c593edba2c6b3e187995102095d69147ef09917b9087907a912c96f7ca12c24c5ce9a5a661d732944da48332b8e1bf6c4dfd
+  data.tar.gz: 2610858723c8d1aa8fc18dc138f7c4ee549e3d82f6334b078bd9a4fb6b3cc858b8b21ea1321d07ca85fe841d722d591f3ce1b781ee8cddfdc6ed589c487a274b

data/lib/google/cloud/error_reporting.rb

@@ -14,6 +14,7 @@
 
 
 require "google-cloud-error_reporting"
+require "google/cloud/error_reporting/async_error_reporter"
 require "google/cloud/error_reporting/project"
 require "google/cloud/error_reporting/middleware"
 require "stackdriver/core"
@@ -213,26 +214,42 @@ module Google
       # @param [String] service_version A version identifier for running
       #   service.
       #
-      def self.report exception, service_name: nil, service_version: nil, &block
+      def self.report exception, service_name: nil, service_version: nil
         return if Google::Cloud.configure.use_error_reporting == false
 
+        service_name ||= configure.service_name ||
+                         Project.default_service_name
+        service_version ||= configure.service_version ||
+                            Project.default_service_version
+
+        error_event = ErrorEvent.from_exception(exception).tap do |event|
+          event.service_name = service_name
+          event.service_version = service_version
+        end
+
+        yield error_event if block_given?
+
+        default_client.report error_event
+      end
+
+      ##
+      # @private Create a private client to
+      def self.default_client
         unless @@default_client
           project_id = configure.project_id ||
                        Google::Cloud.configure.project_id
           keyfile = configure.keyfile ||
                     Google::Cloud.configure.keyfile
 
-          @@default_client = new project: project_id, keyfile: keyfile
+          @@default_client = AsyncErrorReporter.new(
+            new(project: project_id, keyfile: keyfile)
+          )
         end
 
-        service_name ||= configure.service_name
-        service_version ||= configure.service_version
-
-        @@default_client.report_exception exception,
-                                          service_name: service_name,
-                                          service_version: service_version,
-                                          &block
+        @@default_client
       end
+
+      private_class_method :default_client
     end
   end
 end

data/lib/google/cloud/error_reporting/async_error_reporter.rb

@@ -0,0 +1,124 @@
+# Copyright 2016 Google Inc. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+require "stackdriver/core/async_actor"
+
+
+module Google
+  module Cloud
+    module ErrorReporting
+      ##
+      # # AsyncErrorReporter
+      #
+      # @private Used by {Google::Cloud::ErrorReporting} and
+      # {Google::Cloud::ErrorReporting::Middleware} to asynchronously submit
+      # error events to Stackdriver Error Reporting service when used in
+      # Ruby applications.
+      class AsyncErrorReporter
+        include Stackdriver::Core::AsyncActor
+
+        ##
+        # @private Default maximum backlog size for the job queue
+        DEFAULT_MAX_QUEUE_SIZE = 1000
+
+        ##
+        # The {Google::Cloud::ErrorReporting::Project} object to submit events
+        # with.
+        attr_accessor :error_reporting
+
+        ##
+        # The max number of items the queue holds
+        attr_accessor :max_queue_size
+
+        ##
+        # @private Construct a new instance of AsyncErrorReporter
+        def initialize error_reporting, max_queue_size = DEFAULT_MAX_QUEUE_SIZE
+          super()
+          @error_reporting = error_reporting
+          @max_queue_size = max_queue_size
+          @queue = []
+          @queue_resource = new_cond
+        end
+
+        ##
+        # Add the error event to the queue. Signal the child thread an item
+        # has been added.
+        def report error_event
+          async_start
+
+          synchronize do
+            @queue.push error_event
+            @queue_resource.broadcast
+
+            retries = 0
+            while @max_queue_size && @queue.size > @max_queue_size
+              retries += 1
+              @queue_resource.wait 1
+
+              # Drop early queue entries when have waited long enough.
+              @queue.pop while @queue.size > @max_queue_size && retries > 3
+            end
+          end
+        end
+
+        ##
+        # @private Callback fucntion for AsyncActor module to run the async
+        # job in a loop
+        def run_backgrounder
+          error_event = wait_next_item
+          return if error_event.nil?
+          begin
+            error_reporting.report error_event
+          rescue => e
+            @last_exception = e
+          end
+        end
+
+        ##
+        # @private Callback function when the async actor thread state changes
+        def on_async_state_change
+          synchronize do
+            @queue_resource.broadcast
+          end
+        end
+
+        private
+
+        ##
+        # @private The the next item from the reporter queue. If there are
+        # no more item, it blocks the reporter thread until an item is
+        # enqueued
+        def wait_next_item
+          synchronize do
+            @queue_resource.wait_while do
+              async_suspended? || (async_running? && @queue.empty?)
+            end
+            @queue.pop
+          end
+        end
+
+        ##
+        # @private Override the #backgrounder_stoppable? method from AsyncActor
+        # module. The actor can be gracefully stopped when queue is
+        # empty.
+        def backgrounder_stoppable?
+          synchronize do
+            @queue.empty?
+          end
+        end
+      end
+    end
+  end
+end

data/lib/google/cloud/error_reporting/middleware.rb

@@ -52,8 +52,10 @@ module Google
 
           @error_reporting =
             error_reporting ||
-            ErrorReporting.new(project: configuration.project_id,
-                               keyfile: configuration.keyfile)
+            ErrorReporting::AsyncErrorReporter.new(
+              ErrorReporting.new(project: configuration.project_id,
+                                 keyfile: configuration.keyfile)
+            )
 
           # Set module default client to reuse the same client. Update module
           # configuration parameters.

data/lib/google/cloud/error_reporting/v1beta1/error_group_service_client_config.json

@@ -6,9 +6,7 @@
           "DEADLINE_EXCEEDED",
           "UNAVAILABLE"
         ],
-        "non_idempotent": [
-          "UNAVAILABLE"
-        ]
+        "non_idempotent": []
       },
       "retry_params": {
         "default": {

data/lib/google/cloud/error_reporting/v1beta1/error_stats_service_client_config.json

@@ -6,9 +6,7 @@
           "DEADLINE_EXCEEDED",
           "UNAVAILABLE"
         ],
-        "non_idempotent": [
-          "UNAVAILABLE"
-        ]
+        "non_idempotent": []
       },
       "retry_params": {
         "default": {

data/lib/google/cloud/error_reporting/v1beta1/report_errors_service_client_config.json

@@ -6,9 +6,7 @@
           "DEADLINE_EXCEEDED",
           "UNAVAILABLE"
         ],
-        "non_idempotent": [
-          "UNAVAILABLE"
-        ]
+        "non_idempotent": []
       },
       "retry_params": {
         "default": {

data/lib/google/cloud/error_reporting/version.rb

@@ -16,7 +16,7 @@
 module Google
   module Cloud
     module ErrorReporting
-      VERSION = "0.25.0".freeze
+      VERSION = "0.26.1".freeze
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-error_reporting
 version: !ruby/object:Gem::Version
-  version: 0.25.0
+  version: 0.26.1
 platform: ruby
 authors:
 - Google Inc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-26 00:00:00.000000000 Z
+date: 2017-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-core
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: google-gax
   requirement: !ruby/object:Gem::Requirement
@@ -205,6 +205,7 @@ files:
 - README.md
 - lib/google-cloud-error_reporting.rb
 - lib/google/cloud/error_reporting.rb
+- lib/google/cloud/error_reporting/async_error_reporter.rb
 - lib/google/cloud/error_reporting/credentials.rb
 - lib/google/cloud/error_reporting/error_event.rb
 - lib/google/cloud/error_reporting/middleware.rb