google-cloud-error_reporting 0.30.5 → 0.31.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: df53fba39b31fef5256a2fb3e35160f868eaaea7e6332b71ea779c9edb55c11c
-  data.tar.gz: 28bea2c9d8caa7eb94f69ad8ea64fb243c9920449cff4396bc5220726d834f07
+  metadata.gz: 2ca4dece3ad67bcf61fa206c1561305f21d2dea95e2505099818cdf5f99368e3
+  data.tar.gz: c91e752ce4555b646bcaa313177373b8310a6d944997560f9dc98ea7f87eb6a9
 SHA512:
-  metadata.gz: ec08c92db16cdaf1a8fe8d6d0d4f00255d2c78c550f07ccb1dc024d9318704b5c1e57a6ded1c37228fa094fd87fc41869c98f4b9c3d7a1a773c611b74e9237d8
-  data.tar.gz: 4099c791a52bab837c673cc8a88f02542a1f64fe9926e143af97758e72df970066898db77e8fcbb0d7a07a58fca0c5a115d132fc162670ed1b0ec8f3cda5997d
+  metadata.gz: 52bb1f172ce54cd572f7ff60d60c675b440f7196358d54ff9ce3f31ceb87a80c07245d1dd9f7fa4f8c9da38aa740cf8d40215a4d4fb229f2ae42ae78f8482fbe
+  data.tar.gz: b3d6ebf49e7e596045b86104d4cd0eb4702a493cd93581487c7456f1da0209523d0d80fa6fc0faf06e92f591d027a8b90e096b6ae3b1bb484a7f36551f9c53b0

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Release History
 
+### 0.31.0 / 2019-02-01
+
+* Add ErrorReporting on_error configuration.
+* Update asynchronous error reporting implementation:
+  * Add dependency on concurrent-ruby.
+* Fix for submitting error objects without backtrace.
+* Make use of Credentials#project_id
+  * Use Credentials#project_id
+    If a project_id is not provided, use the value on the Credentials object.
+    This value was added in googleauth 0.7.0.
+  * Loosen googleauth dependency
+    Allow for new releases up to 0.10.
+    The googleauth devs have committed to maintanining the current API
+    and will not make backwards compatible changes before 0.10.
+
 ### 0.30.5 / 2018-09-20
 
 * Update documentation.

data/lib/google-cloud-error_reporting.rb

@@ -163,4 +163,5 @@ Google::Cloud.configure.add_config! :error_reporting do |config|
   config.add_field! :service_version, default_version,
                     match: String, allow_nil: true
   config.add_field! :ignore_classes, nil, match: Array
+  config.add_field! :on_error, nil, match: Proc
 end

data/lib/google/cloud/error_reporting.rb

@@ -76,20 +76,24 @@ module Google
       #
       def self.new project_id: nil, credentials: nil, scope: nil, timeout: nil,
                    client_config: nil, project: nil, keyfile: nil
-        project_id ||= (project || ErrorReporting::Project.default_project_id)
-        project_id = project_id.to_s
-        raise ArgumentError, "project_id is missing" if project_id.empty?
-
-        scope ||= configure.scope
-        timeout ||= configure.timeout
+        project_id    ||= project
+        project_id    ||= ErrorReporting::Project.default_project_id
+        scope         ||= configure.scope
+        timeout       ||= configure.timeout
         client_config ||= configure.client_config
+        credentials   ||= (keyfile || default_credentials(scope: scope))
 
-        credentials ||= (keyfile || default_credentials(scope: scope))
         unless credentials.is_a? Google::Auth::Credentials
           credentials = ErrorReporting::Credentials.new credentials,
                                                         scope: scope
         end
 
