google-cloud-data_catalog-v1 1.1.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b0a1e08286cf347edeb16b39bb54f9fd8a9cb261cb0eaef186ae7dba1c817191
-  data.tar.gz: 20a90e0722f47a9b55930c841f92ba24902abaed4efd5806bc11e48bb06321ae
+  metadata.gz: f5fdf2a7b9890e4c91dc7d815cabc2e289c04a959d87873fd163836da072e4bc
+  data.tar.gz: 2392a2ca15e105cf99246ad1f2b1e257645c2476fb59c5ddc7def08604899f2e
 SHA512:
-  metadata.gz: 0a0377656a130a9aca7c2227947eb4c0863389ed1a164c2db8a53dccae81b6e31e9d617dc448ca4986ef35f5b530ff573a2c3ad9c9d8784c2da2027192c38f78
-  data.tar.gz: 411aa9037cce27f3103189bcf9788215d575fb5726e90071bcb2449ee4a099e0791683f0129204932dfb083b95139cfdf68af08b1f04bdfe64b5df1865dd5d34
+  metadata.gz: 423f3dd072cbff107ab56e48807fcf7fc7dfa4ccac5fdfc3505ee6f4939c71670b943a27a26166ce7121661e5ac40eb1108e84590557739fdedeed1e542e98a6
+  data.tar.gz: 05574c10d6eb5944ffcbd6f3927b6d0a4a9a230e2998cd81cc9b4a0fe20881bd8c3f5c5157dc7d6b151ddc8a893807aa4eaec901bf8feafb23208cd95fd7792b

data/README.md

@@ -43,33 +43,43 @@ for class and method documentation.
 See also the [Product Documentation](https://cloud.google.com/data-catalog)
 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/data_catalog/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::DataCatalog::V1::DataCatalog::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).