google-cloud-profiler-v2 0.3.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 92a0d5cf51fcf308728b94cced0ea804e5715d4e5661530c90f0d17880f9a3ea
-  data.tar.gz: d3a4320b3d7a6ff218b9d2fadf5358bfa4a1fdd158a4e4bf35909cd42f3f4692
+  metadata.gz: efdd220cd101cddf7abceed853ec2d3b06d61270a0efc737f9ef648d80fb149c
+  data.tar.gz: aa263ad4f17eb38eef30940e11b1caa20e6eb685399f62a2d15ee5032272e765
 SHA512:
-  metadata.gz: ad6763481dffc7aa69117035e16a593f2e393589ca13ecc007537a1ab1d7b14e681cdb1d656f4547362fb19af7ea457fa2ce0b83ef5cb4faada2dacd08b0c727
-  data.tar.gz: 5dca168afea8bd26c732d060601d4e9574cd579099d744a522e59131430c62ad7a2575e122cd6e01d019d4ff3e5a277e4fe95c001fd354b637366824e85e075d
+  metadata.gz: a2b3303a9f00c21b2e4585bfcbcab7744b53376f2abc57d2141ad36451080dea2ca8e07118f4c8f0023472bedc55bf4ca577ac9794f088d274295b9e0ca596bc
+  data.tar.gz: 27ca71c9d12361494cc64f5b1d28ded0fb7b7331d1c8ebab427cbe92b6783e44c455893a4f59e01c46ff80d002a4042b3105f910412b019f2c118ca7f530b9b6

data/AUTHENTICATION.md

