Module: Google::Cloud::Profiler

Defined in:
lib/google/cloud/profiler.rb,
lib/google/cloud/profiler/version.rb

Constant Summary collapse

VERSION = 
"1.1.0"

Class Method Summary collapse

Class Method Details

.configure {|::Google::Cloud.configure.profiler| ... } ⇒ ::Google::Cloud::Config

Configure the google-cloud-profiler library.

The following configuration parameters are supported:

  • credentials (type: String, Hash, Google::Auth::Credentials) - The path to the keyfile as a String, the contents of the keyfile as a Hash, or a Google::Auth::Credentials object.
  • lib_name (type: String) - The library name as recorded in instrumentation and logging.
  • lib_version (type: String) - The library version as recorded in instrumentation and logging.
  • interceptors (type: Array<GRPC::ClientInterceptor>) - An array of interceptors that are run before calls are executed.
  • timeout (type: Numeric) - Default timeout in seconds.
  • metadata (type: Hash{Symbol=>String}) - Additional gRPC headers to be sent with the call.
  • retry_policy (type: Hash) - 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.

Yields:

Returns:

  • (::Google::Cloud::Config) —

    The default configuration used by this library



110
111
112
113
114
 
# File 'lib/google/cloud/profiler.rb', line 110

def self.configure
  yield ::Google::Cloud.configure.profiler if block_given?

  ::Google::Cloud.configure.profiler
end

.profiler_service(version: :v2, &block) ⇒ ProfilerService::Client

Create a new client object for ProfilerService.

By default, this returns an instance of Google::Cloud::Profiler::V2::ProfilerService::Client for version V2 of the API. However, you can specify specify a different API version by passing it in the version parameter. If the ProfilerService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned.

About ProfilerService

Manage the collection of continuous profiling data provided by profiling agents running in the cloud or by an offline provider of profiling data.

General guidelines:

  • Profiles for a single deployment must be created in ascending time order.
  • Profiles can be created in either online or offline mode, see below.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v2) —

    The API version to connect to. Optional. Defaults to :v2.

Returns:

  • (ProfilerService::Client) —

    A client object for the specified version.



71
72
73
74
75
76
77
78
79
80
 
# File 'lib/google/cloud/profiler.rb', line 71

def self.profiler_service version: :v2, &block
  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
  package_module = Google::Cloud::Profiler.const_get package_name
  package_module.const_get(:ProfilerService).const_get(:Client).new(&block)
end