google-cloud-debugger 0.32.2 → 0.32.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c284cd24cb8878c64aa43c984273d0e898fabe94611fd832a29df638ff3ce331
-  data.tar.gz: aeac4adb53d4421316d7b2b9bb46e23b7c37227c4fe0c08461115fff73316d15
+  metadata.gz: 7059138deab6099684889719b6af36b209492140bc3785b0fe530fce128d9211
+  data.tar.gz: e2b0dc554a33bf6b435ac24a0f93c6338c9db3a5e46bcf8fe7d9db89e7daca98
 SHA512:
-  metadata.gz: 330dddc3afa46c30eaab89bb51020588842105921a0d8a742b26b3c60b863382c69ace755087a2e334b6998090a91df0017d94af29c5f05159f2354cad027208
-  data.tar.gz: 96778f50ba64a4ac516180870534944fd30b217a721047d6415b9adb7583ad18bd3a195a36dc6221e63e5990fa085705022bb9cf2c8309d0932fc7e2193c420b
+  metadata.gz: 7b2299fac639c19c388e84f8e522388a8b175d22a522b1f60ea372102dbfc4a6767b2f6094ba69af40d5dec1e2cbb256655adfdf6474516d3c6a52b12eb6a162
+  data.tar.gz: efb19ac91c9b94fc6df8ae4af497bc20fb9d3edb96b6b554093e989d2db5ae7b74eb77f34c785f9f280d9db38ef3a91aa2bcb270a1f1014ea90a1e7589338258

data/.yardopts

@@ -3,7 +3,16 @@
 --exclude _pb\.rb$
 --markup markdown
 --markup-provider redcarpet
+--main OVERVIEW.md
 
 ./lib/**/*.rb
 -
-README.md
+OVERVIEW.md
+AUTHENTICATION.md
+INSTRUMENTATION.md
+LOGGING.md
+CONTRIBUTING.md
+TROUBLESHOOTING.md
+CHANGELOG.md
+CODE_OF_CONDUCT.md
+LICENSE

data/README.md

@@ -8,7 +8,7 @@ your application, including test, development, and production. The Ruby
 debugger adds minimal request latency, typically less than 50ms, and only when
 application state is captured. In most cases, this is not noticeable by users.
 
