google-cloud-container-v1 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd146a77b25e1eefe12dcc191e140db3ae243830fb6073a9183bfd70de6d326e
-  data.tar.gz: e26017283b6afaf246effd560ed4eb9688f8229facb24347e5d916151812495d
+  metadata.gz: 107dd801240873dc8fad1ea7728399ad37473c98c6d748d68f90d831346204bd
+  data.tar.gz: a6971cd24fdf306c6ac3b53a03856ca6bb6bede1b29e13ef6fbdc36e1bd833de
 SHA512:
-  metadata.gz: 36b402e7fcf74c24ac3520a833f248c40c9be7bd153445adf537bd76687842c3fed7516e5f3b4b4b471303a09d6b2db43063bb68e620c418c3947725b861b37f
-  data.tar.gz: 4d9a09dd1cd7dd48ef840651a6c31f364920d1656d4b26541382a4ee171f45890c165e00c82e5870ee2b6e9abb2c5210fc0cb78d17218dd52fe682caa9d030e3
+  metadata.gz: 3fcc52bc14b0a6035b304d2bbfcb1d01cd3807d68f054061ee0094a4d3bc1a43298c98abb13266569fb81f90a7f7634c94d2ce54dc9f3e71c2ed257427a75ef2
+  data.tar.gz: 196d24d46b6b0065e978a072144295754ad2c2de746cd11ae61b678f182cbdd914baaf20faeeef0848ac5181cf724ea545256ef51577f2ffdc613a19be93aa74

data/README.md

