google-cloud-app_hub-v1 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 41f3c3f24855d32bb67a928f726c3f056d1c748eec84eac05fa1ea4637e1b556
-  data.tar.gz: 34918006722b5758f380f65eb36a473706ff44c4a7e74ca0f0cbd8f1aeef8370
+  metadata.gz: 9a0d3cb825d26d2cec87910bf40755d48e04a635cf9b30189b8893531aae6976
+  data.tar.gz: 78939c69a3be1a6a36eee4d6c54b37c323ae8a950220e418cf68296bddbd4bf8
 SHA512:
-  metadata.gz: 8c687b597a1c113b6f428ba49f85d3cdc7bb5fdcf7dd91ed190bd6cfc1c5abbea7ee46801436edaea29d0100867ead4649b899867a90f51cd303663ce10a348a
-  data.tar.gz: d9b8bf0ade4ac2c215b1ec05c2fac9e20cea409a0bc4450286f087264e7bc51c3d8cb5e1bf51ac7f777960d65ec2718d2000634d19f66b8b8c1ec930f267732c
+  metadata.gz: 3918e8de322af8cb774009a46344ab8295d196441509885fdfbba566ceea09e77fc6f050cf0211be8dde9531baf941c11af6efa00d3e570af04a98b419484a84
+  data.tar.gz: 0d558d0695594d49d4dd3622ec42c64301958aa87d30167b79820a47f3edea307e69e32650a3da628b15cbfa5d0e5bad21af1180c13989e2f4eb836af466db55

data/README.md

@@ -43,33 +43,43 @@ for class and method documentation.
 See also the [Product Documentation](https://cloud.google.com/app-hub/docs/overview)
 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/app_hub/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::AppHub::V1::AppHub::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).