-- [google-cloud-debugger documentation](http://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-debugger/master/google/cloud/debugger)
+- [google-cloud-debugger documentation](http://googlecloudplatform.github.io/google-cloud-ruby/docs/google-cloud-debugger/latest)
 - [google-cloud-debugger on RubyGems](https://rubygems.org/gems/google-cloud-debugger)
 - [Stackdriver Debugger documentation](https://cloud.google.com/debugger/docs/)
 
@@ -175,7 +175,7 @@ Google::Cloud::Debugger.new(project_id: "your-project-id",
 
 This library also supports the other authentication methods provided by the
 `google-cloud-ruby` suite. Instructions and configuration options are covered
-in the [Authentication Guide](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-debugger/guides/authentication).
+in the [Authentication Guide](https://googlecloudplatform.github.io/google-cloud-ruby/docs/google-cloud-debugger/latest/file.AUTHENTICATION).
 
 ### Using the Debugger
 
@@ -219,12 +219,12 @@ agent.
 You can customize the behavior of the Stackdriver Debugger agent. This includes
 setting the Google Cloud project and authentication, and customizing the
 behavior of the debugger itself, such as side effect protection and data
-size limits. See [agent configuration](../stackdriver/docs/configuration.md)
+size limits. See [agent configuration](../stackdriver/CONFIGURATION.md)
 for a list of possible configuration options.
 
 ## Enabling Logging
 
-To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library. The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/stdlib-2.5.0/libdoc/logger/rdoc/Logger.html) as shown below, or a [`Google::Cloud::Logging::Logger`](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-logging/latest/google/cloud/logging/logger) that will write logs to [Stackdriver Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb) and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
+To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library. The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/stdlib-2.5.0/libdoc/logger/rdoc/Logger.html) as shown below, or a [`Google::Cloud::Logging::Logger`](https://googlecloudplatform.github.io/google-cloud-ruby/docs/google-cloud-logging/latest/Google/Cloud/Logging/Logger) that will write logs to [Stackdriver Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb) and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
 
 Configuring a Ruby stdlib logger:
 
@@ -249,9 +249,9 @@ end
 This library is supported on Ruby 2.3+.
 
 Google provides official support for Ruby versions that are actively supported
-by Ruby Core—that is, Ruby versions that are either in normal maintenance or
-in security maintenance, and not end of life. Currently, this means Ruby 2.3
-and later. Older versions of Ruby _may_ still work, but are unsupported and not
+by Ruby Core—that is, Ruby versions that are either in normal maintenance or in
+security maintenance, and not end of life. Currently, this means Ruby 2.3 and
+later. Older versions of Ruby _may_ still work, but are unsupported and not
 recommended. See https://www.ruby-lang.org/en/downloads/branches/ for details
 about the Ruby support schedule.
 
@@ -263,15 +263,24 @@ and the public API should not be considered stable.
 
 Contributions to this library are always welcome and highly encouraged.
 
-See the [Contributing Guide](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/guides/contributing) for more information on how to get started.
+See the [Contributing
+Guide](https://googlecloudplatform.github.io/google-cloud-ruby/docs/google-cloud-debugger/latest/file.CONTRIBUTING)
+for more information on how to get started.
 
-Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms. See [Code of Conduct](../CODE_OF_CONDUCT.md) for more information.
+Please note that this project is released with a Contributor Code of Conduct. By
+participating in this project you agree to abide by its terms. See [Code of
+Conduct](https://googlecloudplatform.github.io/google-cloud-ruby/docs/google-cloud-debugger/latest/file.CODE_OF_CONDUCT)
+for more information.
 
 ## License
 
-This library is licensed under Apache 2.0. Full license text is available in [LICENSE](LICENSE).
+This library is licensed under Apache 2.0. Full license text is available in
+[LICENSE](https://googlecloudplatform.github.io/google-cloud-ruby/docs/google-cloud-debugger/latest/file.LICENSE).
 
 ## Support
 
-Please [report bugs at the project on Github](https://github.com/GoogleCloudPlatform/google-cloud-ruby/issues).
-Don't hesitate to [ask questions](http://stackoverflow.com/questions/tagged/google-cloud-platform+ruby) about the client or APIs on [StackOverflow](http://stackoverflow.com).
+Please [report bugs at the project on
+Github](https://github.com/GoogleCloudPlatform/google-cloud-ruby/issues). Don't
+hesitate to [ask
+questions](http://stackoverflow.com/questions/tagged/google-cloud-platform+ruby)
+about the client or APIs on [StackOverflow](http://stackoverflow.com).

data/lib/google-cloud-debugger.rb

@@ -12,6 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+
 ##
 # This file is here to be autorequired by bundler, so that the
 # Google::Cloud.debugger and Google::Cloud#debugger methods can be available,
@@ -30,8 +31,8 @@ module Google
     # an application. Each call creates a new debugger agent with independent
     # connection service.
     #
-    # For more information on connecting to Google Cloud see the [Authentication
-    # Guide](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/guides/authentication).
+    # For more information on connecting to Google Cloud see the
+    # {file:AUTHENTICATION.md Authentication Guide}.
     #
     # @param [String] service_name Name for the debuggee application. Optional.
     # @param [String] service_version Version identifier for the debuggee
@@ -82,8 +83,8 @@ module Google
     # an application. Each call creates a new debugger agent with independent
     # connection service.
     #
-    # For more information on connecting to Google Cloud see the [Authentication
-    # Guide](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/guides/authentication).
+    # For more information on connecting to Google Cloud see the
+    # {file:AUTHENTICATION.md Authentication Guide}.
     #
     # @param [String] project_id Project identifier for the Stackdriver Debugger
     #   service you are connecting to. If not present, the default project for

data/lib/google/cloud/debugger.rb

@@ -33,326 +33,7 @@ module Google
     # analyze the production state of your application and understand the
     # behavior of your code in production.
     #
-    # For general information about Stackdriver Debugger, read [Stackdriver
-    # Debugger Documentation](https://cloud.google.com/debugger/docs/).
-    #
-    # The Stackdriver Debugger Ruby library, `google-cloud-debugger`, provides:
-    #
-    # *   Easy-to-use debugger instrumentation that reports state data, such as
-    #     value of program variables and the call stack, to Stackdriver Debugger
-    #     when the code at a breakpoint location is executed in your Ruby
-    #     application. See the [instrumenting your app](#instrumenting-your-app)
-    #     section for how to debug your application, in both development and
-    #     production.
-    # *   An idiomatic Ruby API for registerying debuggee application, and
-    #     querying or manipulating breakpoints in registered Ruby debuggee
-    #     application. See [Debugger API](#stackdriver-debugger-api) section for
-    #     an introduction to Stackdriver Debugger API.
-    #
-    # ## Instrumenting Your App
-    #
-    # This instrumentation library provides the following features to help you
-    # debug your applications in production:
-    #
-    # *   Automatic application registration. It facilitates multiple running
-    #     instances of same version of application when hosted in production.
-    # *   A background debugger agent that runs side-by-side with your
-    #     application that automatically collects state data when code is
-    #     executed at breakpoint locations.
-    # *   A Rack middleware and Railtie that automatically manages the debugger
-    #     agent for Ruby on Rails and other Rack-based Ruby applications.
-    #
-    # When this library is configured in your running application, and the
-    # source code and breakpoints are setup through the Google Cloud Console,
-    # You'll be able to
-    # [interact](https://cloud.google.com/debugger/docs/debugging) with your
-    # application in real time through the [Stackdriver Debugger
-    # UI](https://console.cloud.google.com/debug?_ga=1.84295834.280814654.1476313407).
-    # This library also integrates with Google App Engine Flexible to make
-    # debuggee application configuration more seemless.
-    #
-    # Note that when no breakpoints are created, the debugger agent consumes
-    # very little resource and has no interference with the running application.
-    # Once breakpoints are created and depends on where the breakpoints are
-    # located, the debugger agent may add a little latency onto each request.
-    # The application performance will be back to normal after all breakpoints
-    # are finished being evaluated. Be aware the more breakpoints are created,
-    # or the harder to reach the breakpoints, the more resource the debugger
-    # agent would need to consume.
-    #
-    # ### Using instrumentation with Ruby on Rails
-    #
-    # To install application instrumentation in your Ruby on Rails app, add this
-    # gem, `google-cloud-debugger`, to your Gemfile and update your bundle. Then
-    # add the following line to your `config/application.rb` file:
-    #
-    # ```ruby
-    # require "google/cloud/debugger/rails"
-    # ```
-    #
-    # This will load a Railtie that automatically integrates with the Rails
-    # framework by injecting a Rack middleware. The Railtie also takes in the
-    # following Rails configuration as parameter of the debugger agent
-    # initialization:
-    #
-    # ```ruby
-    # # 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 only
-    # config.google_cloud.debugger.project_id = "debugger-project"
-    # # Shared 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/debugger/keyfile.json"
-    # # Stackdriver Debugger Agent service name identifier
-    # config.google_cloud.debugger.service_name = "my-ruby-app"
-    # # Stackdriver Debugger Agent service version identifier
-    # config.google_cloud.debugger.service_version = "v1"
-    # ```
-    #
-    # See the {Google::Cloud::Debugger::Railtie} class for more information.
-    #
-    # ### Using instrumentation with Sinatra
-    #
-    # To install application instrumentation in your Sinatra app, add this gem,
-    # `google-cloud-debugger`, to your Gemfile and update your bundle. Then add
-    # the following lines to your main application Ruby file:
-    #
-    # ```ruby
-    # require "google/cloud/debugger"
-    # use Google::Cloud::Debugger::Middleware
-    # ```
-    #
-    # This will install the debugger middleware in your application.
-    #
-    # Configuration parameters may also be passed in as arguments to Middleware.
-    # ```ruby
-    # require "google/cloud/debugger"
-    # use Google::Cloud::Debugger::Middleware project: "debugger-project-id",
-    #                                         keyfile: "/path/to/keyfile.json",
-    #                                         service_name: "my-ruby-app",
-    #                                         service_version: "v1"
-    # ```
-    #
-    # ### Using instrumentation with other Rack-based frameworks
-    #
-    # To install application instrumentation in an app using another Rack-based
-    # web framework, add this gem, `google-cloud-debugger`, to your Gemfile and
-    # update your bundle. Then add install the debugger middleware in your
-    # middleware stack. In most cases, this means adding these lines to your
-    # `config.ru` Rack configuration file:
-    #
-    # ```ruby
-    # require "google/cloud/debugger"
-    # use Google::Cloud::Debugger::Middleware
-    # ```
-    #
-    # Some web frameworks have an alternate mechanism for modifying the
-    # middleware stack. Consult your web framework's documentation for more
-    # information.
-    #
-    # ### The Stackdriver diagnostics suite
-    #
-    # The debugger library is part of the Stackdriver diagnostics suite, which
-    # also includes error reporting, log analysis, and tracing analysis. If you
-    # include the `stackdriver` gem in your Gemfile, this debugger library will
-    # be included automatically. In addition, if you include the `stackdriver`
-    # gem in an application using Ruby On Rails, the Railties will be installed
-    # automatically. See the documentation for the "stackdriver" gem
-    # for more details.
-    #
-    # ## Stackdriver Debugger API
-    #
-    # This library also includes an easy to use Ruby client for the
-    # Stackdriver Debugger API. This API provides calls to register debuggee
-    # application, as well as creating or modifying breakpoints.
-    #
-    # For further information on the Debugger API, see
-    # {Google::Cloud::Debugger::Project}
-    #
-    # ### Registering debuggee application
-    #
-    # ```ruby
-    # require "google/cloud/debugger/v2"
-    #
-    # Controller2Client = Google::Cloud::Debugger::V2::Controller2Client
-    # Debuggee = Google::Devtools::Clouddebugger::V2::Debuggee
-    #
-    # controller2_client = Controller2Client.new
-    # debuggee = Debuggee.new
-    # response = controller2_client.register_debuggee(debuggee)
-    # debuggee_id = response.debuggee.id
-    # ```
-    # See [Stackdriver Debugger Debuggee
-    # doc](https://cloud.google.com/debugger/api/reference/rpc/google.devtools.clouddebugger.v2#google.devtools.clouddebugger.v2.Debuggee)
-    # on fields necessary for registerying a debuggee.
-    #
-    # Upon successful registration, the response debuggee object will contain
-    # a debuggee_id that's later needed to interact with the other Stackdriver
-    # Debugger API.
-    #
-    # See {Google::Cloud::Debugger::V2::Controller2Client} for details.
-    #
-    # ### List Active Breakpoints
-    #
-    # ```ruby
-    # require "google/cloud/debugger/v2"
-    #
-    # Controller2Client = Google::Cloud::Debugger::V2::Controller2Client
-    # controller2_client = Controller2Client.new
-    #
-    # debuggee_id = ''
-    # response = controller2_client.list_active_breakpoints(debuggee_id)
-    # breakpoints = response.breakpoints
-    # ```
-    #
-    # See {Google::Cloud::Debugger::V2::Controller2Client} for details.
-    #
-    # ### Update Active Breakpoint
-    #
-    # Users can send custom snapshots for active breakpoints using this API.
-    #
-    # ```ruby
-    # require "google/cloud/debugger/v2"
-    #
-    # Breakpoint = Google::Devtools::Clouddebugger::V2::Breakpoint
-    # Controller2Client = Google::Cloud::Debugger::V2::Controller2Client
-    #
-    # controller2_client = Controller2Client.new
-    # debuggee_id = ''
-    # breakpoint = Breakpoint.new
-    # response =
-    #   controller2_client.update_active_breakpoint(debuggee_id, breakpoint)
-    # ```
-    #
-    # See [Stackdriver Debugger Breakpoint
-    # doc](https://cloud.google.com/debugger/api/reference/rpc/google.devtools.clouddebugger.v2#google.devtools.clouddebugger.v2.Breakpoint)
-    # for all available fields for breakpoint.
-    #
-    # See {Google::Cloud::Debugger::V2::Controller2Client} for details.
-    #
-    # ### Set Breakpoint
-    #
-    # ```ruby
-    # require "google/cloud/debugger/v2"
-    #
-    # Breakpoint = Google::Devtools::Clouddebugger::V2::Breakpoint
-    # Debugger2Client = Google::Cloud::Debugger::V2::Debugger2Client
-    #
-    # debugger2_client = Debugger2Client.new
-    # debuggee_id = ''
-    # breakpoint = Breakpoint.new
-    # client_version = ''
-    # response = debugger2_client.set_breakpoint(
-    #              debuggee_id, breakpoint, client_version)
-    # ```
-    #
-    # See [Stackdriver Debugger Breakpoint
-    # doc](https://cloud.google.com/debugger/api/reference/rpc/google.devtools.clouddebugger.v2#google.devtools.clouddebugger.v2.Breakpoint)
-    # for fields needed to specify breakpoint location.
-    #
-    # See {Google::Cloud::Debugger::V2::Debugger2Client} for details.
-    #
-    # ### Get Breakpoint
-    #
-    # ```ruby
-    # require "google/cloud/debugger/v2"
-    #
-    # Debugger2Client = Google::Cloud::Debugger::V2::Debugger2Client
-    #
-    # debugger2_client = Debugger2Client.new
-    # debuggee_id = ''
-    # breakpoint_id = ''
-    # client_version = ''
-    # response = debugger2_client.get_breakpoint(
-    #              debuggee_id, breakpoint_id, client_version)
-    # ```
-    #
-    # See {Google::Cloud::Debugger::V2::Debugger2Client} for details.
-    #
-    # ### Delete Breakpoint
-    #
-    # ```ruby
-    # require "google/cloud/debugger/v2"
-    #
-    # Debugger2Client = Google::Cloud::Debugger::V2::Debugger2Client
-    #
-    # debugger2_client = Debugger2Client.new
-    # debuggee_id = ''
-    # breakpoint_id = ''
-    # client_version = ''
-    # debugger2_client.delete_breakpoint(
-    #   debuggee_id, breakpoint_id, client_version)
-    # ```
-    #
-    # See {Google::Cloud::Debugger::V2::Debugger2Client} for details.
-    #
-    # ### List Breakpoints
-    #
-    # ```ruby
-    # require "google/cloud/debugger/v2"
-    #
-    # Debugger2Client = Google::Cloud::Debugger::V2::Debugger2Client
-    #
-    # Debugger2Client = Google::Cloud::Debugger::V2::Debugger2Client
-    #
-    # debugger2_client = Debugger2Client.new
-    # debuggee_id = ''
-    # client_version = ''
-    # response = debugger2_client.list_breakpoints(debuggee_id, client_version)
-    # ```
-    #
-    # See {Google::Cloud::Debugger::V2::Debugger2Client} for details.
-    #
-    # ### List Debuggees
-    #
-    # ```ruby
-    # require "google/cloud/debugger/v2"
-    #
-    # Debugger2Client = Google::Cloud::Debugger::V2::Debugger2Client
-    #
-    # debugger2_client = Debugger2Client.new
-    # project = ''
-    # client_version = ''
-    # response = debugger2_client.list_debuggees(project, client_version)
-    # ```
-    #
-    # See {Google::Cloud::Debugger::V2::Debugger2Client} for details.
-    #
-    # ## Enabling Logging
-    #
-    # To enable logging for this library, set the logger for the underlying
-    # [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library. The
-    # logger that you set may be a Ruby stdlib
-    # [`Logger`](https://ruby-doc.org/stdlib-2.5.0/libdoc/logger/rdoc/Logger.html)
-    # as shown below, or a
-    # [`Google::Cloud::Logging::Logger`](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-logging/latest/google/cloud/logging/logger)
-    # that will write logs to [Stackdriver
-    # Logging](https://cloud.google.com/logging/). See
-    # [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
-    # and the gRPC
-    # [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb)
-    # for additional information.
-    #
-    # Configuring a Ruby stdlib logger:
-    #
-    # ```ruby
-    # require "logger"
-    #
-    # module MyLogger
-    #   LOGGER = Logger.new $stderr, level: Logger::WARN
-    #   def logger
-    #     LOGGER
-    #   end
-    # end
-    #
-    # # Define a gRPC module-level logger method before grpc/logconfig.rb loads.
-    # module GRPC
-    #   extend MyLogger
-    # end
-    # ```
+    # See {file:OVERVIEW.md Debugger Overview}.
     #
     module Debugger
       # rubocop:disable all
@@ -363,8 +44,7 @@ module Google
       # connection service.
       #
       # For more information on connecting to Google Cloud see the
-      # [Authentication
-      # Guide](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/guides/authentication).
+      # {file:AUTHENTICATION.md Authentication Guide}.
       #
       # @param [String] project_id Project identifier for the Stackdriver
       #   Debugger service you are connecting to. If not present, the default
@@ -469,7 +149,7 @@ module Google
       #   expression evaluation. Defaults to 0.05.
       #
       # See the [Configuration
-      # Guide](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/stackdriver/guides/instrumentation_configuration)
+      # Guide](https://googlecloudplatform.github.io/google-cloud-ruby/docs/stackdriver/latest/file.INSTRUMENTATION_CONFIGURATION)
       # for full configuration parameters.
       #
       # @return [Google::Cloud::Config] The configuration object the

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

@@ -97,9 +97,9 @@ 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 [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)
+        # @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/latest/file.INSTRUMENTATION_CONFIGURATION)
         #   for the prefered way to set configuration parameters.
         #
         # @return [Google::Cloud::Debugger::Middleware] A new

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

@@ -12,6 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+
 require "google/cloud/debugger"
 
 module Google
@@ -33,7 +34,7 @@ module Google
       #
       # The Railtie should also initialize a debugger to be used by the
       # Middleware. See the [Configuration
-      # Guide](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/stackdriver/guides/instrumentation_configuration)
+      # Guide](https://googlecloudplatform.github.io/google-cloud-ruby/docs/stackdriver/latest/file.INSTRUMENTATION_CONFIGURATION)
       # on how to configure the Railtie and Middleware.
       #
       class Railtie < ::Rails::Railtie

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

@@ -12,6 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+
 require "google/cloud/debugger/v2/debugger2_client"
 require "google/cloud/debugger/v2/controller2_client"
 
@@ -37,6 +38,11 @@ module Google
       # 3. [Enable the Stackdriver Debugger API.](https://console.cloud.google.com/apis/library/clouddebugger.googleapis.com)
       # 4. [Setup Authentication.](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
       #
+      # ### Installation
+      # ```
+      # $ gem install google-cloud-debugger
+      # ```
+      #
       # ### Next Steps
       # - Read the [Stackdriver Debugger API Product documentation][Product Documentation]
       #   to learn more about the product and see How-to Guides.

data/lib/google/cloud/debugger/v2/controller2_client.rb

@@ -19,6 +19,7 @@
 # For the short term, the refresh process will only be runnable by Google
 # engineers.
 
+
 require "json"
 require "pathname"
 
@@ -55,6 +56,7 @@ module Google
         # @!attribute [r] controller2_stub
         #   @return [Google::Devtools::Clouddebugger::V2::Controller2::Stub]
         class Controller2Client
+          # @private
           attr_reader :controller2_stub
 
           # The default address of the service.

data/lib/google/cloud/debugger/v2/credentials.rb

@@ -12,6 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+
 require "googleauth"
 
 module Google

data/lib/google/cloud/debugger/v2/debugger2_client.rb

@@ -19,6 +19,7 @@
 # For the short term, the refresh process will only be runnable by Google
 # engineers.
 
+
 require "json"
 require "pathname"
 
@@ -47,6 +48,7 @@ module Google
         # @!attribute [r] debugger2_stub
         #   @return [Google::Devtools::Clouddebugger::V2::Debugger2::Stub]
         class Debugger2Client
+          # @private
           attr_reader :debugger2_stub
 
           # The default address of the service.

data/lib/google/cloud/debugger/v2/doc/google/devtools/clouddebugger/v2/controller.rb

@@ -12,6 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+
 module Google
   module Devtools
     module Clouddebugger

data/lib/google/cloud/debugger/v2/doc/google/devtools/clouddebugger/v2/data.rb

@@ -12,6 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+
 module Google
   module Devtools
     module Clouddebugger

data/lib/google/cloud/debugger/v2/doc/google/devtools/clouddebugger/v2/debugger.rb

@@ -12,6 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+
 module Google
   module Devtools
     module Clouddebugger

data/lib/google/cloud/debugger/v2/doc/google/devtools/source/v1/source_context.rb

@@ -12,6 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+
 module Google
   module Devtools
     module Source

data/lib/google/cloud/debugger/v2/doc/google/protobuf/empty.rb

@@ -12,6 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+
 module Google
   module Protobuf
     # A generic empty message that you can re-use to avoid defining duplicated

data/lib/google/cloud/debugger/v2/doc/google/protobuf/timestamp.rb

@@ -12,6 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+
 module Google
   module Protobuf
     # A Timestamp represents a point in time independent of any time zone
@@ -72,12 +73,14 @@ module Google
     #
     # In JSON format, the Timestamp type is encoded as a string in the
     # [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format. That is, the
-    # format is "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z"
-    # where {year} is always expressed using four digits while {month}, {day},
-    # {hour}, {min}, and {sec} are zero-padded to two digits each. The fractional
+    # format is "\\{year}-\\{month}-\\{day}T\\{hour}:\\{min}:\\{sec}[.\\{frac_sec}]Z"
+    # where \\{year} is always expressed using four digits while \\{month}, \\{day},
+    # \\{hour}, \\{min}, and \\{sec} are zero-padded to two digits each. The fractional
     # seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution),
     # are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone
-    # is required, though only UTC (as indicated by "Z") is presently supported.
+    # is required. A proto3 JSON serializer should always use UTC (as indicated by
+    # "Z") when printing the Timestamp type and a proto3 JSON parser should be
+    # able to accept both UTC and other timezones (as indicated by an offset).
     #
     # For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past
     # 01:30 UTC on January 15, 2017.
@@ -88,8 +91,8 @@ module Google
     # to this format using [+strftime+](https://docs.python.org/2/library/time.html#time.strftime)
     # with the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one
     # can use the Joda Time's [+ISODateTimeFormat.dateTime()+](
-    # http://joda-time.sourceforge.net/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime())
-    # to obtain a formatter capable of generating timestamps in this format.
+    # http://www.joda.org/joda-time/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime--
+    # ) to obtain a formatter capable of generating timestamps in this format.
     # @!attribute [rw] seconds
     #   @return [Integer]
     #     Represents seconds of UTC time since Unix epoch

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

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

data/lib/google/devtools/clouddebugger/v2/controller_pb.rb

@@ -1,6 +1,7 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/devtools/clouddebugger/v2/controller.proto
 
+
 require 'google/protobuf'
 
 require 'google/api/annotations_pb'

data/lib/google/devtools/clouddebugger/v2/controller_services_pb.rb

@@ -16,6 +16,7 @@
 # limitations under the License.
 #
 
+
 require 'grpc'
 require 'google/devtools/clouddebugger/v2/controller_pb'
 

data/lib/google/devtools/clouddebugger/v2/data_pb.rb

@@ -1,6 +1,7 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/devtools/clouddebugger/v2/data.proto
 
+
 require 'google/protobuf'
 
 require 'google/api/annotations_pb'

data/lib/google/devtools/clouddebugger/v2/debugger_pb.rb

@@ -1,6 +1,7 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/devtools/clouddebugger/v2/debugger.proto
 
+
 require 'google/protobuf'
 
 require 'google/api/annotations_pb'

data/lib/google/devtools/clouddebugger/v2/debugger_services_pb.rb

@@ -16,6 +16,7 @@
 # limitations under the License.
 #
 
+
 require 'grpc'
 require 'google/devtools/clouddebugger/v2/debugger_pb'
 

data/lib/google/devtools/source/v1/source_context_pb.rb

@@ -1,6 +1,7 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/devtools/source/v1/source_context.proto
 
+
 require 'google/protobuf'
 
 require 'google/api/annotations_pb'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-debugger
 version: !ruby/object:Gem::Version
-  version: 0.32.2
+  version: 0.32.3
 platform: ruby
 authors:
 - Heng Xiong
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-21 00:00:00.000000000 Z
+date: 2018-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: binding_of_caller