google-cloud-debugger 0.31.0 → 0.32.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 71f28cd2cdbb26aeb952111ceed9989d726fe066c7b42b15dc6abc01b77c6d80
-  data.tar.gz: 212961fe1b440ca8934468eedc899ce0304523443944fd4e882e7d07bca60157
+  metadata.gz: 192b49269ab919dffd129a0ec48af66cdab93f4c83cf4e502e14dfedeceaab80
+  data.tar.gz: 0c88a6443ae79182cee72c5cff5c6fc2fc0641fe1424ec30fba0d498c653f508
 SHA512:
-  metadata.gz: 557129ab5d5b4010df8d7ff0baebe95fe3b20ea5615c2b50e542db0da479c14be7f8ec49e2e72bbfe0eb25d65ca630204f0097657fe26bf7d5e24b08cdc14ab4
-  data.tar.gz: e87fece9e975bd6b6a194029b880d6a682890af4df8c866b0424bed021744e689752a9454ef824ed26b2cebbb1d07157c8422c3718fbd123dc83997bcc729cf6
+  metadata.gz: 876816208a7431ec0201a85cdf5ff1c861a2b7fa7f2beb64be8ae96224b00ddcdcbb9de1b92d0c47970b0f0ac83c82edbfec3c93edb8344d1b9667340b7d6791
+  data.tar.gz: aae912a8b8d3d6a6133a3731bf0c5aa6c8c3b4d82a2c7c8840f76d779477d9365fbad56f5bec27a15adb455ca33c6b49f56a0aec4ebd5169e79fb102c7a5cafb

data/README.md

@@ -226,6 +226,13 @@ for a list of possible configuration options.
 
 This library is supported on Ruby 2.2 or later.
 
+However, Ruby 2.3 or later is strongly recommended, as earlier releases have
+reached or are nearing end-of-life. After June 1, 2018, Google will provide
+official support only for Ruby versions that are considered current and
+supported by Ruby Core (that is, Ruby versions that are either in normal
+maintenance or in security maintenance).
+See https://www.ruby-lang.org/en/downloads/branches/ for further details.
+
 This library follows [Semantic Versioning](http://semver.org/). It is currently
 in major version zero (0.y.z), which means that anything may change at any time
 and the public API should not be considered stable.

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

@@ -13,6 +13,8 @@
 # limitations under the License.
 
 
+require "set"
+
 require "google/cloud/logging/logger"
 require "google/cloud/debugger/request_quota_manager"
 
@@ -23,8 +25,71 @@ module Google
       # Rack Middleware implementation that supports Stackdriver Debugger Agent
       # in Rack-based Ruby frameworks. It instantiates a new debugger agent if
       # one isn't given already. It helps optimize Debugger Agent Tracer
-      # performance by suspend and resume tracer between each request.
+      # performance by suspending and resuming the tracer between each request.
+      #
+      # To use this middleware, simply install it in your Rack configuration.
+      # The middleware will take care of registering itself with the
+      # Stackdriver Debugger and activating the debugger agent. The location
+      # of the middleware in the middleware stack matters: breakpoints will be
+      # detected in middleware appearing after but not before this middleware.
+      #
+      # For best results, you should also call {Middleware.start_agents}
+      # during application initialization. See its documentation for details.
+      #
       class Middleware
+        ##
+        # Reset deferred start mechanism.
+        # @private
+        #
+        def self.reset_deferred_start
+          @debuggers_to_start = Set.new
+        end
+
+        reset_deferred_start
+
+        ##
+        # Start the debugger. Either adds it to the deferred list, or, if the
+        # deferred list has already been started, starts immediately.
+        #
+        # @param [Google::Cloud::Debugger::Project] debugger
+        #
+        # @private
+        #
+        def self.deferred_start debugger
+          if @debuggers_to_start
+            @debuggers_to_start << debugger
+          else
+            debugger.start
+          end
+        end
+
+        ##
+        # This should be called once the application determines that it is safe
+        # to start background threads and open gRPC connections. It informs
+        # the middleware system that it can start debugger agents.
+        #
+        # Generally, this matters if the application forks worker processes;
+        # this method should be called only after workers are forked, since
+        # threads and network connections interact badly with fork. For
+        # example, when running Puma in
+        # [clustered mode](https://github.com/puma/puma#clustered-mode), this
+        # method should be called in an `on_worker_boot` block.
+        #
+        # If the application does no forking, this method can be called any
+        # time early in the application initialization process.
+        #
+        # If {Middleware.start_agents} is never called, the debugger agent will
+        # be started when the first request is received. This should be safe,
+        # but it will probably mean breakpoints will not be recognized during
+        # that first request. For best results, an application should call this
+        # method at the appropriate time.
+        #
+        def self.start_agents
+          return unless @debuggers_to_start
+          @debuggers_to_start.each(&:start)
+          @debuggers_to_start = nil
+        end
+
         ##
         # Create a new Debugger Middleware.
         #
@@ -58,8 +123,7 @@ module Google
               Google::Cloud::Debugger::RequestQuotaManager.new
           end
 
-          # Immediately start the debugger agent
-          @debugger.start
+          Middleware.deferred_start(@debugger)
         end
 
         ##
@@ -73,6 +137,9 @@ module Google
         # @return [Rack::Response] The response from downstream Rack app
         #
         def call env
+          # Ensure the agent is running. (Note the start method is idempotent.)
+          @debugger.start
+
           # Enable/resume breakpoints tracing
           @debugger.agent.tracer.start
 

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

@@ -37,6 +37,15 @@ module Google
       # on how to configure the Railtie and Middleware.
       #
       class Railtie < ::Rails::Railtie
+        ##
+        # Inform the Railtie that it is safe to start debugger agents.
+        # This simply calls {Google::Cloud::Debugger::Middleware.start_agents}.
+        # See its documentation for more information.
+        #
+        def self.start_agents
+          Google::Cloud::Debugger::Middleware.start_agents
+        end
+
         config.google_cloud = ::ActiveSupport::OrderedOptions.new unless
           config.respond_to? :google_cloud
         config.google_cloud[:debugger] = ::ActiveSupport::OrderedOptions.new
@@ -87,7 +96,7 @@ module Google
 
           # Otherwise set use_debugger to true if Rails is running in
           # the production environment
-          Google::Cloud.configure.use_debugger ||= Rails.env.production?
+          Google::Cloud.configure.use_debugger ||= ::Rails.env.production?
         end
 
         # rubocop:disable all

data/lib/google/cloud/debugger/v2/doc/overview.rb

@@ -17,7 +17,7 @@ module Google
     # rubocop:disable LineLength
 
     ##
-    # # Ruby Client for Stackdriver Debugger API ([Alpha](https://github.com/GoogleCloudPlatform/google-cloud-ruby#versioning))
+    # # Ruby Client for Stackdriver Debugger API ([Beta](https://github.com/GoogleCloudPlatform/google-cloud-ruby#versioning))
     #
     # [Stackdriver Debugger API][Product Documentation]:
     # Examines the call stack and variables of a running application
@@ -51,4 +51,4 @@ module Google
       end
     end
   end
-end
+end

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

@@ -16,7 +16,7 @@
 module Google
   module Cloud
     module Debugger
-      VERSION = "0.31.0".freeze
+      VERSION = "0.32.0".freeze
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-debugger
 version: !ruby/object:Gem::Version
-  version: 0.31.0
+  version: 0.32.0
 platform: ruby
 authors:
 - Heng Xiong
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-27 00:00:00.000000000 Z
+date: 2018-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: binding_of_caller
@@ -328,7 +328,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: API Client and instrumentation library for Stackdriver Debugger