google-cloud-monitoring 0.28.0 → 0.29.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 698306f2a66ee39a99d5dd4223dad3b3201fc82d393fa192f95f31f34282d7b3
-  data.tar.gz: 13cb6098bedb61afb43de9a45cfe3a742fa42b66d6498bed6e8197268881fc7c
+  metadata.gz: e227a25f90e3c7200e264fcd37e795b7de083f2f7c4652c20809f6a1973a2468
+  data.tar.gz: 10d1553376406242fad4b433e91861b9dc2f4e84488f052584fb87c561cf6672
 SHA512:
-  metadata.gz: f34b68352feab2f4f2187739da695abce2cb53f398d2f9a024deae6193ce74c023740fad65e62d9115d86ab93539aa34e8c78d209c6592761e0d28ab7637de9f
-  data.tar.gz: 15079c30c302de64e4dce7a3845159fd3a5224dd3bce20ac6a0832329f1faccc7a5a15cba1fa13d94f30b6bdf00340b05c168230d26638db1e263338a1a422dd
+  metadata.gz: d1bbd4236966dc0b2b90e1755ccf8dfafe2a533ff9fda90e384ef8700c4df62c19224cc71d08060da2e39f9f4f5a128717e2589bbfdede703efe80d1ba0399a3
+  data.tar.gz: 4bfded835d310bd2538b94bfd224ccce4cd78b7f06e03d52863724a438059d7147c57869905354dad47a35b5acb4bbcf00ea712d7b061f6c29dc0a101e40cf84

data/.yardopts

@@ -2,6 +2,7 @@
 --title=Stackdriver Monitoring API
 --exclude _pb\.rb$
 --markup markdown
+--markup-provider redcarpet
 
 ./lib/**/*.rb
 -

data/README.md

@@ -13,7 +13,7 @@ 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)
 
 ### Installation
@@ -43,17 +43,6 @@ metric_service_client.list_monitored_resource_descriptors(formatted_name).each_p
 end
 ```
 
-### Supported Ruby Versions
-
-This library is supported on Ruby 2.0+.
-
-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.
-
 ### Next Steps
 - Read the [Client Library Documentation][] for Stackdriver Monitoring API
   to see other available methods on the client.
@@ -64,3 +53,40 @@ See https://www.ruby-lang.org/en/downloads/branches/ for further details.
 
 [Client Library Documentation]: https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-monitoring/latest/google/monitoring/v3
 [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
+```
+
+## Supported Ruby Versions
+
+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
+recommended. See https://www.ruby-lang.org/en/downloads/branches/ for details
+about the Ruby support schedule.

data/lib/google/cloud/monitoring.rb

@@ -34,7 +34,7 @@ module Google
     #
     # 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
@@ -67,6 +67,31 @@ module Google
     #
     # [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
@@ -119,6 +144,11 @@ module Google
         #     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 " \
@@ -137,7 +167,7 @@ module Google
       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
@@ -177,6 +207,11 @@ module Google
         #     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 " \
@@ -225,6 +260,11 @@ module Google
         #     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 " \
@@ -273,6 +313,11 @@ module Google
         #     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 " \
@@ -327,6 +372,11 @@ module Google
         #     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 " \

data/lib/google/cloud/monitoring/v3.rb

@@ -17,61 +17,88 @@ require "google/cloud/monitoring/v3/group_service_client"
 require "google/cloud/monitoring/v3/metric_service_client"
 require "google/cloud/monitoring/v3/notification_channel_service_client"
 require "google/cloud/monitoring/v3/uptime_check_service_client"
+require "google/monitoring/v3/span_context_pb"
+require "google/monitoring/v3/dropped_labels_pb"
 
 module Google
   module Cloud
-    # rubocop:disable LineLength
-
-    ##
-    # # Ruby Client for Stackdriver Monitoring API ([Beta](https://github.com/GoogleCloudPlatform/google-cloud-ruby#versioning))
-    #
-    # [Stackdriver Monitoring API][Product Documentation]:
-    # Manages your Stackdriver Monitoring data and configurations. Most projects
-    # must be associated with a Stackdriver account, with a few exceptions as
-    # noted on the individual method pages.
-    # - [Product Documentation][]
-    #
-    # ## Quick Start
-    # 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)
-    # 4. [Setup Authentication.](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
-    #
-    # ### Preview
-    # #### MetricServiceClient
-    # ```rb
-    # require "google/cloud/monitoring/v3"
-    #
-    # metric_service_client = Google::Cloud::Monitoring::V3::Metric.new
-    # formatted_name = Google::Cloud::Monitoring::V3::MetricServiceClient.project_path(project_id)
-    #
-    # # Iterate over all results.
-    # metric_service_client.list_monitored_resource_descriptors(formatted_name).each do |element|
-    #   # Process element.
-    # end
-    #
-    # # Or iterate over results one page at a time.
-    # metric_service_client.list_monitored_resource_descriptors(formatted_name).each_page do |page|
-    #   # Process each page at a time.
-    #   page.each do |element|
-    #     # Process element.
-    #   end
-    # end
-    # ```
-    #
-    # ### Next Steps
-    # - Read the [Stackdriver Monitoring API Product documentation][Product Documentation]
-    #   to learn more about the product and see How-to Guides.
-    # - 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
-    #
-    #
     module Monitoring
