google-cloud-debugger 0.24.1 → 0.25.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 19e34e42860eb8dd9022366055dc29ad8d9d5bad
-  data.tar.gz: cbf0364442fdb7de6b44a1cc2e6b037c69457571
+  metadata.gz: 123026733717c135b469d6151982edc6b0cd8f24
+  data.tar.gz: 0ee45f3037ad8503a1b05dd08274e207e580d6dc
 SHA512:
-  metadata.gz: 1e82fad49a95bdea0489aec8e1802d13a47be18d5a087ce44f5efc32a949450617b166a07b67da46f05b750121c557a15868b7bd799f44a073e7943cc7e08753
-  data.tar.gz: b44bf8ab8f0311ad131391653cd32a2562f66db634867c9a2b106941a1dbed10d4df76cb88e4158d8481b44cd0dd6cb27d966acc48e0f56c0a3e172f8b9699ae
+  metadata.gz: 555b2972eb3db4112e4cb51c2a0f72adfc1c058f9519ffa31fd8d367280db39e91a9be14c10a07b9fd7d3b73c1e37c29f81fee13e66ddd1e7b68311568ef328b
+  data.tar.gz: 7c7780ab4ffd74371586bb256cd4c22094af3b2b2d5a9bdebbbb36ff8c2c49c7abe97f5bf687448869409d8a07a4d312e61370f7b03d2ae07fdf905f9cbaf792

data/README.md

@@ -30,7 +30,7 @@ This library provides a Stackdriver Debugger Agent that's able to work with Ruby
 
 ## Supported Ruby Versions
 
-This library is supported on Ruby 2.3+.
+This library is supported on Ruby 2.2+.
 
 ## Versioning
 

data/lib/google/cloud/debugger.rb

@@ -15,6 +15,7 @@
 
 require "google-cloud-debugger"
 require "google/cloud/debugger/project"
+require "stackdriver/core"
 
 module Google
   module Cloud
@@ -319,6 +320,16 @@ module Google
     # See {Google::Cloud::Debugger::V2::Debugger2Client} for details.
     #
     module Debugger
+      # Initialize :error_reporting as a nested Configuration under
+      # Google::Cloud if haven't already
+      unless Google::Cloud.configure.option? :debugger
+        Google::Cloud.configure.add_options :debugger
+
+        Google::Cloud.configure.define_singleton_method :debugger do
+          Google::Cloud.configure[:debugger]
+        end
+      end
+
       ##
       # Creates a new debugger object for instrumenting Stackdriver Debugger for
       # an application. Each call creates a new debugger agent with independent
@@ -374,6 +385,23 @@ module Google
           module_version: module_version
         )
       end
+
+
+      ##
+      # Configure the Stackdriver Debugger agent.
+      #
+      # See the [Configuration
+      # Guide](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/stackdriver/guides/instrumentation_configuration)
+      # for full configuration parameters.
+      #
+      # @return [Stackdriver::Core::Configuration] The configuration object
+      #   the Google::Cloud::ErrorReporting module uses.
+      #
+      def self.configure
+        yield Google::Cloud.configure[:debugger] if block_given?
+
+        Google::Cloud.configure[:debugger]
+      end
     end
   end
 end

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

@@ -29,26 +29,25 @@ module Google
         # @param [Google::Cloud::Debugger::Project] debugger A debugger to be
         #   used by this middleware. If not given, will construct a new one
         #   using the other parameters.
-        # @param [String] project Project identifier for the Stackdriver
-        #   Debugger service. Optional if a debugger is given.
-        # @param [String, Hash] keyfile Keyfile downloaded from Google Cloud:
-        #   either the JSON data or the path to a readable file. Optional if
-        #   a debugger is given.
-        # @param [String] module_name Name for the debuggee application.
-        #   Optional if a debugger is given.
-        # @param [String] module_version Version identifier for the debuggee
-        #   application. Optiona if a debugger is given.
+        # @param [Hash] *kwargs Hash of configuration settings. Used for
+        #   backward API compatibility. See the [Configuration
+        #   Guide](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/stackdriver/guides/instrumentation_configuration)
+        #   for the prefered way to set configuration parameters.
         #
         # @return [Google::Cloud::Debugger::Middleware] A new
         #   Google::Cloud::Debugger::Middleware instance
         #
-        def initialize app, debugger: nil, module_name:nil, module_version: nil,
-                       project: nil, keyfile: nil
+        def initialize app, debugger: nil, **kwargs
           @app = app
-          @debugger = debugger || Debugger.new(project: project,
-                                               keyfile: keyfile,
-                                               module_name: module_name,
-                                               module_version: module_version)
+
+          load_config kwargs
+
+          @debugger = debugger ||
+                      Debugger.new(project: configuration.project_id,
+                                   keyfile: configuration.keyfile,
+                                   module_name: configuration.module_name,
+                                   module_version: configuration.module_version)
+          # Immediately start the debugger agent
           @debugger.start
         end
 
