google-cloud-tpu 1.3.1 → 1.4.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: c606ac9c377d75fd069a1d7bf429b2781b71229cb94d2da44b533dca7e1d1e96
4
- data.tar.gz: ed0bded0d1e06bdd6d49a13f3258e03d7d9453d2bff785791cf435da8fd58186
3
+ metadata.gz: b5ed703a2a962df473a1ada26bd419a03256fad55ac50e7d106d7642a24fc1df
4
+ data.tar.gz: 9a5bfa1bce1bb8588da786b8709992557ac9c673c5be70a1bcc0c21c4ded696a
5
5
  SHA512:
6
- metadata.gz: 471eef56d7556e66a7b0e91d44dacbc1a30c45bf0b88c797bc868b1c50373325c4abd9066420803c54be8566418aa79a18dcda015810beb7266327cbb7f1837e
7
- data.tar.gz: b1d3c63945b237cc21c69069bc52bc742ee6f4b2eb9d4e9ef4fa07827fde2a52ad50da2d66ff1f07c6f96e4c36590701035d1fde4a44bccc68f6604fd887a21b
6
+ metadata.gz: 722a49520f9255cf2f3362d971b5e325034ab4c7e42b836cddc3add4e920ee5977646d786e4a0074fb1c0e72881bb3b518ef028a3111cc065c7dc29b42835b67
7
+ data.tar.gz: 985f14f9b059de3fb6f45a450d0ebad7dbc47f81ab96ec9f3a9fe72656bc1e10c469d83f5ba8cfa32c7d13af2e067bc18f215ee21333b20dc2783bc259b4de01
data/README.md CHANGED
@@ -34,35 +34,39 @@ In order to use this library, you first need to go through the following steps:
34
34
  1. [Enable the API.](https://console.cloud.google.com/apis/library/tpu.googleapis.com)
35
35
  1. {file:AUTHENTICATION.md Set up authentication.}
36
36
 
37
- ## Enabling Logging
38
-
39
- To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
40
- The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/current/stdlibs/logger/Logger.html) as shown below,
41
- or a [`Google::Cloud::Logging::Logger`](https://cloud.google.com/ruby/docs/reference/google-cloud-logging/latest)
42
- 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)
43
- and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
44
-
45
- Configuring a Ruby stdlib logger:
46
-
47
- ```ruby
48
- require "logger"
49
-
50
- module MyLogger
51
- LOGGER = Logger.new $stderr, level: Logger::WARN
52
- def logger
53
- LOGGER
54
- end
55
- end
56
-
57
- # Define a gRPC module-level logger method before grpc/logconfig.rb loads.
58
- module GRPC
59
- extend MyLogger
60
- end
61
- ```
37
+ ## Debug Logging
38
+
39
+ This library comes with opt-in Debug Logging that can help you troubleshoot
40
+ your application's integration with the API. When logging is activated, key
41
+ events such as requests and responses, along with data payloads and metadata
42
+ such as headers and client configuration, are logged to the standard error
43
+ stream.
44
+
45
+ **WARNING:** Client Library Debug Logging includes your data payloads in
46
+ plaintext, which could include sensitive data such as PII for yourself or your
47
+ customers, private keys, or other security data that could be compromising if
48
+ leaked. Always practice good data hygiene with your application logs, and follow
49
+ the principle of least access. Google also recommends that Client Library Debug
50
+ Logging be enabled only temporarily during active debugging, and not used
51
+ permanently in production.
52
+
53
+ To enable logging, set the environment variable `GOOGLE_SDK_RUBY_LOGGING_GEMS`
54
+ to the value `all`. Alternatively, you can set the value to a comma-delimited
55
+ list of client library gem names. This will select the default logging behavior,
56
+ which writes logs to the standard error stream. On a local workstation, this may
57
+ result in logs appearing on the console. When running on a Google Cloud hosting
58
+ service such as [Google Cloud Run](https://cloud.google.com/run), this generally
59
+ results in logs appearing alongside your application logs in the
60
+ [Google Cloud Logging](https://cloud.google.com/logging/) service.
61
+
62
+ Debug logging also requires that the versioned clients for this service be
63
+ sufficiently recent, released after about Dec 10, 2024. If logging is not
64
+ working, try updating the versioned clients in your bundle or installed gems:
65
+ [google-cloud-tpu-v1](https://cloud.google.com/ruby/docs/reference/google-cloud-tpu-v1/latest).
62
66
 
63
67
  ## Supported Ruby Versions
64
68
 
65
- This library is supported on Ruby 2.7+.
69
+ This library is supported on Ruby 3.0+.
66
70
 
67
71
  Google provides official support for Ruby versions that are actively supported
68
72
  by Ruby Core—that is, Ruby versions that are either in normal maintenance or
@@ -20,7 +20,7 @@
20
20
  module Google
21
21
  module Cloud
22
22
  module Tpu
23
- VERSION = "1.3.1"
23
+ VERSION = "1.4.0"
24
24
  end
25
25
  end
26
26
  end
@@ -56,6 +56,11 @@ module Google
56
56
  # supported by that API version, and the corresponding gem is available, the
57
57
  # appropriate versioned client will be returned.
58
58
  #
59
+ # Raises an exception if the currently installed versioned client gem for the
60
+ # given API version does not support the Tpu service.
61
+ # You can determine whether the method will succeed by calling
62
+ # {Google::Cloud::Tpu.tpu_available?}.
63
+ #
59
64
  # ## About Tpu
60
65
  #
61
66
  # Manages TPU nodes and other resources
@@ -77,6 +82,32 @@ module Google
77
82
  service_module.const_get(:Client).new(&block)
78
83
  end
79
84
 
85
+ ##
86
+ # Determines whether the Tpu service is supported by the current client.
87
+ # If true, you can retrieve a client object by calling {Google::Cloud::Tpu.tpu}.
88
+ # If false, that method will raise an exception. This could happen if the given
89
+ # API version does not exist or does not support the Tpu service,
90
+ # or if the versioned client gem needs an update to support the Tpu service.
91
+ #
92
+ # @param version [::String, ::Symbol] The API version to connect to. Optional.
93
+ # Defaults to `:v1`.
94
+ # @return [boolean] Whether the service is available.
95
+ #
96
+ def self.tpu_available? version: :v1
97
+ require "google/cloud/tpu/#{version.to_s.downcase}"
98
+ package_name = Google::Cloud::Tpu
99
+ .constants
100
+ .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
101
+ .first
102
+ return false unless package_name
103
+ service_module = Google::Cloud::Tpu.const_get package_name
104
+ return false unless service_module.const_defined? :Tpu
105
+ service_module = service_module.const_get :Tpu
106
+ service_module.const_defined? :Client
107
+ rescue ::LoadError
108
+ false
109
+ end
110
+
80
111
  ##
81
112
  # Configure the google-cloud-tpu library.
82
113
  #
metadata CHANGED
@@ -1,14 +1,13 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-tpu
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.3.1
4
+ version: 1.4.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
- autorequire:
9
8
  bindir: bin
10
9
  cert_chain: []
11
- date: 2024-08-08 00:00:00.000000000 Z
10
+ date: 2025-01-29 00:00:00.000000000 Z
12
11
  dependencies:
13
12
  - !ruby/object:Gem::Dependency
14
13
  name: google-cloud-core
@@ -64,7 +63,6 @@ homepage: https://github.com/googleapis/google-cloud-ruby
64
63
  licenses:
65
64
  - Apache-2.0
66
65
  metadata: {}
67
- post_install_message:
68
66
  rdoc_options: []
69
67
  require_paths:
70
68
  - lib
@@ -72,15 +70,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
72
70
  requirements:
73
71
  - - ">="
74
72
  - !ruby/object:Gem::Version
75
- version: '2.7'
73
+ version: '3.0'
76
74
  required_rubygems_version: !ruby/object:Gem::Requirement
77
75
  requirements:
78
76
  - - ">="
79
77
  - !ruby/object:Gem::Version
80
78
  version: '0'
81
79
  requirements: []
82
- rubygems_version: 3.5.6
83
- signing_key:
80
+ rubygems_version: 3.6.2
84
81
  specification_version: 4
85
82
  summary: API Client library for the Cloud TPU API
86
83
  test_files: []