google-cloud-contact_center_insights-v1 1.2.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7bedbc63d737d94e65e9f5223a622669800dbbdb0a560469aee41c937ae38301
-  data.tar.gz: 3a2ea64bfa20e9189fd72c9e933ba759b47604c6f9da4986ca060380e351141c
+  metadata.gz: 38e3c3cf0f4040b519c8435505b9a42b081da7ece95f7abfcb05f0254bc23591
+  data.tar.gz: e2f3b4623b4d1f9e38ca46e1bf9295546b48c70df7c074ad5b5e2196d5840405
 SHA512:
-  metadata.gz: 73dbda9bdf98f7b96d8a056c06dae30199c5b441c422ebe93fc245130f6ec23a904f903e24c68125d83fbdebba18234dccd96e8f2f73bddead52938f24588ece
-  data.tar.gz: 13bd2642322ef64ef62ea47261fc500ddbe0ee1621c0bcc63dd29ff435190fd43d56e8f34e67388fc70cd32668325c0f9cf4f11c98042b854f1b41c34390dcf4
+  metadata.gz: 3f2ebda1fabf5d5d8e4515ba237f46e990ffc3548d59c4c5755b7e581fe19b3baa8396e4a448d9bbe40dac7aa29e0653987781f62195442824e3dd923c57b2ad
+  data.tar.gz: e9ee88a642b57a34acca61d01552aed6d644bced39c631cd7d22681df6dbd719d464a9afd58e004e47f0b2a6b41b4ecbdebe5d8a7963f03956badbed3827bd1a

data/README.md

@@ -43,33 +43,43 @@ for class and method documentation.
 See also the [Product Documentation](https://cloud.google.com/contact-center/insights/docs)
 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/contact_center_insights/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::ContactCenterInsights::V1::ContactCenterInsights::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).