google-cloud-profiler 1.4.2 → 1.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 849d1db11fa8699f177d94454760ec507785c54e88b0513ccbd514bc2a3913ff
-  data.tar.gz: 9edaebf1fd7616af15307bd47c0ec48317d5622bf2300b86581580b56e1f41db
+  metadata.gz: 47ad53b7a691d03278c4983ee6dcffded4d9a241406af4061946e2bf84ad741f
+  data.tar.gz: dfd863222e9c939eae08fac90777b2ddfc8b151da65289fcf3550d97ef1ff9d8
 SHA512:
-  metadata.gz: 154aa6f3f4bc1ed9995960de02a5209f3edc599d070b778a7e8c03e520b43b28afa3be1f08ef101d1787a1ef80c2057a71f7fbcc14752bf1aa77e9a3c8e6d3b3
-  data.tar.gz: 80b4f1fd678c49741c9ad83f5c7497092bef6428b2fded777dfdaab3cc9e5e9704fbb8df8c84b441f95a51ced598e3115d605780b2977c7dffce698b8206148c
+  metadata.gz: 117698e347343a2f872fc31a4b7f016150bb19c3bcf05cd1c855be5d96ceac340056424841682410a121b6cf961c1589ef998ef26b6ae065fdeed1436e9f0b64
+  data.tar.gz: c4c3ec2bcd2c30bef20533023a7a73839404e2602b07c0535aea1b535b0b65fc983a972febb68c44c367c357120fc239c7ddbbb14ef3d5cb829b8da469e1d4c0

data/README.md

@@ -7,7 +7,7 @@ Cloud Profiler is a statistical, low-overhead profiler that continuously gathers
 Actual client classes for the various versions of this API are defined in
 _versioned_ client gems, with names of the form `google-cloud-profiler-v*`.
 The gem `google-cloud-profiler` is the main client library that brings the
-verisoned gems in as dependencies, and provides high-level methods for
+versioned gems in as dependencies, and provides high-level methods for
 constructing clients. More information on versioned clients can be found below
 in the section titled *Which client should I use?*.
 
@@ -34,9 +34,39 @@ In order to use this library, you first need to go through the following steps:
 1. [Enable the API.](https://console.cloud.google.com/apis/library/cloudprofiler.googleapis.com)
 1. {file:AUTHENTICATION.md Set up authentication.}
 
+## 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.
+
+Debug logging also requires that the versioned clients for this service be
+sufficiently recent, released after about Dec 10, 2024. If logging is not
+working, try updating the versioned clients in your bundle or installed gems:
+[google-cloud-profiler-v2](https://cloud.google.com/ruby/docs/reference/google-cloud-profiler-v2/latest).
+
 ## Supported Ruby Versions
 
-This library is supported on Ruby 2.7+.
+This library is supported on Ruby 3.0+.
 
 Google provides official support for Ruby versions that are actively supported
 by Ruby Core—that is, Ruby versions that are either in normal maintenance or

data/lib/google/cloud/profiler/version.rb

@@ -20,7 +20,7 @@
 module Google
   module Cloud
     module Profiler
-      VERSION = "1.4.2"
+      VERSION = "1.5.1"
     end
   end
 end

data/lib/google/cloud/profiler.rb

@@ -58,6 +58,11 @@ module Google
       # You can also specify a different transport by passing `:rest` or `:grpc` in
       # the `transport` parameter.
       #
+      # Raises an exception if the currently installed versioned client gem for the
+      # given API version does not support the given transport of the ProfilerService service.
+      # You can determine whether the method will succeed by calling
+      # {Google::Cloud::Profiler.profiler_service_available?}.
+      #
       # ## About ProfilerService
       #
       # Manage the collection of continuous profiling data provided by profiling
@@ -83,6 +88,37 @@ module Google
         service_module.const_get(:Client).new(&block)
       end
 
+      ##
+      # Determines whether the ProfilerService service is supported by the current client.
+      # If true, you can retrieve a client object by calling {Google::Cloud::Profiler.profiler_service}.
+      # If false, that method will raise an exception. This could happen if the given
+      # API version does not exist or does not support the ProfilerService service,
+      # or if the versioned client gem needs an update to support the ProfilerService service.
+      #
+      # @param version [::String, ::Symbol] The API version to connect to. Optional.
+      #   Defaults to `:v2`.
+      # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
+      # @return [boolean] Whether the service is available.
+      #
+      def self.profiler_service_available? version: :v2, transport: :grpc
+        require "google/cloud/profiler/#{version.to_s.downcase}"
+        package_name = Google::Cloud::Profiler
+                       .constants
+                       .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                       .first
+        return false unless package_name
+        service_module = Google::Cloud::Profiler.const_get package_name
+        return false unless service_module.const_defined? :ProfilerService
+        service_module = service_module.const_get :ProfilerService
+        if transport == :rest
+          return false unless service_module.const_defined? :Rest
+          service_module = service_module.const_get :Rest
+        end
+        service_module.const_defined? :Client
+      rescue ::LoadError
+        false
+      end
+
       ##
       # Create a new client object for ExportService.
       #
@@ -96,6 +132,11 @@ module Google
       # You can also specify a different transport by passing `:rest` or `:grpc` in
       # the `transport` parameter.
       #
+      # Raises an exception if the currently installed versioned client gem for the
+      # given API version does not support the given transport of the ExportService service.
+      # You can determine whether the method will succeed by calling
+      # {Google::Cloud::Profiler.export_service_available?}.
+      #
       # ## About ExportService
       #
       # Service allows existing Cloud Profiler customers to export their profile data
@@ -118,6 +159,37 @@ module Google
         service_module.const_get(:Client).new(&block)
       end
 
+      ##
+      # Determines whether the ExportService service is supported by the current client.
+      # If true, you can retrieve a client object by calling {Google::Cloud::Profiler.export_service}.
+      # If false, that method will raise an exception. This could happen if the given
+      # API version does not exist or does not support the ExportService service,
+      # or if the versioned client gem needs an update to support the ExportService service.
+      #
+      # @param version [::String, ::Symbol] The API version to connect to. Optional.
+      #   Defaults to `:v2`.
+      # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
+      # @return [boolean] Whether the service is available.
+      #
+      def self.export_service_available? version: :v2, transport: :grpc
+        require "google/cloud/profiler/#{version.to_s.downcase}"
+        package_name = Google::Cloud::Profiler
+                       .constants
+                       .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                       .first
+        return false unless package_name
+        service_module = Google::Cloud::Profiler.const_get package_name
+        return false unless service_module.const_defined? :ExportService
+        service_module = service_module.const_get :ExportService
+        if transport == :rest
+          return false unless service_module.const_defined? :Rest
+          service_module = service_module.const_get :Rest
+        end
+        service_module.const_defined? :Client
+      rescue ::LoadError
+        false
+      end
+
       ##
       # Configure the google-cloud-profiler library.
       #

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-profiler
 version: !ruby/object:Gem::Version
-  version: 1.4.2
+  version: 1.5.1
 platform: ruby
 authors:
 - Google LLC
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-08-09 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-core
@@ -65,7 +64,6 @@ homepage: https://github.com/googleapis/google-cloud-ruby
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -73,15 +71,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.6
-signing_key: 
+rubygems_version: 3.6.8
 specification_version: 4
 summary: API Client library for the Cloud Profiler API
 test_files: []