@@ -71,6 +70,46 @@ module Google
           # Stop breakpoints tracing beyond this point
           @debugger.agent.tracer.disable_traces_for_thread
         end
+
+        private
+
+        ##
+        # Consolidate configurations from various sources. Also set
+        # instrumentation config parameters to default values if not set
+        # already.
+        #
+        def load_config **kwargs
+          configuration.project_id = kwargs[:project] ||
+                                     kwargs[:project_id] ||
+                                     configuration.project_id
+          configuration.keyfile = kwargs[:keyfile] ||
+                                  configuration.keyfile
+
+          configuration.module_name = kwargs[:module_name] ||
+                                      configuration.module_name
+          configuration.module_version = kwargs[:module_version] ||
+                                         configuration.module_version
+
+          init_default_config
+        end
+
+        ##
+        # Fallback to default configuration values if not defined already
+        def init_default_config
+          configuration.project_id ||= Cloud.configure.project_id ||
+                                       Debugger::Project.default_project
+          configuration.keyfile ||= Cloud.configure.keyfile
+
+          configuration.module_name ||= Debugger::Project.default_module_name
+          configuration.module_version ||=
+            Debugger::Project.default_module_version
+        end
+
+        ##
+        # @private Get Google::Cloud::Debugger.configure
+        def configuration
+          Google::Cloud::Debugger.configure
+        end
       end
     end
   end

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

@@ -31,23 +31,9 @@ module Google
       # to the application code.
       #
       # The Railtie should also initialize a debugger to be used by the
-      # middleware. The debugger can be configured using the following Rails
-      # configuration:
-      # @example
-      #   # Explicitly enable or disable Stackdriver Debugger Agent
-      #   config.google_cloud.use_debugger = true
-      #   # Shared Google Cloud Platform project identifier
-      #   config.google_cloud.project_id = "gcloud-project"
-      #   # Google Cloud Platform project identifier for Stackdriver Debugger
-      #   config.google_cloud.debugger.project_id = "debugger-project"
-      #   # Share Google Cloud authentication json file
-      #   config.google_cloud.keyfile = "/path/to/keyfile.json"
-      #   # Google Cloud authentication json file for Stackdriver Debugger only
-      #   config.google_cloud.debugger.keyfile = "/path/to/keyfile.json"
-      #   # Stackdriver Debugger Agent module name identifier
-      #   config.google_cloud.debugger.module_name = "my-ruby-app"
-      #   # Stackdriver Debugger Agent module version identifier
-      #   config.google_cloud.debugger.module_version = "v1"
+      # Middleware. See the [Configuration
+      # Guide](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/stackdriver/guides/instrumentation_configuration)
+      # on how to configure the Railtie and Middleware.
       #
       class Railtie < ::Rails::Railtie
         config.google_cloud = ::ActiveSupport::OrderedOptions.new unless
@@ -58,84 +44,99 @@ module Google
         end
 
         initializer "Stackdriver.Debugger" do |app|
-          if self.class.use_debugger? app.config
-            debugger_config = Railtie.parse_rails_config config
-
-            project_id = debugger_config[:project_id]
-            keyfile = debugger_config[:keyfile]
-            module_name = debugger_config[:module_name]
-            module_version = debugger_config[:module_version]
-
-            debugger =
-              Google::Cloud::Debugger.new project: project_id,
-                                          keyfile: keyfile,
-                                          module_name: module_name,
-                                          module_version: module_version
-
-            app.middleware.insert_after Rack::ETag,
-                                        Google::Cloud::Debugger::Middleware,
-                                        debugger: debugger
-          end
+          self.class.consolidate_rails_config app.config
+
+          self.class.init_middleware app if Cloud.configure.use_debugger
         end
 
         ##
-        # Determine whether to use Stackdriver Debugger or not.
-        #
-        # Returns true if valid GCP project_id is provided and underneath API is
-        # able to authenticate. Also either Rails needs to be in "production"
-        # environment or config.stackdriver.use_debugger is explicitly true.
+        # @private Init Debugger integration for Rails. Setup configuration and
+        # insert the Middleware.
+        def self.init_middleware app
+          app.middleware.insert_after Rack::ETag,
+                                      Google::Cloud::Debugger::Middleware
+        end
+
+        ##
+        # @private Consolidate Rails configuration into Debugger instrumentation
+        # configuration. Also consolidate the `use_debugger` setting by
+        # verifying credentials and Rails environment. The `use_debugger`
+        # setting will be true if credentials are valid, and the setting is
+        # manually set to true or Rails is in production environment.
         #
         # @param [Rails::Railtie::Configuration] config The
         #   Rails.application.config
         #
