google-cloud-container_analysis 1.4.1 → 1.5.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: 1998d767adda92cea574547356fa8cc21da9ae15011b6ed06612fff7b639a68b
4
- data.tar.gz: 951a4480f6a8b090868347a259018d867045fc4be7e6cc4dd08385ed0b7d117b
3
+ metadata.gz: 8fcc665760ab58809b3c26e65b602632ef610673ada340334fd72cd39f02421f
4
+ data.tar.gz: b11de1e7d293347ccf6ea399359dc29569d5b3cdd81b68857dbe208f9bf82c22
5
5
  SHA512:
6
- metadata.gz: fc0fe882b9c92423099d4138c0a3fce3ba9873da94e9c05bc3c9744fe07de5513c9f5282a218add8fd01a4e1739fe45c8d4b3b428d8d374b3c2b7e5edff94de4
7
- data.tar.gz: 36681d8f736e47dc2e46f7e4928116094412801f3b0056f50646a2d6e9e5b538f5fb9f9589977cf81cb6f09f59fc858720e25c854810f528b2516da2732fbc01
6
+ metadata.gz: df9396e643322e3fdd9e473926a4389f32d122c387cbc660d397ff164bef55b73ba7576af40f18816fccd0d7d0d9145eb0cfeb7ec46e9a32e2306e9e4e6b3f92
7
+ data.tar.gz: feae3b54b0eaced27082ef04c58b188cfefe0cfa14d46ba334f3b5f02e88599e26b350e8890d60aaa9f3aef2510bf641f004cb8099048b60d82a96a8ea1fba2d
data/README.md CHANGED
@@ -42,35 +42,39 @@ and includes substantial interface changes. Existing code written for earlier
42
42
  versions of this library will likely require updates to use this version.
43
43
  See the {file:MIGRATING.md MIGRATING.md} document for more information.
44
44
 
45
- ## Enabling Logging
46
-
47
- To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
48
- The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/current/stdlibs/logger/Logger.html) as shown below,
49
- or a [`Google::Cloud::Logging::Logger`](https://cloud.google.com/ruby/docs/reference/google-cloud-logging/latest)
50
- 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)
51
- and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
52
-
53
- Configuring a Ruby stdlib logger:
54
-
55
- ```ruby
56
- require "logger"
57
-
58
- module MyLogger
59
- LOGGER = Logger.new $stderr, level: Logger::WARN
60
- def logger
61
- LOGGER
62
- end
63
- end
64
-
65
- # Define a gRPC module-level logger method before grpc/logconfig.rb loads.
66
- module GRPC
67
- extend MyLogger
68
- end
69
- ```
45
+ ## Debug Logging
46
+
47
+ This library comes with opt-in Debug Logging that can help you troubleshoot
48
+ your application's integration with the API. When logging is activated, key
49
+ events such as requests and responses, along with data payloads and metadata
50
+ such as headers and client configuration, are logged to the standard error
51
+ stream.
52
+
53
+ **WARNING:** Client Library Debug Logging includes your data payloads in
54
+ plaintext, which could include sensitive data such as PII for yourself or your
55
+ customers, private keys, or other security data that could be compromising if
56
+ leaked. Always practice good data hygiene with your application logs, and follow
57
+ the principle of least access. Google also recommends that Client Library Debug
58
+ Logging be enabled only temporarily during active debugging, and not used
59
+ permanently in production.
60
+
61
+ To enable logging, set the environment variable `GOOGLE_SDK_RUBY_LOGGING_GEMS`
62
+ to the value `all`. Alternatively, you can set the value to a comma-delimited
63
+ list of client library gem names. This will select the default logging behavior,
64
+ which writes logs to the standard error stream. On a local workstation, this may
65
+ result in logs appearing on the console. When running on a Google Cloud hosting
66
+ service such as [Google Cloud Run](https://cloud.google.com/run), this generally
67
+ results in logs appearing alongside your application logs in the
68
+ [Google Cloud Logging](https://cloud.google.com/logging/) service.
69
+
70
+ Debug logging also requires that the versioned clients for this service be
71
+ sufficiently recent, released after about Dec 10, 2024. If logging is not
72
+ working, try updating the versioned clients in your bundle or installed gems:
73
+ [google-cloud-container_analysis-v1](https://cloud.google.com/ruby/docs/reference/google-cloud-container_analysis-v1/latest).
70
74
 
71
75
  ## Supported Ruby Versions
72
76
 
73
- This library is supported on Ruby 2.7+.
77
+ This library is supported on Ruby 3.0+.
74
78
 
75
79
  Google provides official support for Ruby versions that are actively supported
76
80
  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 ContainerAnalysis
23
- VERSION = "1.4.1"
23
+ VERSION = "1.5.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 ContainerAnalysis service.
61
+ # You can determine whether the method will succeed by calling
62
+ # {Google::Cloud::ContainerAnalysis.container_analysis_available?}.
63
+ #
59
64
  # ## About ContainerAnalysis
60
65
  #
61
66
  # Retrieves analysis results of Cloud components such as Docker container
@@ -87,6 +92,32 @@ module Google
87
92
  service_module.const_get(:Client).new(&block)
88
93
  end
89
94
 
95
+ ##
96
+ # Determines whether the ContainerAnalysis service is supported by the current client.
97
+ # If true, you can retrieve a client object by calling {Google::Cloud::ContainerAnalysis.container_analysis}.
98
+ # If false, that method will raise an exception. This could happen if the given
99
+ # API version does not exist or does not support the ContainerAnalysis service,
100
+ # or if the versioned client gem needs an update to support the ContainerAnalysis service.
101
+ #
102
+ # @param version [::String, ::Symbol] The API version to connect to. Optional.
103
+ # Defaults to `:v1`.
104
+ # @return [boolean] Whether the service is available.
105
+ #
106
+ def self.container_analysis_available? version: :v1
107
+ require "google/cloud/container_analysis/#{version.to_s.downcase}"
108
+ package_name = Google::Cloud::ContainerAnalysis
109
+ .constants
110
+ .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
111
+ .first
112
+ return false unless package_name
113
+ service_module = Google::Cloud::ContainerAnalysis.const_get package_name
114
+ return false unless service_module.const_defined? :ContainerAnalysis
115
+ service_module = service_module.const_get :ContainerAnalysis
116
+ service_module.const_defined? :Client
117
+ rescue ::LoadError
118
+ false
119
+ end
120
+
90
121
  ##
91
122
  # Configure the google-cloud-container_analysis library.
92
123
  #
metadata CHANGED
@@ -1,14 +1,13 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-container_analysis
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.4.1
4
+ version: 1.5.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-09 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-container_analysis-v1
@@ -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 Container Analysis API
86
83
  test_files: []