+        if credentials.respond_to? :project_id
+          project_id ||= credentials.project_id
+        end
+        project_id = project_id.to_s
+        raise ArgumentError, "project_id is missing" if project_id.empty?
+
         ErrorReporting::Project.new(
           ErrorReporting::Service.new(
             project_id, credentials, timeout: timeout,
@@ -123,6 +127,13 @@ module Google
       # * `service_version` - (String) Version identifier for the application.
       # * `ignore_classes` - (Array<Exception>) Array of exception types that
       #   should not be reported.
+      # * `on_error` - (Proc) A Proc to be run when an error is encountered
+      #   on a background thread, such as {ErrorReporting.report} or
+      #   {Middleware}. The Proc must take the error object as the single
+      #   argument. If ErrorReporting is being used to report errors using
+      #   `Google::Cloud::cofigure.on_error`, then this `on_error` should be
+      #   configured to report errors raised when reporting through
+      #   ErrorReporting.
       #
       # See the [Configuration
       # Guide](https://googleapis.github.io/google-cloud-ruby/docs/stackdriver/latest/file.INSTRUMENTATION_CONFIGURATION)
@@ -206,6 +217,9 @@ module Google
         service_name ||= Project.default_service_name
         service_version ||= Project.default_service_version
 
+        # Ensure the reported exception has a backtrace
+        exception.set_backtrace caller if exception.backtrace.nil?
+
         error_event = ErrorEvent.from_exception(exception).tap do |event|
           event.service_name = service_name
           event.service_version = service_version

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

@@ -13,12 +13,51 @@
 # limitations under the License.
 
 
-require "stackdriver/core/async_actor"
-
+require "concurrent"
+require "google/cloud/errors"
 
 module Google
   module Cloud
     module ErrorReporting
+      ##
+      # # AsyncErrorReporterError
+      #
+      # @private Used to indicate a problem reporting errors asynchronously.
+      # This can occur when there are not enough resources allocated for the
+      # amount of usage.
+      #
+      class AsyncErrorReporterError < Google::Cloud::Error
+        # @!attribute [r] error_event
+        #   @return [Array<Google::Cloud::ErrorReporting::ErrorEvent>] The
+        #   individual error event that was not reported to Stackdriver Error
+        #   Reporting service.
+        attr_reader :error_event
+
+        def initialize message, error_event = nil
+          super(message)
+          @error_event = error_event
+        end
+      end
+
+      ##
+      # # ErrorReporterError
+      #
+      # @private Used to indicate a problem reporting errors. This can occur
+      # when the calling the API returns an error.
+      #
+      class ErrorReporterError < Google::Cloud::Error
+        # @!attribute [r] error_event
+        #   @return [Array<Google::Cloud::ErrorReporting::ErrorEvent>] The
+        #   individual error event that was not reported to Stackdriver Error
+        #   Reporting service.
+        attr_reader :error_event
+
+        def initialize message, error_event = nil
+          super(message)
+          @error_event = error_event
+        end
+      end
+
       ##
       # # AsyncErrorReporter
       #
@@ -27,98 +66,144 @@ module Google
       # 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
+        # @private Implementation accessors
+        attr_reader :error_reporting, :max_queue, :threads, :thread_pool
 
         ##
-        # The {Google::Cloud::ErrorReporting::Project} object to submit events
-        # with.
-        attr_accessor :error_reporting
+        # @private Creates a new AsyncErrorReporter instance.
+        def initialize error_reporting, max_queue: 1000, threads: 10
+          @error_reporting = error_reporting
 
-        ##
-        # The max number of items the queue holds
-        attr_accessor :max_queue_size
+          @max_queue = max_queue
+          @threads   = threads
 
-        ##
-        # @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
+          @thread_pool = Concurrent::CachedThreadPool.new max_threads: @threads,
+                                                          max_queue: @max_queue
+
+          @error_callbacks = []
+
+          # Make sure all queued calls are completed when process exits.
+          at_exit { stop! }
         end
 
         ##
-        # Add the error event to the queue. Signal the child thread an item
-        # has been added.
+        # Add the error event to the queue. This will raise if there are no
+        # resources available to make the API call.
         def report error_event
-          async_start
-
-          synchronize do
-            @queue.push error_event
-            @queue_resource.broadcast
+          Concurrent::Promises.future_on(@thread_pool, error_event) do |error|
+            report_sync error
+          end
+        rescue Concurrent::RejectedExecutionError => e
+          raise AsyncErrorReporterError,
+                "Error reporting error_event asynchronously: #{e.message}",
+                error_event
+        end
 
-            retries = 0
-            while @max_queue_size && @queue.size > @max_queue_size
-              retries += 1
-              @queue_resource.wait 1
+        ##
+        # Begins the process of stopping the reporter. ErrorEvents already
+        # in the queue will be published, but no new ErrorEvent can be added.
+        # Use {#wait!} to block until the reporter is fully stopped and all
+        # pending error_events have been pushed to the API.
+        #
+        # @return [AsyncErrorReporter] returns self so calls can be chained.
+        def stop
+          @thread_pool.shutdown if @thread_pool
+
+          self
+        end
 
-              # Drop early queue entries when have waited long enough.
-              @queue.pop while @queue.size > @max_queue_size && retries > 3
-            end
-          end
+        ##
+        # Stop this asynchronous reporter and block until it has been stopped.
+        #
+        # @param [Number] timeout Timeout in seconds.
+        #
+        def stop! timeout = nil
+          stop
+          wait! timeout
         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 StandardError => e
-            warn error_event.message if error_event.message
-            warn ["#{e.class}: #{e.message}", e.backtrace].join("\n\t")
-            @last_exception = e
+        # Blocks until the reporter is fully stopped, all pending error_events
+        # have been published, and all callbacks have completed. Does not stop
+        # the reporter. To stop the reporter, first call {#stop} and then call
+        # {#wait!} to block until the reporter is stopped.
+        #
+        # @return [AsyncErrorReporter] returns self so calls can be chained.
+        def wait! timeout = nil
+          if @thread_pool
+            @thread_pool.shutdown
+            @thread_pool.wait_for_termination timeout
           end
+
+          self
         end
 
         ##
-        # @private Callback function when the async actor thread state changes
-        def on_async_state_change
-          synchronize do
-            @queue_resource.broadcast
-          end
+        # Whether the reporter has been started.
+        #
+        # @return [boolean] `true` when started, `false` otherwise.
+        #
+        def started?
+          @thread_pool.running? if @thread_pool
         end
 
-        private
+        ##
+        # Whether the reporter has been stopped.
+        #
+        # @return [boolean] `true` when stopped, `false` otherwise.
+        #
+        def stopped?
+          !started?
+        end
 
         ##
-        # @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?)
+        # Register to be notified of errors when raised.
+        #
+        # If an unhandled error has occurred the reporter will attempt to
+        # recover from the error and resume reporting error_events.
+        #
+        # Multiple error handlers can be added.
+        #
+        # @yield [callback] The block to be called when an error is raised.
+        # @yieldparam [Exception] error The error raised.
+        #
+        def on_error &block
+          @error_callbacks << block
+        end
+
+        protected
+
+        # Calls all error callbacks.
+        def error! error
+          error_callbacks = @error_callbacks
+          error_callbacks = default_error_callbacks if error_callbacks.empty?
+          error_callbacks.each { |error_callback| error_callback.call error }
+        end
+
+        def default_error_callbacks
+          # This is memoized to reduce calls to the configuration.
+          @default_error_callbacks ||= begin
+            error_cb = Google::Cloud::ErrorReporting.configuration.on_error
+            error_cb ||= Google::Cloud.configure.on_error
+            if error_cb
+              [error_cb]
+            else
+              []
             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
+        def report_sync error_event
+          error_reporting.report error_event
+        rescue StandardError => e
+          sync_error = ErrorReporterError.new(
+            "Error reporting error_event: #{e.message}",
+            error_event
+          )
+          # Manually set backtrace so we don't have to raise
+          sync_error.set_backtrace caller
+          error! sync_error
         end
       end
     end

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

@@ -27,7 +27,7 @@ module Google
       # and report them to the Stackdriver Error Reporting service.
       #
       # The Middleware is only added when certain conditions are met. See
-      # {Railtie.use_error_reporting?} for detail.
+      # `Google::Cloud.configure.use_error_reporting` for detail.
       #
       # When loaded, the {Google::Cloud::ErrorReporting::Middleware} will be
       # inserted after ActionDispatch::DebugExceptions or

data/lib/google/cloud/error_reporting/v1beta1/credentials.rb

@@ -1,4 +1,4 @@
-# Copyright 2018 Google LLC
+# Copyright 2019 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/google/cloud/error_reporting/v1beta1/doc/google/devtools/clouderrorreporting/v1beta1/common.rb

@@ -1,4 +1,4 @@
-# Copyright 2018 Google LLC
+# Copyright 2019 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/google/cloud/error_reporting/v1beta1/doc/google/devtools/clouderrorreporting/v1beta1/error_group_service.rb

@@ -1,4 +1,4 @@
-# Copyright 2018 Google LLC
+# Copyright 2019 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/google/cloud/error_reporting/v1beta1/doc/google/devtools/clouderrorreporting/v1beta1/error_stats_service.rb

@@ -1,4 +1,4 @@
-# Copyright 2018 Google LLC
+# Copyright 2019 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -267,6 +267,25 @@ module Google
         # Response message for deleting error events.
         class DeleteEventsResponse; end
 
+        # A sorting order of error groups.
+        module ErrorGroupOrder
+          # No group order specified.
+          GROUP_ORDER_UNSPECIFIED = 0
+
+          # Total count of errors in the given time window in descending order.
+          COUNT_DESC = 1
+
+          # Timestamp when the group was last seen in the given time window
+          # in descending order.
+          LAST_SEEN_DESC = 2
+
+          # Timestamp when the group was created in descending order.
+          CREATED_DESC = 3
+
+          # Number of affected users in the given time window in descending order.
+          AFFECTED_USERS_DESC = 4
+        end
+
         # Specifies how the time periods of error group counts are aligned.
         module TimedCountAlignment
           # No alignment specified.
@@ -288,25 +307,6 @@ module Google
           # first time period.
           ALIGNMENT_EQUAL_AT_END = 2
         end
-
-        # A sorting order of error groups.
-        module ErrorGroupOrder
-          # No group order specified.
-          GROUP_ORDER_UNSPECIFIED = 0
-
-          # Total count of errors in the given time window in descending order.
-          COUNT_DESC = 1
-
-          # Timestamp when the group was last seen in the given time window
-          # in descending order.
-          LAST_SEEN_DESC = 2
-
-          # Timestamp when the group was created in descending order.
-          CREATED_DESC = 3
-
-          # Number of affected users in the given time window in descending order.
-          AFFECTED_USERS_DESC = 4
-        end
       end
     end
   end

data/lib/google/cloud/error_reporting/v1beta1/doc/google/devtools/clouderrorreporting/v1beta1/report_errors_service.rb

@@ -1,4 +1,4 @@
-# Copyright 2018 Google LLC
+# Copyright 2019 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/google/cloud/error_reporting/v1beta1/doc/google/protobuf/duration.rb

@@ -1,4 +1,4 @@
-# Copyright 2018 Google LLC
+# Copyright 2019 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/google/cloud/error_reporting/v1beta1/doc/google/protobuf/timestamp.rb

@@ -1,4 +1,4 @@
-# Copyright 2018 Google LLC
+# Copyright 2019 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/google/cloud/error_reporting/v1beta1/error_group_service_client.rb

@@ -1,4 +1,4 @@
-# Copyright 2018 Google LLC
+# Copyright 2019 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/google/cloud/error_reporting/v1beta1/error_stats_service_client.rb

@@ -1,4 +1,4 @@
-# Copyright 2018 Google LLC
+# Copyright 2019 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/google/cloud/error_reporting/v1beta1/report_errors_service_client.rb

@@ -1,4 +1,4 @@
-# Copyright 2018 Google LLC
+# Copyright 2019 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

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

@@ -16,7 +16,7 @@
 module Google
   module Cloud
     module ErrorReporting
-      VERSION = "0.30.5".freeze
+      VERSION = "0.31.0".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.30.5
+  version: 0.31.0
 platform: ruby
 authors:
 - Google Inc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-21 00:00:00.000000000 Z
+date: 2019-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-core
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -128,14 +142,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.50.0
+        version: 0.61.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.50.0
+        version: 0.61.0
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
@@ -275,7 +289,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: API Client library for Stackdriver Error Reporting