-        # @return [Boolean] Whether to use Stackdriver Debugger
-        #
-        def self.use_debugger? config
-          debugger_config = parse_rails_config config
+        def self.consolidate_rails_config config
+          merge_rails_config config
+
+          init_default_config
+
+          # Done if Google::Cloud.configure.use_debugger is explicitly
+          # false
+          return if Google::Cloud.configure.use_debugger == false
 
-          # Return false if config.stackdriver.use_debugger is explicitly false
-          use_debugger = debugger_config[:use_debugger]
-          return false if !use_debugger.nil? && !use_debugger
+          # Verify credentials and set use_debugger to false if
+          # credentials are invalid
+          unless valid_credentials? Debugger.configure.project_id,
+                                    Debugger.configure.keyfile
+            Cloud.configure.use_debugger = false
+            return
+          end
+
+          # Otherwise set use_debugger to true if Rails is running in
+          # production
+          Google::Cloud.configure.use_debugger ||= Rails.env.production?
+        end
 
-          # Try authenticate authorize client API. Return false if unable to
-          # authorize.
+        ##
+        # @private Merge Rails configuration into Debugger instrumentation
+        # configuration.
+        def self.merge_rails_config rails_config
+          gcp_config = rails_config.google_cloud
+          dbg_config = gcp_config.debugger
+
+          Cloud.configure.use_debugger ||= gcp_config.use_debugger
+          Debugger.configure do |config|
+            config.project_id ||= dbg_config.project_id || gcp_config.project_id
+            config.keyfile ||= dbg_config.keyfile || gcp_config.keyfile
+            config.module_name ||= dbg_config.module_name
+            config.module_version ||= dbg_config.module_version
+          end
+        end
+
+        ##
+        # Fallback to default config values if config parameters not provided.
+        def self.init_default_config
+          config = Debugger.configure
+          config.project_id ||= Debugger::Project.default_project
+          config.module_name ||= Debugger::Project.default_module_name
+          config.module_version ||= Debugger::Project.default_module_version
+        end
+
+        ##
+        # @private Verify credentials
+        def self.valid_credentials? project_id, keyfile
           begin
-            Google::Cloud::Debugger::Credentials.credentials_with_scope(
-              debugger_config[:keyfile])
+            Debugger::Credentials.credentials_with_scope keyfile
           rescue => e
-            Rails.logger.warn "Google::Cloud::Debugger is not activated due " \
-              "to authorization error: #{e.message}"
+            STDOUT.puts "Note: Google::Cloud::Debugger is disabled because " \
+              "it failed to authorize with the service. (#{e.message})"
             return false
           end
 
-          project_id = debugger_config[:project_id] ||
-                       Google::Cloud::Debugger::Project.default_project
           if project_id.to_s.empty?
-            Rails.logger.warn "Google::Cloud::Debugger is not activated due " \
-              "to empty project_id"
+            STDOUT.puts "Note: Google::Cloud::Debugger is disabled because " \
+              "the project ID could not be determined."
             return false
           end
 
-          # Otherwise default to true if Rails is running in production or
-          # config.stackdriver.use_debugger is true
-          Rails.env.production? || use_debugger
+          true
         end
 
-        ##
-        # @private Helper method to parse rails config into a flattened hash
-        def self.parse_rails_config config
-          gcp_config = config.google_cloud
-          debugger_config = gcp_config[:debugger]
-          use_debugger =
-            gcp_config.key?(:use_debugger) ? gcp_config.use_debugger : nil
-          {
-            project_id: debugger_config.project_id || gcp_config.project_id,
-            keyfile: debugger_config.keyfile || gcp_config.keyfile,
-            module_name: debugger_config.module_name,
-            module_version: debugger_config.module_version,
-            use_debugger: use_debugger
-          }
-        end
+        private_class_method :merge_rails_config,
+                             :init_default_config,
+                             :valid_credentials?
       end
     end
   end

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

@@ -16,7 +16,7 @@
 module Google
   module Cloud
     module Debugger
-      VERSION = "0.24.1"
+      VERSION = "0.25.0"
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-debugger
 version: !ruby/object:Gem::Version
-  version: 0.24.1
+  version: 0.25.0
 platform: ruby
 authors:
 - Heng Xiong
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-07 00:00:00.000000000 Z
+date: 2017-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: binding_of_caller
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.8.0
+- !ruby/object:Gem::Dependency
+  name: stackdriver-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -273,7 +287,7 @@ files:
 - lib/google/devtools/clouddebugger/v2/debugger_pb.rb
 - lib/google/devtools/clouddebugger/v2/debugger_services_pb.rb
 - lib/google/devtools/source/v1/source_context_pb.rb
-homepage: http://googlecloudplatform.github.io/google-cloud-ruby/
+homepage: https://github.com/GoogleCloudPlatform/google-cloud-ruby/tree/master/google-cloud-debugger
 licenses:
 - Apache-2.0
 metadata: {}
@@ -293,7 +307,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: API Client and instrumentation library for Stackdriver Debugger