@@ -42,33 +42,43 @@ for class and method documentation.
 See also the [Product Documentation](https://cloud.google.com/kubernetes-engine)
 for general usage information.
 
-## 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/current/stdlibs/logger/Logger.html) as shown below,
-or a [`Google::Cloud::Logging::Logger`](https://cloud.google.com/ruby/docs/reference/google-cloud-logging/latest)
-that will write logs to [Cloud 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:
+## Debug Logging
+
+This library comes with opt-in Debug Logging that can help you troubleshoot
+your application's integration with the API. When logging is activated, key
+events such as requests and responses, along with data payloads and metadata
+such as headers and client configuration, are logged to the standard error
+stream.
+
+**WARNING:** Client Library Debug Logging includes your data payloads in
+plaintext, which could include sensitive data such as PII for yourself or your
+customers, private keys, or other security data that could be compromising if
+leaked. Always practice good data hygiene with your application logs, and follow
+the principle of least access. Google also recommends that Client Library Debug
+Logging be enabled only temporarily during active debugging, and not used
+permanently in production.
+
+To enable logging, set the environment variable `GOOGLE_SDK_RUBY_LOGGING_GEMS`
+to the value `all`. Alternatively, you can set the value to a comma-delimited
+list of client library gem names. This will select the default logging behavior,
+which writes logs to the standard error stream. On a local workstation, this may
+result in logs appearing on the console. When running on a Google Cloud hosting
+service such as [Google Cloud Run](https://cloud.google.com/run), this generally
+results in logs appearing alongside your application logs in the
+[Google Cloud Logging](https://cloud.google.com/logging/) service.
+
+You can customize logging by modifying the `logger` configuration when
+constructing a client object. For example:
 
 ```ruby
+require "google/cloud/container/v1"
 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
+client = ::Google::Cloud::Container::V1::ClusterManager::Client.new do |config|
+  config.logger = Logger.new "my-app.log"
 end
 ```
 
-
 ## Google Cloud Samples
 
 To browse ready to use code samples check [Google Cloud Samples](https://cloud.google.com/docs/samples).

data/lib/google/cloud/container/v1/cluster_manager/client.rb

@@ -244,8 +244,28 @@ module Google
                 universe_domain: @config.universe_domain,
                 channel_args: @config.channel_args,
                 interceptors: @config.interceptors,
-                channel_pool_config: @config.channel_pool
+                channel_pool_config: @config.channel_pool,
+                logger: @config.logger
               )
+
+              @cluster_manager_stub.stub_logger&.info do |entry|
+                entry.set_system_name
+                entry.set_service
+                entry.message = "Created client for #{entry.service}"
+                entry.set_credentials_fields credentials
+                entry.set "customEndpoint", @config.endpoint if @config.endpoint
+                entry.set "defaultTimeout", @config.timeout if @config.timeout
+                entry.set "quotaProject", @quota_project_id if @quota_project_id
+              end
+            end
+
+            ##
+            # The logger used for request/response debug logging.
+            #
+            # @return [Logger]
+            #
+            def logger
+              @cluster_manager_stub.logger
             end
 
             # Service calls
@@ -342,7 +362,6 @@ module Google
 
               @cluster_manager_stub.call_rpc :list_clusters, request, options: options do |response, operation|
                 yield response, operation if block_given?
-                return response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -441,7 +460,6 @@ module Google
 
               @cluster_manager_stub.call_rpc :get_cluster, request, options: options do |response, operation|
                 yield response, operation if block_given?
-                return response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -553,7 +571,6 @@ module Google
 
               @cluster_manager_stub.call_rpc :create_cluster, request, options: options do |response, operation|
                 yield response, operation if block_given?
-                return response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -654,7 +671,6 @@ module Google
 
               @cluster_manager_stub.call_rpc :update_cluster, request, options: options do |response, operation|
                 yield response, operation if block_given?
-                return response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -853,7 +869,6 @@ module Google
 
               @cluster_manager_stub.call_rpc :update_node_pool, request, options: options do |response, operation|
                 yield response, operation if block_given?
-                return response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -958,7 +973,6 @@ module Google
 
               @cluster_manager_stub.call_rpc :set_node_pool_autoscaling, request, options: options do |response, operation|
                 yield response, operation if block_given?
-                return response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -1069,7 +1083,6 @@ module Google
 
               @cluster_manager_stub.call_rpc :set_logging_service, request, options: options do |response, operation|
                 yield response, operation if block_given?
-                return response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -1180,7 +1193,6 @@ module Google
 
               @cluster_manager_stub.call_rpc :set_monitoring_service, request, options: options do |response, operation|
                 yield response, operation if block_given?
-                return response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -1282,7 +1294,6 @@ module Google
 
               @cluster_manager_stub.call_rpc :set_addons_config, request, options: options do |response, operation|
                 yield response, operation if block_given?
-                return response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -1394,7 +1405,6 @@ module Google
 
               @cluster_manager_stub.call_rpc :set_locations, request, options: options do |response, operation|
                 yield response, operation if block_given?
-                return response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -1504,7 +1514,6 @@ module Google
 
               @cluster_manager_stub.call_rpc :update_master, request, options: options do |response, operation|
                 yield response, operation if block_given?
-                return response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -1609,7 +1618,6 @@ module Google
 
               @cluster_manager_stub.call_rpc :set_master_auth, request, options: options do |response, operation|
                 yield response, operation if block_given?
-                return response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -1716,7 +1724,6 @@ module Google
 
               @cluster_manager_stub.call_rpc :delete_cluster, request, options: options do |response, operation|
                 yield response, operation if block_given?
-                return response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -1813,7 +1820,6 @@ module Google
 
               @cluster_manager_stub.call_rpc :list_operations, request, options: options do |response, operation|
                 yield response, operation if block_given?
-                return response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -1912,7 +1918,6 @@ module Google
 
               @cluster_manager_stub.call_rpc :get_operation, request, options: options do |response, operation|
                 yield response, operation if block_given?
-                return response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -2011,7 +2016,6 @@ module Google
 
               @cluster_manager_stub.call_rpc :cancel_operation, request, options: options do |response, operation|
                 yield response, operation if block_given?
-                return response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -2107,7 +2111,6 @@ module Google
 
               @cluster_manager_stub.call_rpc :get_server_config, request, options: options do |response, operation|
                 yield response, operation if block_given?
-                return response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -2195,7 +2198,6 @@ module Google
 
               @cluster_manager_stub.call_rpc :get_json_web_keys, request, options: options do |response, operation|
                 yield response, operation if block_given?
-                return response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -2294,7 +2296,6 @@ module Google
 
               @cluster_manager_stub.call_rpc :list_node_pools, request, options: options do |response, operation|
                 yield response, operation if block_given?
-                return response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -2397,7 +2398,6 @@ module Google
 
               @cluster_manager_stub.call_rpc :get_node_pool, request, options: options do |response, operation|
                 yield response, operation if block_given?
-                return response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -2499,7 +2499,6 @@ module Google
 
               @cluster_manager_stub.call_rpc :create_node_pool, request, options: options do |response, operation|
                 yield response, operation if block_given?
-                return response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -2602,7 +2601,6 @@ module Google
 
               @cluster_manager_stub.call_rpc :delete_node_pool, request, options: options do |response, operation|
                 yield response, operation if block_given?
-                return response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -2691,7 +2689,6 @@ module Google
 
               @cluster_manager_stub.call_rpc :complete_node_pool_upgrade, request, options: options do |response, operation|
                 yield response, operation if block_given?
-                return response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -2798,7 +2795,6 @@ module Google
 
               @cluster_manager_stub.call_rpc :rollback_node_pool_upgrade, request, options: options do |response, operation|
                 yield response, operation if block_given?
-                return response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -2903,7 +2899,6 @@ module Google
 
               @cluster_manager_stub.call_rpc :set_node_pool_management, request, options: options do |response, operation|
                 yield response, operation if block_given?
-                return response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -3011,7 +3006,6 @@ module Google
 
               @cluster_manager_stub.call_rpc :set_labels, request, options: options do |response, operation|
                 yield response, operation if block_given?
-                return response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -3112,7 +3106,6 @@ module Google
 
               @cluster_manager_stub.call_rpc :set_legacy_abac, request, options: options do |response, operation|
                 yield response, operation if block_given?
-                return response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -3213,7 +3206,6 @@ module Google
 
               @cluster_manager_stub.call_rpc :start_ip_rotation, request, options: options do |response, operation|
                 yield response, operation if block_given?
-                return response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -3312,7 +3304,6 @@ module Google
 
               @cluster_manager_stub.call_rpc :complete_ip_rotation, request, options: options do |response, operation|
                 yield response, operation if block_given?
-                return response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -3419,7 +3410,6 @@ module Google
 
               @cluster_manager_stub.call_rpc :set_node_pool_size, request, options: options do |response, operation|
                 yield response, operation if block_given?
-                return response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -3520,7 +3510,6 @@ module Google
 
               @cluster_manager_stub.call_rpc :set_network_policy, request, options: options do |response, operation|
                 yield response, operation if block_given?
-                return response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -3620,7 +3609,6 @@ module Google
 
               @cluster_manager_stub.call_rpc :set_maintenance_policy, request, options: options do |response, operation|
                 yield response, operation if block_given?
-                return response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -3725,7 +3713,7 @@ module Google
               @cluster_manager_stub.call_rpc :list_usable_subnetworks, request, options: options do |response, operation|
                 response = ::Gapic::PagedEnumerable.new @cluster_manager_stub, :list_usable_subnetworks, request, response, operation, options
                 yield response, operation if block_given?
-                return response
+                throw :response, response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -3813,7 +3801,6 @@ module Google
 
               @cluster_manager_stub.call_rpc :check_autopilot_compatibility, request, options: options do |response, operation|
                 yield response, operation if block_given?
-                return response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -3902,6 +3889,11 @@ module Google
             #   default endpoint URL. The default value of nil uses the environment
             #   universe (usually the default "googleapis.com" universe).
             #   @return [::String,nil]
+            # @!attribute [rw] logger
+            #   A custom logger to use for request/response debug logging, or the value
+            #   `:default` (the default) to construct a default logger, or `nil` to
+            #   explicitly disable logging.
+            #   @return [::Logger,:default,nil]
             #
             class Configuration
               extend ::Gapic::Config
@@ -3926,6 +3918,7 @@ module Google
               config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
               config_attr :quota_project, nil, ::String, nil
               config_attr :universe_domain, nil, ::String, nil
+              config_attr :logger, :default, ::Logger, nil, :default
 
               # @private
               def initialize parent_config = nil