+      # rubocop:disable LineLength
+
+      ##
+      # # Ruby Client for Stackdriver Monitoring API ([Beta](https://github.com/GoogleCloudPlatform/google-cloud-ruby#versioning))
+      #
+      # [Stackdriver Monitoring API][Product Documentation]:
+      # Manages your Stackdriver Monitoring data and configurations. Most projects
+      # must be associated with a Stackdriver account, with a few exceptions as
+      # noted on the individual method pages.
+      # - [Product Documentation][]
+      #
+      # ## Quick Start
+      # 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/library/monitoring.googleapis.com)
+      # 4. [Setup Authentication.](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
+      #
+      # ### Preview
+      # #### MetricServiceClient
+      # ```rb
+      # require "google/cloud/monitoring"
+      #
+      # metric_service_client = Google::Cloud::Monitoring::Metric.new(version: :v3)
+      # formatted_name = Google::Cloud::Monitoring::V3::MetricServiceClient.project_path(project_id)
+      #
+      # # Iterate over all results.
+      # metric_service_client.list_monitored_resource_descriptors(formatted_name).each do |element|
+      #   # Process element.
+      # end
+      #
+      # # Or iterate over results one page at a time.
+      # metric_service_client.list_monitored_resource_descriptors(formatted_name).each_page do |page|
+      #   # Process each page at a time.
+      #   page.each do |element|
+      #     # Process element.
+      #   end
+      # end
+      # ```
+      #
+      # ### Next Steps
+      # - Read the [Stackdriver Monitoring API Product documentation][Product Documentation]
+      #   to learn more about the product and see How-to Guides.
+      # - 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 V3
         # rubocop:enable LineLength
 
@@ -111,11 +138,18 @@ module Google
           #   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 \
               credentials: nil,
               scopes: nil,
               client_config: nil,
               timeout: nil,
+              metadata: nil,
+              exception_transformer: nil,
               lib_name: nil,
               lib_version: nil
             kwargs = {
@@ -123,6 +157,8 @@ module Google
               scopes: scopes,
               client_config: client_config,
               timeout: timeout,
+              metadata: metadata,
+              exception_transformer: exception_transformer,
               lib_name: lib_name,
               lib_version: lib_version
             }.select { |_, v| v != nil }
@@ -133,7 +169,7 @@ module Google
         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
@@ -169,11 +205,18 @@ module Google
           #   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 \
               credentials: nil,
               scopes: nil,
               client_config: nil,
               timeout: nil,
+              metadata: nil,
+              exception_transformer: nil,
               lib_name: nil,
               lib_version: nil
             kwargs = {
@@ -181,6 +224,8 @@ module Google
               scopes: scopes,
               client_config: client_config,
               timeout: timeout,
+              metadata: metadata,
+              exception_transformer: exception_transformer,
               lib_name: lib_name,
               lib_version: lib_version
             }.select { |_, v| v != nil }
@@ -217,11 +262,18 @@ module Google
           #   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 \
               credentials: nil,
               scopes: nil,
               client_config: nil,
               timeout: nil,
+              metadata: nil,
+              exception_transformer: nil,
               lib_name: nil,
               lib_version: nil
             kwargs = {
@@ -229,6 +281,8 @@ module Google
               scopes: scopes,
               client_config: client_config,
               timeout: timeout,
+              metadata: metadata,
+              exception_transformer: exception_transformer,
               lib_name: lib_name,
               lib_version: lib_version
             }.select { |_, v| v != nil }
@@ -265,11 +319,18 @@ module Google
           #   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 \
               credentials: nil,
               scopes: nil,
               client_config: nil,
               timeout: nil,
+              metadata: nil,
+              exception_transformer: nil,
               lib_name: nil,
               lib_version: nil
             kwargs = {
@@ -277,6 +338,8 @@ module Google
               scopes: scopes,
               client_config: client_config,
               timeout: timeout,
+              metadata: metadata,
+              exception_transformer: exception_transformer,
               lib_name: lib_name,
               lib_version: lib_version
             }.select { |_, v| v != nil }
@@ -319,11 +382,18 @@ module Google
           #   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 \
               credentials: nil,
               scopes: nil,
               client_config: nil,
               timeout: nil,
+              metadata: nil,
+              exception_transformer: nil,
               lib_name: nil,
               lib_version: nil
             kwargs = {
@@ -331,6 +401,8 @@ module Google
               scopes: scopes,
               client_config: client_config,
               timeout: timeout,
+              metadata: metadata,
+              exception_transformer: exception_transformer,
               lib_name: lib_name,
               lib_version: lib_version
             }.select { |_, v| v != nil }