README.md in google-cloud-language-v2-0.5.1 vs README.md in google-cloud-language-v2-0.6.0
- old
+ new
@@ -41,35 +41,45 @@
for class and method documentation.
See also the [Product Documentation](https://cloud.google.com/natural-language/docs)
for general usage information.
-## Enabling Logging
+## Debug 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.
+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.
-Configuring a Ruby stdlib logger:
+**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/language/v2"
require "logger"
-module MyLogger
- LOGGER = Logger.new $stderr, level: Logger::WARN
- def logger
- LOGGER
- end
+client = ::Google::Cloud::Language::V2::LanguageService::Client.new do |config|
+ config.logger = Logger.new "my-app.log"
end
-
-# Define a gRPC module-level logger method before grpc/logconfig.rb loads.
-module GRPC
- extend MyLogger
-end
```
-
## Google Cloud Samples
To browse ready to use code samples check [Google Cloud Samples](https://cloud.google.com/docs/samples).