Class: Google::Cloud::Debugger::V2::Controller::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/debugger/v2/controller/client.rb

Overview

Client for the Controller service.

The Controller service provides the API for orchestrating a collection of debugger agents to perform debugging tasks. These agents are each attached to a process of an application which may include one or more replicas.

The debugger agents register with the Controller to identify the application being debugged, the Debuggee. All agents that register with the same data, represent the same Debuggee, and are assigned the same debuggee_id.

The debugger agents call the Controller to retrieve the list of active Breakpoints. Agents with the same debuggee_id get the same breakpoints list. An agent that can fulfill the breakpoint request updates the Controller with the breakpoint result. The controller selects the first result received and discards the rest of the results. Agents that poll again for active breakpoints will no longer have the completed breakpoint in the list and should remove that breakpoint from their attached process.

The Controller service does not provide a way to retrieve the results of a completed breakpoint. This functionality is available using the Debugger service.

Defined Under Namespace

Classes: Configuration

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize {|config| ... } ⇒ Client

Create a new Controller client object.

Examples:


# Create a client using the default configuration
client = ::Google::Cloud::Debugger::V2::Controller::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::Debugger::V2::Controller::Client.new do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Controller client.

Yield Parameters:



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/google/cloud/debugger/v2/controller/client.rb', line 138

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/clouddebugger/v2/controller_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

  @controller_stub = ::Gapic::ServiceStub.new(
    ::Google::Cloud::Debugger::V2::Controller2::Stub,
    credentials:  credentials,
    endpoint:     @config.endpoint,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors
  )
end

Class Method Details

.configure {|config| ... } ⇒ Client::Configuration

Configure the Controller Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all Controller clients
::Google::Cloud::Debugger::V2::Controller::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/google/cloud/debugger/v2/controller/client.rb', line 73

def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "Debugger", "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.rpcs.register_debuggee.timeout = 600.0

    default_config.rpcs.list_active_breakpoints.timeout = 600.0
    default_config.rpcs.list_active_breakpoints.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
    }

    default_config.rpcs.update_active_breakpoint.timeout = 600.0
    default_config.rpcs.update_active_breakpoint.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
    }

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

#configure {|config| ... } ⇒ Client::Configuration

Configure the Controller 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 configure.

See Configuration for a description of the configuration fields.

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



117
118
119
120
 
# File 'lib/google/cloud/debugger/v2/controller/client.rb', line 117

def configure
  yield @config if block_given?
  @config
end

#list_active_breakpoints(request, options = nil) ⇒ ::Google::Cloud::Debugger::V2::ListActiveBreakpointsResponse #list_active_breakpoints(debuggee_id: nil, wait_token: nil, success_on_timeout: nil) ⇒ ::Google::Cloud::Debugger::V2::ListActiveBreakpointsResponse

Returns the list of all active breakpoints for the debuggee.

The breakpoint specification (location, condition, and expressions fields) is semantically immutable, although the field values may change. For example, an agent may update the location line number to reflect the actual line where the breakpoint was set, but this doesn't change the breakpoint semantics.

This means that an agent does not need to check if a breakpoint has changed when it encounters the same breakpoint on a successive call. Moreover, an agent should remember the breakpoints that are completed until the controller removes them from the active list to avoid setting those breakpoints again.

Examples:

Basic example

require "google/cloud/debugger/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Debugger::V2::Controller::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Debugger::V2::ListActiveBreakpointsRequest.new

# Call the list_active_breakpoints method.
result = client.list_active_breakpoints request

# The returned object is of type Google::Cloud::Debugger::V2::ListActiveBreakpointsResponse.
p result

Overloads:

  • #list_active_breakpoints(request, options = nil) ⇒ ::Google::Cloud::Debugger::V2::ListActiveBreakpointsResponse

    Pass arguments to list_active_breakpoints via a request object, either of type ListActiveBreakpointsRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Debugger::V2::ListActiveBreakpointsRequest, ::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.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #list_active_breakpoints(debuggee_id: nil, wait_token: nil, success_on_timeout: nil) ⇒ ::Google::Cloud::Debugger::V2::ListActiveBreakpointsResponse

    Pass arguments to list_active_breakpoints 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).

    Parameters:

    • debuggee_id (::String) (defaults to: nil) —

      Required. Identifies the debuggee.

    • wait_token (::String) (defaults to: nil) —

      A token that, if specified, blocks the method call until the list of active breakpoints has changed, or a server-selected timeout has expired. The value should be set from the next_wait_token field in the last response. The initial value should be set to "init".

    • success_on_timeout (::Boolean) (defaults to: nil) —

      If set to true (recommended), returns google.rpc.Code.OK status and sets the wait_expired response field to true when the server-selected timeout has expired.

      If set to false (deprecated), returns google.rpc.Code.ABORTED status when the server-selected timeout has expired.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
 