@@ -114,7 +114,7 @@ credentials are discovered.
 To configure your system for this, simply:
 
 1. [Download and install the Cloud SDK](https://cloud.google.com/sdk)
-2. Authenticate using OAuth 2.0 `$ gcloud auth login`
+2. Authenticate using OAuth 2.0 `$ gcloud auth application-default login`
 3. Write code as if already authenticated.
 
 **NOTE:** This is _not_ recommended for running in production. The Cloud SDK

data/README.md

@@ -1,6 +1,6 @@
 # Ruby Client for the Cloud Profiler V2 API
 
-API Client library for the Cloud Profiler V2 API
+Manages continuous profiling information.
 
 Cloud Profiler is a statistical, low-overhead profiler that continuously gathers CPU usage and memory-allocation information from your production applications. It attributes that information to the application's source code, helping you identify the parts of the application consuming the most resources, and otherwise illuminating the performance characteristics of the code.
 
@@ -46,8 +46,8 @@ 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/stdlib/libdoc/logger/rdoc/Logger.html) as shown below,
-or a [`Google::Cloud::Logging::Logger`](https://googleapis.dev/ruby/google-cloud-logging/latest)
+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.
 

data/lib/google/cloud/profiler/v2/export_service/client.rb

@@ -0,0 +1,419 @@
+# frozen_string_literal: true
+
+# Copyright 2023 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+require "google/cloud/errors"
+require "google/devtools/cloudprofiler/v2/profiler_pb"
+
+module Google
+  module Cloud
+    module Profiler
+      module V2
+        module ExportService
+          ##
+          # Client for the ExportService service.
+          #
+          # Service allows existing Cloud Profiler customers to export their profile data
+          # out of Google Cloud.
+          #
+          class Client
+            include Paths
+
+            # @private
+            attr_reader :export_service_stub
+
+            ##
+            # Configure the ExportService Client class.
+            #
+            # See {::Google::Cloud::Profiler::V2::ExportService::Client::Configuration}
+            # for a description of the configuration fields.
+            #
+            # @example
+            #
+            #   # Modify the configuration for all ExportService clients
+            #   ::Google::Cloud::Profiler::V2::ExportService::Client.configure do |config|
+            #     config.timeout = 10.0
+            #   end
+            #
+            # @yield [config] Configure the Client client.
+            # @yieldparam config [Client::Configuration]
+            #
+            # @return [Client::Configuration]
+            #
+            def self.configure
+              @configure ||= begin
+                namespace = ["Google", "Cloud", "Profiler", "V2"]
+                parent_config = while namespace.any?
+                                  parent_name = namespace.join "::"
+                                  parent_const = const_get parent_name
+                                  break parent_const.configure if parent_const.respond_to? :configure
+                                  namespace.pop
+                                end
+                default_config = Client::Configuration.new parent_config
+
+                default_config.timeout = 130.0
+                default_config.retry_policy = {
+                  initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
+                }
+
+                default_config
+              end
+              yield @configure if block_given?
+              @configure
+            end
+
+            ##
+            # Configure the ExportService Client instance.
+            #
+            # The configuration is set to the derived mode, meaning that values can be changed,
+            # but structural changes (adding new fields, etc.) are not allowed. Structural changes
+            # should be made on {Client.configure}.
+            #
+            # See {::Google::Cloud::Profiler::V2::ExportService::Client::Configuration}
+            # for a description of the configuration fields.
+            #
+            # @yield [config] Configure the Client client.
+            # @yieldparam config [Client::Configuration]
+            #
+            # @return [Client::Configuration]
+            #
+            def configure
+              yield @config if block_given?
+              @config
+            end
+
+            ##
+            # Create a new ExportService client object.
+            #
+            # @example
+            #
+            #   # Create a client using the default configuration
+            #   client = ::Google::Cloud::Profiler::V2::ExportService::Client.new
+            #
+            #   # Create a client using a custom configuration
+            #   client = ::Google::Cloud::Profiler::V2::ExportService::Client.new do |config|
+            #     config.timeout = 10.0
+            #   end
+            #
+            # @yield [config] Configure the ExportService client.
+            # @yieldparam config [Client::Configuration]
+            #
+            def initialize
+              # These require statements are intentionally placed here to initialize
+              # the gRPC module only when it's required.
+              # See https://github.com/googleapis/toolkit/issues/446
+              require "gapic/grpc"
+              require "google/devtools/cloudprofiler/v2/profiler_services_pb"
+
+              # Create the configuration object
+              @config = Configuration.new Client.configure
+
+              # Yield the configuration if needed
+              yield @config if block_given?
+
+              # Create credentials
+              credentials = @config.credentials
+              # Use self-signed JWT if the endpoint is unchanged from default,
+              # but only if the default endpoint does not have a region prefix.
+              enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
+                                       !@config.endpoint.split(".").first.include?("-")
+              credentials ||= Credentials.default scope: @config.scope,
+                                                  enable_self_signed_jwt: enable_self_signed_jwt
+              if credentials.is_a?(::String) || credentials.is_a?(::Hash)
+                credentials = Credentials.new credentials, scope: @config.scope
+              end
+              @quota_project_id = @config.quota_project
+              @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
+
+              @export_service_stub = ::Gapic::ServiceStub.new(
+                ::Google::Cloud::Profiler::V2::ExportService::Stub,
+                credentials:  credentials,
+                endpoint:     @config.endpoint,
+                channel_args: @config.channel_args,
+                interceptors: @config.interceptors,
+                channel_pool_config: @config.channel_pool
+              )
+            end
+
+            # Service calls
+
+            ##
+            # Lists profiles which have been collected so far and for which the caller
+            # has permission to view.
+            #
+            # @overload list_profiles(request, options = nil)
+            #   Pass arguments to `list_profiles` via a request object, either of type
+            #   {::Google::Cloud::Profiler::V2::ListProfilesRequest} or an equivalent Hash.
+            #
+            #   @param request [::Google::Cloud::Profiler::V2::ListProfilesRequest, ::Hash]
+            #     A request object representing the call parameters. Required. To specify no
+            #     parameters, or to keep all the default parameter values, pass an empty Hash.
+            #   @param options [::Gapic::CallOptions, ::Hash]
+            #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
+            #
+            # @overload list_profiles(parent: nil, page_size: nil, page_token: nil)
+            #   Pass arguments to `list_profiles` via keyword arguments. Note that at
+            #   least one keyword argument is required. To specify no parameters, or to keep all
+            #   the default parameter values, pass an empty Hash as a request object (see above).
+            #
+            #   @param parent [::String]
+            #     Required. The parent, which owns this collection of profiles.
+            #     Format: projects/\\{user_project_id}
+            #   @param page_size [::Integer]
+            #     The maximum number of items to return.
+            #     Default page_size is 1000.
+            #     Max limit is 10000.
+            #   @param page_token [::String]
+            #     The token to continue pagination and get profiles from a particular page.
+            #     When paginating, all other parameters provided to `ListProfiles` must match
+            #     the call that provided the page token.
+            #
+            # @yield [response, operation] Access the result along with the RPC operation
+            # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Profiler::V2::Profile>]
+            # @yieldparam operation [::GRPC::ActiveCall::Operation]
+            #
+            # @return [::Gapic::PagedEnumerable<::Google::Cloud::Profiler::V2::Profile>]
+            #
+            # @raise [::Google::Cloud::Error] if the RPC is aborted.
+            #
+            # @example Basic example
+            #   require "google/cloud/profiler/v2"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Profiler::V2::ExportService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Profiler::V2::ListProfilesRequest.new
+            #
+            #   # Call the list_profiles method.
+            #   result = client.list_profiles request
+            #
+            #   # The returned object is of type Gapic::PagedEnumerable. You can iterate
+            #   # over elements, and API calls will be issued to fetch pages as needed.
+            #   result.each do |item|
+            #     # Each element is of type ::Google::Cloud::Profiler::V2::Profile.
+            #     p item
+            #   end
+            #
+            def list_profiles request, options = nil
+              raise ::ArgumentError, "request must be provided" if request.nil?
+
+              request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Profiler::V2::ListProfilesRequest
+
+              # Converts hash and nil to an options object
+              options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
+
+              # Customize the options with defaults
+              metadata = @config.rpcs.list_profiles.metadata.to_h
+
+              # Set x-goog-api-client and x-goog-user-project headers
+              metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
+                lib_name: @config.lib_name, lib_version: @config.lib_version,
+                gapic_version: ::Google::Cloud::Profiler::V2::VERSION
+              metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+              header_params = {}
+              if request.parent
+                header_params["parent"] = request.parent
+              end
+
+              request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
+              metadata[:"x-goog-request-params"] ||= request_params_header
+
+              options.apply_defaults timeout:      @config.rpcs.list_profiles.timeout,
+                                     metadata:     metadata,
+                                     retry_policy: @config.rpcs.list_profiles.retry_policy
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
+                                     retry_policy: @config.retry_policy
+
+              @export_service_stub.call_rpc :list_profiles, request, options: options do |response, operation|
+                response = ::Gapic::PagedEnumerable.new @export_service_stub, :list_profiles, request, response, operation, options
+                yield response, operation if block_given?
+                return response
+              end
+            rescue ::GRPC::BadStatus => e
+              raise ::Google::Cloud::Error.from_error(e)
+            end
+
+            ##
+            # Configuration class for the ExportService API.
+            #
+            # This class represents the configuration for ExportService,
+            # providing control over timeouts, retry behavior, logging, transport
+            # parameters, and other low-level controls. Certain parameters can also be
+            # applied individually to specific RPCs. See
+            # {::Google::Cloud::Profiler::V2::ExportService::Client::Configuration::Rpcs}
+            # for a list of RPCs that can be configured independently.
+            #
+            # Configuration can be applied globally to all clients, or to a single client
+            # on construction.
+            #
+            # @example
+            #
+            #   # Modify the global config, setting the timeout for
+            #   # list_profiles to 20 seconds,
+            #   # and all remaining timeouts to 10 seconds.
+            #   ::Google::Cloud::Profiler::V2::ExportService::Client.configure do |config|
+            #     config.timeout = 10.0
+            #     config.rpcs.list_profiles.timeout = 20.0
+            #   end
+            #
+            #   # Apply the above configuration only to a new client.
+            #   client = ::Google::Cloud::Profiler::V2::ExportService::Client.new do |config|
+            #     config.timeout = 10.0
+            #     config.rpcs.list_profiles.timeout = 20.0
+            #   end
+            #
+            # @!attribute [rw] endpoint
+            #   The hostname or hostname:port of the service endpoint.
+            #   Defaults to `"cloudprofiler.googleapis.com"`.
+            #   @return [::String]
+            # @!attribute [rw] credentials
+            #   Credentials to send with calls. You may provide any of the following types:
+            #    *  (`String`) The path to a service account key file in JSON format
+            #    *  (`Hash`) A service account key as a Hash
+            #    *  (`Google::Auth::Credentials`) A googleauth credentials object
+            #       (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
+            #    *  (`Signet::OAuth2::Client`) A signet oauth2 client object
+            #       (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
+            #    *  (`GRPC::Core::Channel`) a gRPC channel with included credentials
+            #    *  (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
+            #    *  (`nil`) indicating no credentials
+            #   @return [::Object]
+            # @!attribute [rw] scope
+            #   The OAuth scopes
+            #   @return [::Array<::String>]
+            # @!attribute [rw] lib_name
+            #   The library name as recorded in instrumentation and logging
+            #   @return [::String]
+            # @!attribute [rw] lib_version
+            #   The library version as recorded in instrumentation and logging
+            #   @return [::String]
+            # @!attribute [rw] channel_args
+            #   Extra parameters passed to the gRPC channel. Note: this is ignored if a
+            #   `GRPC::Core::Channel` object is provided as the credential.
+            #   @return [::Hash]
+            # @!attribute [rw] interceptors
+            #   An array of interceptors that are run before calls are executed.
+            #   @return [::Array<::GRPC::ClientInterceptor>]
+            # @!attribute [rw] timeout
+            #   The call timeout in seconds.
+            #   @return [::Numeric]
+            # @!attribute [rw] metadata
+            #   Additional gRPC headers to be sent with the call.
+            #   @return [::Hash{::Symbol=>::String}]
+            # @!attribute [rw] retry_policy
+            #   The retry policy. The value is a hash with the following keys:
+            #    *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
+            #    *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
+            #    *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
+            #    *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
+            #       trigger a retry.
+            #   @return [::Hash]
+            # @!attribute [rw] quota_project
+            #   A separate project against which to charge quota.
+            #   @return [::String]
+            #
+            class Configuration
+              extend ::Gapic::Config
+
+              DEFAULT_ENDPOINT = "cloudprofiler.googleapis.com"
+
+              config_attr :endpoint,      DEFAULT_ENDPOINT, ::String
+              config_attr :credentials,   nil do |value|
+                allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
+                allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
+                allowed.any? { |klass| klass === value }
+              end
+              config_attr :scope,         nil, ::String, ::Array, nil
+              config_attr :lib_name,      nil, ::String, nil
+              config_attr :lib_version,   nil, ::String, nil
+              config_attr(:channel_args,  { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
+              config_attr :interceptors,  nil, ::Array, nil
+              config_attr :timeout,       nil, ::Numeric, nil
+              config_attr :metadata,      nil, ::Hash, nil
+              config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
+              config_attr :quota_project, nil, ::String, nil
+
+              # @private
+              def initialize parent_config = nil
+                @parent_config = parent_config unless parent_config.nil?
+
+                yield self if block_given?
+              end
+
+              ##
+              # Configurations for individual RPCs
+              # @return [Rpcs]
+              #
+              def rpcs
+                @rpcs ||= begin
+                  parent_rpcs = nil
+                  parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
+                  Rpcs.new parent_rpcs
+                end
+              end
+
+              ##
+              # Configuration for the channel pool
+              # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
+              #
+              def channel_pool
+                @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
+              end
+
+              ##
+              # Configuration RPC class for the ExportService API.
+              #
+              # Includes fields providing the configuration for each RPC in this service.
+              # Each configuration object is of type `Gapic::Config::Method` and includes
+              # the following configuration fields:
+              #
+              #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
+              #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
+              #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
+              #     include the following keys:
+              #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
+              #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
+              #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
+              #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
+              #         trigger a retry.
+              #
+              class Rpcs
+                ##
+                # RPC-specific configuration for `list_profiles`
+                # @return [::Gapic::Config::Method]
+                #
+                attr_reader :list_profiles
+
+                # @private
+                def initialize parent_rpcs = nil
+                  list_profiles_config = parent_rpcs.list_profiles if parent_rpcs.respond_to? :list_profiles
+                  @list_profiles = ::Gapic::Config::Method.new list_profiles_config
+
+                  yield self if block_given?
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/google/cloud/profiler/v2/export_service/credentials.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+# Copyright 2023 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+require "googleauth"
+
+module Google
+  module Cloud
+    module Profiler
+      module V2
+        module ExportService
+          # Credentials for the ExportService API.
+          class Credentials < ::Google::Auth::Credentials
+            self.scope = [
+              "https://www.googleapis.com/auth/cloud-platform",
+              "https://www.googleapis.com/auth/monitoring",
+              "https://www.googleapis.com/auth/monitoring.write"
+            ]
+            self.env_vars = [
+              "PROFILER_CREDENTIALS",
+              "PROFILER_KEYFILE",
+              "GOOGLE_CLOUD_CREDENTIALS",
+              "GOOGLE_CLOUD_KEYFILE",
+              "GCLOUD_KEYFILE",
+              "PROFILER_CREDENTIALS_JSON",
+              "PROFILER_KEYFILE_JSON",
+              "GOOGLE_CLOUD_CREDENTIALS_JSON",
+              "GOOGLE_CLOUD_KEYFILE_JSON",
+              "GCLOUD_KEYFILE_JSON"
+            ]
+            self.paths = [
+              "~/.config/google_cloud/application_default_credentials.json"
+            ]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/google/cloud/profiler/v2/export_service/paths.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+# Copyright 2023 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module Profiler
+      module V2
+        module ExportService
+          # Path helper methods for the ExportService API.
+          module Paths
+            ##
+            # Create a fully-qualified Project resource string.
+            #
+            # The resource will be in the following format:
+            #
+            # `projects/{project}`
+            #
+            # @param project [String]
+            #
+            # @return [::String]
+            def project_path project:
+              "projects/#{project}"
+            end
+
+            extend self
+          end
+        end
+      end
+    end
+  end
+end