monitoring.rb in google-cloud-monitoring-0.29.0

- old
+ new

@@ -32,11 +32,11 @@
     # In order to use this library, you first need to go through the following
     # steps:
     #
     # 1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
     # 2. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
-    # 3. [Enable the Stackdriver Monitoring API.](https://console.cloud.google.com/apis/api/monitoring)
+    # 3. [Enable the Stackdriver Monitoring API.](https://console.cloud.google.com/apis/library/monitoring.googleapis.com)
     # 4. [Setup Authentication.](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
     #
     # ### Preview
     # #### MetricServiceClient
     # ```rb
@@ -65,11 +65,36 @@
     # - View this [repository's main README](https://github.com/GoogleCloudPlatform/google-cloud-ruby/blob/master/README.md)
     #   to see the full list of Cloud APIs that we cover.
     #
     # [Product Documentation]: https://cloud.google.com/monitoring
     #
+    # ## 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
+    # ```
+    #
     module Monitoring
       # rubocop:enable LineLength
 
       FILE_DIR = File.realdirpath(Pathname.new(__FILE__).join("..").join("monitoring"))
 
@@ -117,10 +142,15 @@
         #     Google::Gax#construct_settings for the structure of
         #     this data. Falls back to the default config if not specified
         #     or the specified config is missing data points.
         #   @param timeout [Numeric]
         #     The default timeout, in seconds, for calls made through this client.
+        #   @param metadata [Hash]
+        #     Default metadata to be sent with each request. This can be overridden on a per call basis.
+        #   @param exception_transformer [Proc]
+        #     An optional proc that intercepts any exceptions raised during an API call to inject
+        #     custom error handling.
         def self.new(*args, version: :v3, **kwargs)
           unless AVAILABLE_VERSIONS.include?(version.to_s.downcase)
             raise "The version: #{version} is not available. The available versions " \
               "are: [#{AVAILABLE_VERSIONS.join(", ")}]"
           end
@@ -135,11 +165,11 @@
       end
 
       module Group
         ##
         # The Group API lets you inspect and manage your
-        # [groups](https://cloud.google.comgoogle.monitoring.v3.Group).
+        # [groups](https://cloud.google.com#google.monitoring.v3.Group).
         #
         # A group is a named filter that is used to identify
         # a collection of monitored resources. Groups are typically used to
         # mirror the physical and/or logical topology of the environment.
         # Because group membership is computed dynamically, monitored
@@ -175,10 +205,15 @@
         #     Google::Gax#construct_settings for the structure of
         #     this data. Falls back to the default config if not specified
         #     or the specified config is missing data points.
         #   @param timeout [Numeric]
         #     The default timeout, in seconds, for calls made through this client.
+        #   @param metadata [Hash]
+        #     Default metadata to be sent with each request. This can be overridden on a per call basis.
+        #   @param exception_transformer [Proc]
+        #     An optional proc that intercepts any exceptions raised during an API call to inject
+        #     custom error handling.
         def self.new(*args, version: :v3, **kwargs)
           unless AVAILABLE_VERSIONS.include?(version.to_s.downcase)
             raise "The version: #{version} is not available. The available versions " \
               "are: [#{AVAILABLE_VERSIONS.join(", ")}]"
           end
@@ -223,10 +258,15 @@
         #     Google::Gax#construct_settings for the structure of
         #     this data. Falls back to the default config if not specified
         #     or the specified config is missing data points.
         #   @param timeout [Numeric]
         #     The default timeout, in seconds, for calls made through this client.
+        #   @param metadata [Hash]
+        #     Default metadata to be sent with each request. This can be overridden on a per call basis.
+        #   @param exception_transformer [Proc]
+        #     An optional proc that intercepts any exceptions raised during an API call to inject
+        #     custom error handling.
         def self.new(*args, version: :v3, **kwargs)
           unless AVAILABLE_VERSIONS.include?(version.to_s.downcase)
             raise "The version: #{version} is not available. The available versions " \
               "are: [#{AVAILABLE_VERSIONS.join(", ")}]"
           end
@@ -271,10 +311,15 @@
         #     Google::Gax#construct_settings for the structure of
         #     this data. Falls back to the default config if not specified
         #     or the specified config is missing data points.
         #   @param timeout [Numeric]
         #     The default timeout, in seconds, for calls made through this client.
+        #   @param metadata [Hash]
+        #     Default metadata to be sent with each request. This can be overridden on a per call basis.
+        #   @param exception_transformer [Proc]
+        #     An optional proc that intercepts any exceptions raised during an API call to inject
+        #     custom error handling.
         def self.new(*args, version: :v3, **kwargs)
           unless AVAILABLE_VERSIONS.include?(version.to_s.downcase)
             raise "The version: #{version} is not available. The available versions " \
               "are: [#{AVAILABLE_VERSIONS.join(", ")}]"
           end
@@ -325,9 +370,14 @@
         #     Google::Gax#construct_settings for the structure of
         #     this data. Falls back to the default config if not specified
         #     or the specified config is missing data points.
         #   @param timeout [Numeric]
         #     The default timeout, in seconds, for calls made through this client.
+        #   @param metadata [Hash]
+        #     Default metadata to be sent with each request. This can be overridden on a per call basis.
+        #   @param exception_transformer [Proc]
+        #     An optional proc that intercepts any exceptions raised during an API call to inject
+        #     custom error handling.
         def self.new(*args, version: :v3, **kwargs)
           unless AVAILABLE_VERSIONS.include?(version.to_s.downcase)
             raise "The version: #{version} is not available. The available versions " \
               "are: [#{AVAILABLE_VERSIONS.join(", ")}]"
           end