# File 'lib/google/cloud/debugger/v2/controller/client.rb', line 332

def list_active_breakpoints request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Debugger::V2::ListActiveBreakpointsRequest

  # 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_active_breakpoints.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::Debugger::V2::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.debuggee_id
    header_params["debuggee_id"] = request.debuggee_id
  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_active_breakpoints.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_active_breakpoints.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @controller_stub.call_rpc :list_active_breakpoints, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#register_debuggee(request, options = nil) ⇒ ::Google::Cloud::Debugger::V2::RegisterDebuggeeResponse #register_debuggee(debuggee: nil) ⇒ ::Google::Cloud::Debugger::V2::RegisterDebuggeeResponse

Registers the debuggee with the controller service.

All agents attached to the same application must call this method with exactly the same request content to get back the same stable debuggee_id. Agents should call this method again whenever google.rpc.Code.NOT_FOUND is returned from any controller method.

This protocol allows the controller service to disable debuggees, recover from data loss, or change the debuggee_id format. Agents must handle debuggee_id value changing upon re-registration.

Examples:

Basic example

require "google/cloud/debugger/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Debugger::V2::Controller::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Debugger::V2::RegisterDebuggeeRequest.new

# Call the register_debuggee method.
result = client.register_debuggee request

# The returned object is of type Google::Cloud::Debugger::V2::RegisterDebuggeeResponse.
p result

Overloads:

  • #register_debuggee(request, options = nil) ⇒ ::Google::Cloud::Debugger::V2::RegisterDebuggeeResponse

    Pass arguments to register_debuggee via a request object, either of type RegisterDebuggeeRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Debugger::V2::RegisterDebuggeeRequest, ::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.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #register_debuggee(debuggee: nil) ⇒ ::Google::Cloud::Debugger::V2::RegisterDebuggeeResponse

    Pass arguments to register_debuggee 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).

    Parameters:

    • debuggee (::Google::Cloud::Debugger::V2::Debuggee, ::Hash) (defaults to: nil) —

      Required. Debuggee information to register. The fields project, uniquifier, description and agent_version of the debuggee must be set.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/google/cloud/debugger/v2/controller/client.rb', line 231

def register_debuggee request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Debugger::V2::RegisterDebuggeeRequest

  # 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.register_debuggee.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::Debugger::V2::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.register_debuggee.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.register_debuggee.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @controller_stub.call_rpc :register_debuggee, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_active_breakpoint(request, options = nil) ⇒ ::Google::Cloud::Debugger::V2::UpdateActiveBreakpointResponse #update_active_breakpoint(debuggee_id: nil, breakpoint: nil) ⇒ ::Google::Cloud::Debugger::V2::UpdateActiveBreakpointResponse

Updates the breakpoint state or mutable fields. The entire Breakpoint message must be sent back to the controller service.

Updates to active breakpoint fields are only allowed if the new value does not change the breakpoint specification. Updates to the location, condition and expressions fields should not alter the breakpoint semantics. These may only make changes such as canonicalizing a value or snapping the location to the correct line of code.

Examples:

Basic example

require "google/cloud/debugger/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Debugger::V2::Controller::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Debugger::V2::UpdateActiveBreakpointRequest.new

# Call the update_active_breakpoint method.
result = client.update_active_breakpoint request

# The returned object is of type Google::Cloud::Debugger::V2::UpdateActiveBreakpointResponse.
p result

Overloads:

  • #update_active_breakpoint(request, options = nil) ⇒ ::Google::Cloud::Debugger::V2::UpdateActiveBreakpointResponse

    Pass arguments to update_active_breakpoint via a request object, either of type UpdateActiveBreakpointRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Debugger::V2::UpdateActiveBreakpointRequest, ::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.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #update_active_breakpoint(debuggee_id: nil, breakpoint: nil) ⇒ ::Google::Cloud::Debugger::V2::UpdateActiveBreakpointResponse

    Pass arguments to update_active_breakpoint 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).

    Parameters:

    • debuggee_id (::String) (defaults to: nil) —

      Required. Identifies the debuggee being debugged.

    • breakpoint (::Google::Cloud::Debugger::V2::Breakpoint, ::Hash) (defaults to: nil) —

      Required. Updated breakpoint information. The field id must be set. The agent must echo all Breakpoint specification fields in the update.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
 
# File 'lib/google/cloud/debugger/v2/controller/client.rb', line 428

def update_active_breakpoint request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Debugger::V2::UpdateActiveBreakpointRequest

  # 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.update_active_breakpoint.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::Debugger::V2::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.debuggee_id
    header_params["debuggee_id"] = request.debuggee_id
  end
  if request.breakpoint&.id
    header_params["breakpoint.id"] = request.breakpoint.id
  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.update_active_breakpoint.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_active_breakpoint.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @controller_stub.call_rpc :update_active_breakpoint, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end