google-cloud-bare_metal_solution-v2 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d3c86395365032dbcb759282f922510f709059fa62494ca25349f1598de6f05c
-  data.tar.gz: 24573fc97e60537e3fb3b9c14c285aaa0232882be931b49f3861e0f7f06d55ee
+  metadata.gz: a890ccd7da5fbd131017305e097324e2f1d38bdb88cadb216d82c50cd671ddcc
+  data.tar.gz: 14b6786d179b60850fd29f954ed76b1c747e64f5fb99518c3377f5ac22646c2d
 SHA512:
-  metadata.gz: 0bc86cd7a8fb206d34164058856f6ab494adb889bfdf7c3cdb28c05f5ac4e9ec5ba50b7e588530459a1218cd7977c6b34504a4ce427da59671498c54df8826af
-  data.tar.gz: acf90d60d295f86f0eae679b80ec2ff9f317bed0e9512f0e2faca453010ce82da3b915fb18ca5e962fe86513058c9efcfdc1b08cbd5f308bde025dce1edeea24
+  metadata.gz: b63ff6d8b77b5ee6bc606fa9e72d9cc1b264089c4d97e4747b5d6e7ee2ae3dc29f3acb5dedb4fb029d2b8731ffeae22631a4e38fe7ba9b86de0d176f5fd33503
+  data.tar.gz: 5c2b8e3e7378601c46eeed683215e150a4a31e7d9f511d2801ab0b9ce0aeac6e542c4623012dcebe8f5d7444a5ecc0e10c1b814e9a0dc6d959aa5f45600bc844

data/README.md

@@ -43,33 +43,43 @@ for class and method documentation.
 See also the [Product Documentation](https://cloud.google.com/bare-metal/)
 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/bare_metal_solution/v2"
 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::BareMetalSolution::V2::BareMetalSolution::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).